monitor_v3 / hg-monitor-web · Files

Go to a project

Blame view

online-office/docs/zh/guide/api.md 81.4 KB
Raw Normal View History Permalink
在线文档
c6173706
 
wangtao authored
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 
# API

Luckysheet针对常用的数据操作需求，开放了主要功能的API，开发者可以根据需要进行任意对接开发。

使用注意：
1. script全局引入时，所有API均挂载到window.luckysheet对象下面，可以在浏览器控制台打印看到；npm引入时，API也全部挂载在luckysheet对象下
2. `success`回调函数第一个参数为API方法的返回值
3. 需要新的API请到github [Issues](https://github.com/mengshukeji/Luckysheet/issues/new/choose)中提交，根据点赞数决定是否开放新API
4. API方法中所需的`order`参数为工作表对象中的`order`的值，而不是`index`

## 单元格操作

### getCellValue(row, column [,setting])<div id='getCellValue'></div>
 

- **参数**：

	- {Number} [row]: 单元格所在行数；从0开始的整数，0表示第一行
	- {Number} [column]: 单元格所在列数；从0开始的整数，0表示第一列
	- {PlainObject} [setting]: 可选参数
		+ {String} [type]: 单元格的值类型，可以设置为原始值`v`或者显示值`m`；默认值为`v`,表示获取单元格的实际值
    	+ {Number} [order]: 工作表下标；默认值为当前工作表下标

- **说明**：
	
	获取单元格的值。

	特殊情况，单元格格式为`yyyy-MM-dd`，`type`为`'v'`时会强制取`'m'`显示值

- **示例**:

	- 返回当前工作表第1行第1列单元格的数据的v值
		
		`luckysheet.getCellValue(0, 0)`

	- 返回指定data数据的第2行第2列单元格的显示值。
		
		`luckysheet.getCellValue(1, 1, {type:"m"})`

------------

### setCellValue(row, column, value [,setting])
 

- **参数**：

	- {Number} [row]: 单元格所在行数；从0开始的整数，0表示第一行
	- {Number} [column]: 单元格所在列数；从0开始的整数，0表示第一列
	- {Object | String | Number} [value]: 要设置的值；可以为字符串或数字，或为符合Luckysheet单元格格式的对象，参考 [单元格属性表](/zh/guide/cell.html)
	- {PlainObject} [setting]: 可选参数
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标
		+ {Boolean} [isRefresh]: 是否刷新界面；默认为`true`；用于多个单元格赋值时候控制节流，前面单元格赋值的时候应设置为	`false`，最后一个单元格赋值时设置为`true`。
		+ {Function} [success]: 操作结束的回调函数

- **说明**：

	设置某个单元格的值，也可以设置整个单元格对象，用于同时设置多个单元格属性。
	
	如果需要更新公式，也可以在这里赋值，Luckysheet在内部会主动把这个公式做计算并加入到公式链中，最后重刷界面。

- **示例**:

	- 设置当前工作表"A1"单元格的值为"1"
    	`luckysheet.setCellValue(0, 0, 1);`
	
	- 设置当前工作表"B1"单元格的值为公式"=sum(A1)"
    	`luckysheet.setCellValue(0, 1, "=sum(A1)");`
	
	- 设置当前工作表"C1"单元格的值为公式"=sum(A1:B1"，并带有红色背景，单元格对象可以不带`v`和`m`值，Luckysheet会根据公式信息自动计算结果，如果带了未更新或者是非公式结果的`v`和`m`值，Luckysheet也仍然会根据公式实际关联的数据计算出准备的结果。
    	`luckysheet.setCellValue(0, 2, {f: "=sum(A1:B1)", bg:"#FF0000"})`

		再次设置"C1"单元格新的公式仍然可以生效
		
		`luckysheet.setCellValue(0, 2, {f: "=sum(A1)", bg:"#00FF00"})`

------------

### clearCell(row, column [,setting])
 

- **参数**：

	- {Number} [row]: 单元格所在行数；从0开始的整数，0表示第一行
	- {Number} [column]: 单元格所在列数；从0开始的整数，0表示第一列
	- {PlainObject} [setting]: 可选参数
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标
		+ {Function} [success]: 操作结束的回调函数

- **说明**：
	
	清除指定工作表指定单元格的内容，返回清除掉的数据，不同于删除单元格的功能，不需要设定单元格移动情况

- **示例**:

    - 清空单元格`B2`内容
      `luckysheet.clearCell(1,1)`
    
------------

### deleteCell(move, row, column [,setting])
 

- **参数**：
	- {String} [move]: 删除后，右侧还是下方的单元格移动
	
		`move`可能的值有：
		
		+ `"left"`: 右侧单元格左移
		+ `"up"`: 下方单元格上移
	
	- {Number} [row]: 单元格所在行数；从0开始的整数，0表示第一行
	- {Number} [column]: 单元格所在列数；从0开始的整数，0表示第一列
	- {PlainObject} [setting]: 可选参数
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标
		+ {Function} [success]: 操作结束的回调函数

- **说明**：
	
	删除指定工作表指定单元格，返回删除掉的数据，同时，指定是右侧单元格左移还是下方单元格上移

- **示例**:

    - 删除当前单元格并且在删除后，右侧单元格左移
      `luckysheet.deleteCell('left')`
    
------------

### setCellFormat(row, column, attr, value [,setting])
 

- **参数**：
	
	- {Number} [row]: 单元格所在行数；从0开始的整数，0表示第一行
	- {Number} [column]: 单元格所在列数；从0开始的整数，0表示第一列
    - {String} [attr]: 属性类型，参考 [单元格属性表](/zh/guide/cell.html)的属性值
	- {String | Number | Object} [value]: 具体的设置值，一个属性会对应多个值，参考 [单元格属性表](/zh/guide/cell.html)的值示例，如果属性类型`attr`是单元格格式`ct`，则设置值`value`应提供ct对象，如：`{fa:"General", t:"g"}`，比如设置A1单元格的格式为百分比格式：
	  
  	  `luckysheet.setCellFormat(0, 0, "ct", {fa:"0.00%", t:"n"})`

	- {PlainObject} [setting]: 可选参数
    	+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	设置某个单元格的属性，如果要设置单元格的值或者同时设置多个单元格属性，推荐使用`setCellValue`
	
	特殊的设置
    
  	边框设置时，attr为`"bd"`，value为一个key/value对象，需要同时设置边框类型:`borderType`/边框粗细:`style`/边框颜色:`color`，比如设置A1单元格的边框为所有/红色/细：
	  
	`luckysheet.setCellFormat(0, 0, "bd", {borderType: "border-right",style: "1", color: "#ff0000"})`
	
	完整可选的设置参数如下：

	+ 边框类型 `borderType："border-left" | "border-right" | "border-top" | "border-bottom" | "border-all" | "border-outside" | "border-inside" | "border-horizontal" | "border-vertical" | "border-none"`，
	+ 边框粗细 `style:  1 Thin | 2 Hair | 3 Dotted | 4 Dashed | 5 DashDot | 6 DashDotDot | 7 Double | 8 Medium | 9 MediumDashed | 10 MediumDashDot | 11 MediumDashDotDot | 12 SlantedDashDot | 13 Thick`
	+ 边框颜色 `color: 16进制颜色值`

- **示例**:

   - 设置当前工作表A1单元格文本加粗
   		`luckysheet.setCellFormat(0, 0, "bl", 1)`
   - 设置第二个工作表的B2单元格背景为红色
   		`luckysheet.setCellFormat(1, 1, "bg", "#ff0000", {order:1})`
   - 设置当前工作表"A1"单元格的值为"abc"
   		`luckysheet.setCellFormat(0, 0, 'v', 'abc');`

------------

### find(content [,setting])
 

- **参数**：
	
	- {String} [content]: 要查找的内容
	- {PlainObject} [setting]: 可选参数
		+ {Boolean} [isRegularExpression]: 是否正则表达式匹配；默认为 `false`
		+ {Boolean} [isWholeWord]: 是否整词匹配；默认为 `false`
		+ {Boolean} [isCaseSensitive]: 是否区分大小写匹配；默认为 `false`
    	+ {Number} [order]: 工作表下标；默认值为当前工作表下标
    	+ {String} [type]: 单元格属性；默认值为`"m"`

- **说明**：
	
	查找一个工作表中的指定内容，返回查找到的内容组成的单元格一位数组，数据格式同`celldata`。

- **示例**:

   - 当前工作表查找`"value"`字符串
   		`luckysheet.find("value")`
   - 当前工作表查找公式包含`"SUM"`的单元格
   		`luckysheet.find("SUM",{type:"f"})`

------------

### replace(content, replaceContent [,setting])
 

- **参数**：
	
	- {String} [content]: 要查找的内容
	- {String} [replaceContent]: 要替换的内容
	- {PlainObject} [setting]: 可选参数
		+ {Boolean} [isRegularExpression]: 是否正则表达式匹配；默认为 `false`
		+ {Boolean} [isWholeWord]: 是否整词匹配；默认为 `false`
		+ {Boolean} [isCaseSensitive]: 是否区分大小写匹配；默认为 `false`
    	+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	查找一个工作表中的指定内容并替换成新的内容，返回替换后的内容组成的单元格一位数组，数据格式同`celldata`。

- **示例**:

   - 当前工作表查找`"value"`字符串并替换为`"out"`
   		`luckysheet.replace("value", "out")`

------------

### exitEditMode([,setting])

- **参数**：
	
	- {PlainObject} [setting]: 可选参数
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	退出编辑模式。鼠标双击单元格后，会进入单元格编辑模式，编辑完成后，当鼠标再次点击别的地方输入框失焦的时候，则会退出编辑模式，随即单元格的值会进行保存。此Api就是自动退出编辑模式的操作，主要是为了触发自动保存单元格。

- **示例**:

   - 手动触发退出编辑模式
   		`luckysheet.exitEditMode()`

------------

## 行和列操作

### setHorizontalFrozen(isRange [,setting])
 

- **参数**：
	
	- {Boolean} [isRange]: 是否冻结行到选区
		`isRange`可能的值有：
		
		+ `"false"`: 冻结首行
		+ `"true"`: 冻结行到选区
	- {PlainObject} [setting]: 可选参数
    	+ {Array | Object | String} [range]: `isRange`为`true`的时候设置，开启冻结的单元格位置，格式为`{ row_focus:0, column_focus:0 }`，意为当前激活的单元格的行数和列数；默认从当前选区最后的一个选区中取得
    	+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	冻结行操作

	特别注意，只有在`isRange`设置为`true`的时候，才需要设置`setting`中的`range`，且与一般的range格式不同。

- **示例**:

   - 冻结首行

		`luckysheet.setHorizontalFrozen(false)`

   - 冻结到`B5`选区

		`luckysheet.setHorizontalFrozen(true, { range: 'B5' })`

------------

### setVerticalFrozen(isRange [,setting])
 

- **参数**：
	
	- {Boolean} [isRange]: 是否冻结列到选区
		`isRange`可能的值有：
		
		+ `"false"`: 冻结首列
		+ `"true"`: 冻结列到选区
	- {PlainObject} [setting]: 可选参数
    	+ {Array | Object | String} [range]: `isRange`为`true`的时候设置，开启冻结的单元格位置，格式为`{ row_focus:0, column_focus:0 }`，意为当前激活的单元格的行数和列数；默认从当前选区最后的一个选区中取得
    	+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	冻结列操作

	特别注意，只有在`isRange`设置为`true`的时候，才需要设置`setting`中的`range`，且与一般的range格式不同。

- **示例**:

   - 冻结首列

		`luckysheet.setVerticalFrozen(false)`

------------

### setBothFrozen(isRange [,setting])
 

- **参数**：
	
	- {Boolean} [isRange]: 是否冻结行列到选区
		`isRange`可能的值有：
		
		+ `"false"`: 冻结行列
		+ `"true"`: 冻结行列到选区
	- {PlainObject} [setting]: 可选参数
    	+ {Array | Object | String} [range]: `isRange`为`true`的时候设置，开启冻结的单元格位置，格式为`{ row_focus:0, column_focus:0 }`，意为当前激活的单元格的行数和列数；默认从当前选区最后的一个选区中取得
    	+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	冻结行列操作

	特别注意，只有在`isRange`设置为`true`的时候，才需要设置`setting`中的`range`，且与一般的range格式不同。
	
	如果想在工作簿初始化后使用此API设置冻结，可以在工作簿创建后的钩子函数中执行，比如：
	```js
	luckysheet.create({
    	hook:{
				workbookCreateAfter:function(){
					luckysheet.setBothFrozen(false);
				}
			}
	});

	```

- **示例**:

   - 冻结行列

		`luckysheet.setBothFrozen(false)`

------------

### cancelFrozen([setting])
 

- **参数**：

	- {PlainObject} [setting]: 可选参数
    	+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	取消冻结操作

- **示例**:

   - 取消冻结

		`luckysheet.cancelFrozen()`

------------

### insertRow(row [,setting])
 

- **参数**：

	- {Number} [row]: 在第几行插入空白行，从0开始

	- {PlainObject} [setting]: 可选参数
		+ {Number} [number]: 插入的空白行数；默认为 1
    	+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	在第`row`行的位置，插入`number`行空白行

- **示例**:

   - 在第2行的位置插入1行空白行

		`luckysheet.insertRow(1)`

------------

### insertColumn( column [,setting])
 

- **参数**：

	- {Number} [column]: 在第几列插入空白列

	- {PlainObject} [setting]: 可选参数
		+ {Number} [number]: 插入的空白列数；默认为 1
    	+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	在第`column`列的位置，插入`number`列空白列

- **示例**:

   - 在第1列的位置插入3行空白行

		`luckysheet.insertColumn(0, { number: 3 })`

------------

### deleteRow(rowStart, rowEnd [,setting])
 

- **参数**：
	
	- {Number} [rowStart]: 要删除的起始行
	- {Number} [rowEnd]: 要删除的结束行
	
	- {PlainObject} [setting]: 可选参数
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	删除指定的行

	特别提醒，删除行之后，行的序号并不会变化，下面的行会补充到上面，注意观察数据是否被正确删除即可。

- **示例**:

   - 删除2-4行

		`luckysheet.deleteRow(1, 3)`

------------

### deleteColumn(columnStart, columnEnd [,setting])
 
- **参数**：
	
	- {Number} [columnStart]: 要删除的起始列
	- {Number} [columnEnd]: 要删除的结束列
	
	- {PlainObject} [setting]: 可选参数
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	删除指定的列

	特别提醒，删除列之后，列的序号并不会变化，右边的列会补充到左边，注意观察数据是否被正确删除即可。

- **示例**:

   - 删除2-4列

		`luckysheet.deleteColumn(1, 3)`

------------

### hideRow(rowStart, rowEnd [,setting])
 
- **参数**：
	
	- {Number} [rowStart]: 要隐藏的起始行
	- {Number} [rowEnd]: 要隐藏的结束行
	
	- {PlainObject} [setting]: 可选参数
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	隐藏指定的行

	特别提醒，隐藏行之后，行的序号会变化。

- **示例**:

   - 隐藏2-4行

		`luckysheet.hideRow(1, 3)`

------------

### hideColumn(columnStart, columnEnd [,setting])(TODO)
 
- **参数**：
	
	- {Number} [columnStart]: 要隐藏的起始列
	- {Number} [columnEnd]: 要隐藏的结束列
	
	- {PlainObject} [setting]: 可选参数
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	隐藏指定的列

	特别提醒，隐藏列之后，列的序号会变化。

- **示例**:

   - 隐藏2-4列

		`luckysheet.hideColumn(1, 3)`

------------

### showRow(rowStart, rowEnd [,setting])
 
- **参数**：
	
	- {Number} [rowStart]: 要显示的起始行
	- {Number} [rowEnd]: 要显示的结束行
	
	- {PlainObject} [setting]: 可选参数
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	显示指定的行

- **示例**:

   - 显示2-4行

		`luckysheet.showRow(1, 3)`

------------

### showColumn(columnStart, columnEnd [,setting])(TODO)
 
- **参数**：
	
	- {Number} [columnStart]: 要显示的起始列
	- {Number} [columnEnd]: 要显示的结束列
	
	- {PlainObject} [setting]: 可选参数
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	显示指定的列

- **示例**:

   - 显示2-4列

		`luckysheet.showColumn(1, 3)`

------------

### setRowHeight(rowInfo [,setting])

- **参数**：
	
	- {Object} [rowInfo]: 行数和高度对应关系
	
	- {PlainObject} [setting]: 可选参数
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	设置指定行的高度

- **示例**:

   - 设置第一行高度为50px，第二行高度为60px

		`luckysheet.setRowHeight({0：50，1：60})`

------------

### setColumnWidth(columnInfo [,setting])

- **参数**：
	
	- {Object} [columnInfo]: 列数和宽度对应关系
	
	- {PlainObject} [setting]: 可选参数
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	设置指定列的宽度

- **示例**:

   - 设置第一列宽度为50px，第二列宽度为60px

		`luckysheet.setColumnWidth({0：50，1：60})`

------------

### getRowHeight(rowInfo [,setting])

- **参数**：
	
	- {Array} [rowInfo]: 行号下标组成的数组；行号下标从0开始；
	
	- {PlainObject} [setting]: 可选参数
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	获取指定工作表指定行的高度，得到行号和高度对应关系的对象（第一行行号为0）

- **示例**:

   - 第一行高度为50px，第二行高度为60px，获取这些值

		`luckysheet.getRowHeight([0,1])`
		返回得到
		`{0：50，1：60}`

------------

### getColumnWidth(columnInfo [,setting])

- **参数**：
	
	- {Array} [columnInfo]: 列号下标组成的数组；列号下标从0开始；
	
	- {PlainObject} [setting]: 可选参数
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	获取指定工作表指定列的宽度，得到列号和宽度对应关系的对象（第一列列号为0）

- **示例**:

   - 第一列宽度为50px，第二列宽度为60px，获取这些值

		`luckysheet.getColumnWidth([0,1])`
		返回得到
		`{0：50，1：60}`

------------

### getDefaultRowHeight([,setting])

- **参数**：
	
	- {PlainObject} [setting]: 可选参数
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	获取工作表的默认行高

- **示例**:

   - 返回工作表的默认行高

		`luckysheet.getDefaultRowHeight()`
		返回得到
		`19`

------------

### getDefaultColWidth([,setting])

- **参数**：
		
	- {PlainObject} [setting]: 可选参数
        + {Number} [order]: 工作表下标；默认值为当前工作表下标
		+ {Function} [success]: 操作结束的回调函数

- **说明**：
	
	获取工作表的默认列宽

- **示例**:

   - 返回工作表的默认列宽

		`luckysheet.getDefaultColWidth()`
		返回得到
		`73`

------------

## 选区操作

### getRange()
 
- **说明**：

	返回当前选区对象的数组，可能存在多个选区。每个选区的格式为row/column信息组成的对象`{row:[0,1],column:[0,1]}`

- **示例**:

	- 当前选区为"A1:B2"和"B4:C5"，执行
		
		`luckysheet.getRange()`
		
		则返回结果为：
		```json
		[
			{ "row": [0,1], "column": [0,1] },
			{ "row": [3,4], "column": [1,2] }
		]
		```

------------

### getRangeWithFlatten()
 
- **说明**：

	返回表示指定区域内所有单元格位置的数组，区别getRange方法，该方法以cell单元格(而非某块连续的区域)为单位来组织选区的数据。

- **示例**:

	- 在表格中选择指定的区域，然后执行
		
		`luckysheet.getRange()`
		
		则返回结果为：
		```json
		[
			{"row":[0,0],"column":[0,2]},
			{"row":[1,1],"column":[0,0]},
			{"row":[3,3],"column":[0,0]}
		]
		```
		其中，{"row":[0,0],"column":[0,2]} 表示的是一整块连续的区域。

	- 在表格中选择上面的区域，然后执行
		
		`luckysheet.getRangeWithFlatten()`
		
		则返回结果为：
		```json
		[
			{"r":0,"c":0},
			{"r":0,"c":1},
			{"r":0,"c":2},
			{"r":1,"c":0},
			{"r":3,"c":0}
		]
		```

------------

### getRangeValuesWithFlatte()
 
- **说明**：

	返回表示指定区域内所有单元格内容的对象数组

- **示例**:

	- 在表格中选择指定的区域，然后执行
		
		`luckysheet.getRange()`
		
		则返回结果为：
		```json
		[
			{"row":[0,0],"column":[0,2]},
			{"row":[1,1],"column":[0,0]},
			{"row":[3,3],"column":[0,0]}
		]
		```
		其中，{"row":[0,0],"column":[0,2]} 表示的是一整块连续的区域。

	- 在表格中选择上面的区域，然后执行
		
		`luckysheet.getRangeValuesWithFlatte()`
		
		则返回结果为：
		```json
		[
			{
				"bg": null,
				"bl": 0,
				"it": 0,
				"ff": 0,
				"fs": 11,
				"fc": "rgb(51, 51, 51)",
				"ht": 1,
				"vt": 1,
				"v": 1,
				"ct": {
					"fa": "General",
					"t": "n"
				},
				"m": "1"
			},
			{
				"bg": null,
				"bl": 0,
				"it": 0,
				"ff": 0,
				"fs": 11,
				"fc": "rgb(51, 51, 51)",
				"ht": 1,
				"vt": 1,
				"v": 2,
				"ct": {
					"fa": "General",
					"t": "n"
				},
				"m": "2"
			},
			{
				"bg": null,
				"bl": 0,
				"it": 0,
				"ff": 0,
				"fs": 11,
				"fc": "rgb(51, 51, 51)",
				"ht": 1,
				"vt": 1,
				"v": 3,
				"ct": {
					"fa": "General",
					"t": "n"
				},
				"m": "3"
			},
			{
				"v": "Background",
				"ct": {
					"fa": "General",
					"t": "g"
				},
				"m": "Background",
				"bg": null,
				"bl": 1,
				"it": 0,
				"ff": 0,
				"fs": 11,
				"fc": "rgb(51, 51, 51)",
				"ht": 1,
				"vt": 1
			},
			{
				"v": "Border",
				"ct": {
					"fa": "General",
					"t": "g"
				},
				"m": "Border",
				"bg": null,
				"bl": 1,
				"it": 0,
				"ff": 0,
				"fs": 11,
				"fc": "rgb(51, 51, 51)",
				"ht": 1,
				"vt": 1
			}
		]
		```
------------


### getRangeAxis()
 
- **说明**：

	返回对应当前选区的坐标字符串数组，可能存在多个选区。每个选区可能是单个单元格(如 A1)或多个单元格组成的矩形区域(如 D9:E12)

- **示例**:

	- 当前选区为"E10:E14"、"A7:B13"、"C4"、 "A3"和"C6:D9"，执行
		
		`luckysheet.getRangeAxis()`
		
		则返回结果为：
		```json
		["E10:E14", "A7:B13", "C4", "A3", "C6:D9"]
		```

------------

### getRangeValue([setting])

- **参数**：

	- {PlainObject} [setting]: 可选参数
		+ {Object | String} [range]: 选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`，只能为单个选区；默认为当前选区
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标

- **说明**：
	
	返回指定工作表指定范围的单元格二维数组数据，每个单元格为一个对象。

	[单元格对象格式参考](/zh/guide/cell.html)

- **示例**:

	- 当前选区为"A1:B2"，执行
		
		`luckysheet.getRangeValue()`
		
		则返回结果为：
		```json
		[
			[
				{
					"v": "vaule1",
					"ct": { "fa": "General", "t": "g" },
					"m": "vaule1",
					"bg": "rgba(255,255,255)",
					"bl": 0,
					"it": 0,
					"ff": 1,
					"fs": 11,
					"fc": "rgb(51, 51, 51)",
					"ht": 1,
					"vt": 0
				},
				{
					"v": "value3",
					"ct": { "fa": "General", "t": "g" },
					"m": "value3",
					"bg": "rgba(255,255,255)",
					"bl": 0,
					"it": 0,
					"ff": 1,
					"fs": 11,
					"fc": "rgb(51, 51, 51)",
					"ht": 1,
					"vt": 0
				}
			],
			[
				{
					"v": "vaule2",
					"ct": { "fa": "General", "t": "g" },
					"m": "vaule2",
					"bg": "rgba(255,255,255)",
					"bl": 0,
					"it": 0,
					"ff": 1,
					"fs": 11,
					"fc": "rgb(51, 51, 51)",
					"ht": 1,
					"vt": 0
				},
				{
					"v": "value4",
					"ct": { "fa": "General", "t": "g" },
					"m": "value4",
					"bg": "rgba(255,255,255)",
					"bl": 0,
					"it": 0,
					"ff": 1,
					"fs": 11,
					"fc": "rgb(51, 51, 51)",
					"ht": 1,
					"vt": 0
				}
			]
		]
		```

------------

### getRangeHtml([setting])


- **参数**：

	- {PlainObject} [setting]: 可选参数
    	+ {Array | Object | String} [range]: 选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`，允许多个选区组成的数组；默认为当前选区
    	+ {Number} [order]: 工作表下标；默认值为当前工作表下标

- **说明**：
	
	复制指定工作表指定单元格区域的数据，返回包含`<table>`html格式的数据，可用于粘贴到excel中保持单元格样式。
	
	特别注意，如果复制多个选区，这几个选区必须有相同的行或者相同的列才能复制，复制出的结果也会自动合并成衔接的数组，比如，多选`"C18:C20"` / `"E18:E20"` / `"G18:H20"`是允许的，但是多选`"C18:C20"` / `"E18:E21"`是不允许的

- **示例**:

	- 当前选区为"A1:B2"，执行
		
		`luckysheet.getRangeHtml()`
		
		则返回结果为：
		```html
		<table data-type="luckysheet_copy_action_table">
			<colgroup width="72px">
			</colgroup>
			<colgroup width="72px">
			</colgroup>
			<tr>
				<td style="height:19px;">
					value1
				</td>
				<td style="">
					value3
				</td>
			</tr>
			<tr>
				<td style="height:19px;">
					value2
				</td>
				<td style="">
					value4
				</td>
			</tr>
		</table>
		```

------------

### getRangeJson(title [,setting])
 

- **参数**：

    - {Boolean} [title]: 是否首行为标题

		`title`可能的值有：
		
		+ `"true"`: 首行为标题
		+ `"false"`: 首行不为标题
	- {PlainObject} [setting]: 可选参数
		+ {Array | Object | String} [range]: 选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`，只能为单个选区；默认为当前选区
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标

- **说明**：

	复制指定工作表指定单元格区域的数据，返回`json`格式的数据

- **示例**:

	- 当前选区为"A1:B2"，首行为标题取得json
		
		`luckysheet.getRangeJson(true)`
		
		则返回结果为：
		```json
		[
			{ "value1": "value2", "value3": "value4" }
		]
		```

	- 当前选区为"A1:B2"，首行不为标题取得json
		
		`luckysheet.getRangeJson(false)`
		
		则返回结果为：
		```json
		[
			{ "A": "value1", "B": "value3" },
			{ "A": "value2", "B": "value4" }
		]
		```

------------

### getRangeArray(dimensional [,setting])


- **参数**：

    - {String} [dimensional]: 数组维度
		
		`dimensional`可能的值有：
		
		+ `"oneDimensional"`: 一维数组
		+ `"twoDimensional"`: 二维数组
	- {PlainObject} [setting]: 可选参数
		+ {Object | String} [range]: 选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`，只能为单个选区；默认为当前选区
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标

- **说明**：
	
	复制指定工作表指定单元格区域的数据，返回一维、二维或者自定义行列数的二维数组的数据。

	特别注意，只有在`dimensional`设置为`custom`的时候，才需要设置`setting`中的`row`和`column`

- **示例**:

	- 当前选区为"A1:B2"，一维数组
		
		`luckysheet.getRangeArray('oneDimensional')`
		
		则返回结果为：
		```json
		["value1","value3","value2","value4"]
		```

	- 当前选区为"A1:B2"，二维数组
		
		`luckysheet.getRangeArray('twoDimensional')`
		
		则返回结果为：
		```json
		[
			[ "value1", "value3" ],
			[ "value2", "value4" ]
		]
		```

	- 当前选区为"A1:C5"，由 'value1'到'value15'的值组成，得到3	行2列的二维数组数据
		
		`luckysheet.getRangeArray('custom', { row: 3, column: 2 })`
		
		则返回结果为：
		```json
		[
			[
				{
					"m": "value1",
					"ct": { "fa": "General", "t": "g" },
					"v": "value1"
				},
				{
					"ct": { "fa": "General", "t": "g" },
					"v": "value6",
					"m": "value6"
				}
			],
			[
				{
					"ct": { "fa": "General", "t": "g" },
					"v": "value11",
					"m": "value11"
				},
				{
					"m": "value2",
					"ct": { "fa": "General", "t": "g" },
					"v": "value2"
				}
			],
			[
				{
					"ct": { "fa": "General", "t": "g" },
					"v": "value7",
					"m": "value7"
				},
				{
					"ct": { "fa": "General", "t": "g" },
					"v": "value12",
					"m": "value12"
				}
			]
		]
		```

------------

### getRangeDiagonal(type [,setting])
 

- **参数**：

	- {String} [type]: 对角线还是对角线偏移
	
		`type`可能的值有：
		
		+ `"normal"`: 对角线
		+ `"anti"`: 反对角线
		+ `"offset"`: 对角线偏移
	- {PlainObject} [setting]: 可选参数
		- {Number} [column]: `type`为`offset`的时候设置，对角偏移的列数
		+ {Array | Object | String} [range]: 选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`，只能为单个选区；默认为当前选区
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标

- **说明**：
	
	复制指定工作表指定单元格区域的数据，返回对角线或者对角线偏移`column`列后的数据。

	特别注意，只有在`type`设置为`offset`的时候，才需要设置`setting`中的`column`。

- **示例**:

	- 当前选区为"A1:B2"，对角线
		
		`luckysheet.getRangeDiagonal('normal')`
		
		则返回结果为：
		```json
		[
			{
				"m": "value1",
				"ct": { "fa": "General", "t": "g" },
				"v": "value1"
			},
			{
				"m": "value4",
				"ct": { "fa": "General", "t": "g" },
				"v": "value4"
			}
		]
		```

	- 当前选区为"A1:B2"，反对角线
		
		`luckysheet.getRangeDiagonal('anti')`
		
		则返回结果为：
		```json
		[
			{
				"m": "value3",
				"ct": { "fa": "General", "t": "g" },
				"v": "value3"
			},
			{
				"m": "value2",
				"ct": { "fa": "General", "t": "g" },
				"v": "value2"
			}
		]
		```
	- 当前选区为"A1:B2"，对角线偏移1列
		
		`luckysheet.getRangeDiagonal('offset', { column: 1 })`
		
		则返回结果为：
		```json
		[
			{
				"m": "value3",
				"ct": { "fa": "General", "t": "g" },
				"v": "value3"
			}
		]
		```
------------

### getRangeBoolean([setting])
 

- **参数**：

	- {PlainObject} [setting]: 可选参数
		+ {Array | Object | String} [range]: 选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`，只能为单个选区；默认为当前选区
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标

- **说明**：
	
	复制指定工作表指定单元格区域的数据，返回布尔值的数据

- **示例**:

	- 当前选区为"A1:B2"
		
		`luckysheet.getRangeBoolean()`
		
		则返回结果为：
		```json
		[
			[ false, false ],
			[ false, false ]
		]
		```

------------

### setRangeShow(range [,setting])<div id='setRangeShow'></div>


- **参数**：

	- {Array | Object | String} [range]: 选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`，允许多个选区组成的数组；默认为当前选区
	- {PlainObject} [setting]: 可选参数
    	+ {Boolean} [show]: 是否显示高亮选中效果；默认值为 `true`
    	+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	指定工作表选中一个或多个选区为选中状态并选择是否高亮，支持多种格式设置。

	特别提醒，Luckysheet中涉及到的选区范围设置都可以参考这个设置

- **示例**:

     + 设定当前工作表选区范围`A1:B2`: 
      
		`luckysheet.setRangeShow("A1:B2")`
     + 设定选区范围`A1:B2`: 
  		
		`luckysheet.setRangeShow(["A1:B2"])`
     + 设定选区范围`A1:B2`: 
  
  		`luckysheet.setRangeShow({row:[0,1],column:[0,1]})`
     + 设定选区范围`A1:B2`: 
  
  		`luckysheet.setRangeShow([{row:[0,1],column:[0,1]}])`
     + 设定选区范围`A1:B2`和`C3:D4`:  
  
		`luckysheet.setRangeShow(["A1:B2","C3:D4"])`
     + 设定选区范围`A1:B2`和`D3`: 
  
  		`luckysheet.setRangeShow([{row:[0,1],column:[0,1]},{row:[2,2],column:[3,3]}])`

------------

### setRangeValue(data [,setting])
 
- **参数**：

	- {Array} [data]: 要赋值的单元格二维数组数据，每个单元格的值，可以为字符串或数字，或为符合Luckysheet格式的对象，参考 [单元格属性表](/zh/guide/cell.html)
	- {PlainObject} [setting]: 可选参数
		+ {Array | Object | String} [range]: 选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`，只能为单个选区；默认为当前选区
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标
		+ {Boolean} [isRefresh]: 是否刷新界面；默认为`true`；用于多个单元格赋值时候控制节流，前面单元格赋值的时候应设置为	`false`，最后一个单元格赋值时设置为`true`。
		+ {Function} [success]: 操作结束的回调函数

- **说明**：
	
	将一个单元格数组数据赋值到指定的区域，数据格式同`getRangeValue`方法取到的数据。

	注意一点，通常`getRangeValue`方法只是取得选区数据，但是不包含边框和合并单元格信息，当执行`setRangeValue`的时候，会动态判断上一步是否执行过`getRangeValue`，如果执行过，会将边框和合并单元格信息一并从Luckysheet配置中取得。

- **示例**:

     + 赋值到当前选区
      
		```js
		const data = [
				[
					{
						"m": "value1",
						"ct": {
							"fa": "General",
							"t": "g"
						},
						"v": "value1"
					},
					{
						"m": "value3",
						"ct": {
							"fa": "General",
							"t": "g"
						},
						"v": "value3"
					}
				],
				[
					{
						"m": "value2",
						"ct": {
							"fa": "General",
							"t": "g"
						},
						"v": "value2"
					},
					{
						"m": "value4",
						"ct": {
							"fa": "General",
							"t": "g"
						},
						"v": "value4"
					}
				]
			]
		luckysheet.setRangeValue(data,{range:"A1:B2"})
		```

------------

### setRangeFormat(attr, value [,setting])
 

- **参数**：

    - {String} [attr]: 属性类型，
  	参考 [单元格属性表](/zh/guide/cell.html)的属性值
	- {String | Number | Object} [value]: 具体的设置值，一个属性会对应多个值，参考 [单元格属性表](/zh/guide/cell.html)的值示例，特殊情况：如果属性类型`attr`是单元格格式`ct`，则设置值`value`应提供`ct.fa`，比如设置`"A1:B2"`单元格的格式为百分比格式：
	  
  	  `luckysheet.setRangeFormat("ct", "0.00%", {range:"A1:B2"})`

    - {PlainObject} [setting]: 可选参数
    	+ {Object | String} [range]: 设置参数的目标选区范围，支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`，允许多个选区组成的数组；默认为当前选区
    	+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	  
	设置指定范围的单元格格式，一般用作处理格式，赋值操作推荐使用`setRangeValue`方法
    
  	边框设置时，attr为`"bd"`，value为一个key/value对象，需要同时设置边框类型:`borderType`/边框粗细:`style`/边框颜色:`color`/，比如设置`"A1:B2"`单元格的边框为所有/红色/细：
	  
	`luckysheet.setRangeFormat("bd", {borderType: "border-right",style: "1", color: "#ff0000"}, {range:["A1:B2"]})`
	
	完整可选的设置参数如下：

	+ 边框类型 `borderType："border-left" | "border-right" | "border-top" | "border-bottom" | "border-all" | "border-outside" | "border-inside" | "border-horizontal" | "border-vertical" | "border-none"`，
	+ 边框粗细 `style:  1 Thin | 2 Hair | 3 Dotted | 4 Dashed | 5 DashDot | 6 DashDotDot | 7 Double | 8 Medium | 9 MediumDashed | 10 MediumDashDot | 11 MediumDashDotDot | 12 SlantedDashDot | 13 Thick`
	+ 边框颜色 `color: 16进制颜色值`

- **示例**:

   - 设置当前工作表`"A1:B2"`范围的单元格文本加粗
		
		`luckysheet.setRangeFormat("bl", 1, {range:"A1:B2"})`
   - 设置第二个工作表的`"B2"`和`"C4:D5"`范围的单元格背景为红色
		
		`luckysheet.setRangeFormat("bg", "#ff0000", {range:["B2","C4:D5"], order:1})`

------------

### setRangeFilter(type [,setting])


- **参数**：
	
	- {String} [type]: 打开还是关闭筛选功能
	
		`type`可能的值有：
		
		+ `"open"`: 打开筛选功能，返回当前筛选的范围对象
		+ `"close"`: 关闭筛选功能，返回关闭前筛选的范围对象
	- {PlainObject} [setting]: 可选参数
    	+ {Object | String} [range]: 选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`，只能为单个选区；默认为当前选区
    	+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	为指定下标的工作表，选定的范围开启或关闭筛选功能

- **示例**:

	- 打开第二个工作表"A1:B2"范围的筛选功能
	`luckysheet.setRangeFilter("open",{range:"A1:B2",order:1})`

------------

### setRangeMerge(type [,setting])
 

- **参数**：
	
	- {String} [type]: 合并单元格类型
	
		`type`可能的值有：
		
		+ `"all"`: 全部合并，区域内所有单元格合并成一个大的单元格
		+ `"horizontal"`: 水平合并，区域内在同一行的单元格合并成一个单元格
		+ `"vertical"`: 垂直合并，区域内在同一列的单元格合并成一个单元格
	
	- {PlainObject} [setting]: 可选参数
    	+ {Array | Object | String} [range]: 选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`，允许多个选区组成的数组；默认为当前选区
    	+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	为指定下标的工作表，选定的范围设定合并单元格

- **示例**:

	- 当前选区 'A1:B2' 设置为合并单元格，类型为全部合并
		
		`luckysheet.setRangeMerge("all")`
		得到 'A1:B1' 的数据为：
		```json
		[
			[
				{
					"m": "value1",
					"ct": { "fa": "General", "t": "g" },
					"v": "value1",
					"mc": { "r": 0, "c": 0, "rs": 2, "cs": 2 }
				},
				{
					"mc": { "r": 0, "c": 0 }
				}
			],
			[
				{
					"mc": { "r": 0, "c": 0 }
				},
				{
					"mc": { "r": 0, "c": 0 }
				}
			]
		]
		```

------------

### cancelRangeMerge( [setting])
 

- **参数**：
	
	- {PlainObject} [setting]: 可选参数
    	+ {Array | Object | String} [range]: 选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`，允许多个选区组成的数组；默认为当前选区
    	+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	为指定下标的工作表，选定的范围取消合并单元格

- **示例**:

	- 当前选区 'A1:B2' 已为合并单元格，现在要取消合并
		
		`luckysheet.cancelRangeMerge()`
		
------------

### setRangeSort(type [,setting])
 

- **参数**：

	- {String} [type]: 排序类型
	
		`type`可能的值有：
		
		+ `"asc"`: 升序
		+ `"des"`: 降序
		
	- {PlainObject} [setting]: 可选参数
		
    	+ {Array | Object | String} [range]: 选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`，只能为单个选区；默认为当前选区
    	+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	为指定下标的工作表，选定的范围开启排序功能，返回选定范围排序后的数据。

- **示例**:

   - 设置当前工作表当前选区为升序
   `luckysheet.setRangeSort("asc")`

------------

### setRangeSortMulti(title, sort [,setting])
 

- **参数**：

	- {Boolean} [title]: 数据是否具有标题行
	- {Array} [sort]: 列设置，设置需要排序的列索引和排序方式，格式如：`[{ i:0,sort:'asc' },{ i:1,sort:'des' }]`
	- {PlainObject} [setting]: 可选参数
		
    	+ {Array | Object | String} [range]: 选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`，只能为单个选区；默认为当前选区
    	+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	为指定下标的工作表，选定的范围开启多列自定义排序功能，返回选定范围排序后的数据。

- **示例**:

   - 设置当前工作表当前选区为自定义排序，数据具有标题行，且按第一列升序第二列降序的规则进行排序
   `luckysheet.setRangeSortMulti(true,[{ i:0,sort:'asc' },{ i:1,sort:'des' }])`

------------

### setRangeConditionalFormatDefault(conditionName, conditionValue [,setting])

- **参数**：

	- {String} [conditionName]: 条件格式规则类型
	
		`conditionName`可能的值有：
		
		+ `"greaterThan"`: 大于（conditionValue值为 数值或单元格范围）
		+ `"lessThan"`: 小于（conditionValue值为 数值或单元格范围）
		+ `"betweenness"`: 介于（conditionValue值为 数值或单元格范围）
		+ `"equal"`: 等于（conditionValue值为 数值或单元格范围）
		+ `"textContains"`: 文本包含（conditionValue值为 文本或单元格范围）
		+ `"occurrenceDate"`: 发生日期（conditionValue值为 日期）
		+ `"duplicateValue"`: 重复值(conditionValue值为 '0':重复值, '1':唯一值)
		+ `"top10"`: 前 N 项（conditionValue值为 1~1000）
		+ `"top10%"`: 前 N%（conditionValue值为 1~1000）
		+ `"last10"`: 后 N 项（conditionValue值为 1~1000）
		+ `"last10%"`: 后 N%（conditionValue值为 1~1000）
		+ `"AboveAverage"`: 高于平均值（conditionValue可为空数组）
		+ `"SubAverage"`: 低于平均值（conditionValue可为空数组）
		 
	- {Array} [conditionValue]: 可以设置条件单元格或者条件值
		取值规则 （条件值数组最少一个值，最多两个值）
		```js
		[2]
		```
		或者 （若值为单元格范围，则取左上角单元格值）
		```js
		['A1']
		```
	
	- {PlainObject} [setting]: 可选参数
		
      	+ {Object} [format]: 颜色设置
      	  
    		* 设置文本颜色和单元格颜色；默认值为` {
				"textColor": "#000000",
				"cellColor": "#ff0000"
			}`
    	+ {Array | Object | String} [cellrange]: 选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`，允许多个选区组成的数组；默认为当前选区
    	
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	为指定下标的工作表，选定的范围开启条件格式，根据设置的条件格式规则突出显示部分单元格，返回开启条件格式后的数据。

- **示例**:

    - 突出显示内容大于数字2的单元格
      `luckysheet.setRangeConditionalFormatDefault("greaterThan",{ type: 'value', content: [2] })`
    
	- 突出显示内容小于单元格A1内容的单元格
	  `luckysheet.setRangeConditionalFormatDefault("lessThan",{ type: 'range', content: ['A1'] })`

	- 突出显示内容介于2和10之间的单元格
	  `luckysheet.setRangeConditionalFormatDefault("betweenness",{ type: 'value', content: [2,10] })`
	
	- 突出显示内容等于单元格A1内容的单元格
	  `luckysheet.setRangeConditionalFormatDefault("equal",{ type: 'range', content: ['A1'] })`
	
	- 突出显示内容包含单元格A1内容的单元格
	  `luckysheet.setRangeConditionalFormatDefault("textContains",{ type: 'range', content: ['A1'] })`
	
	- 突出显示日期在 `2020/09/24 - 2020/10/15` 之间的单元格
      `luckysheet.setRangeConditionalFormatDefault("occurrenceDate",{ type: 'value', content: ['2020/09/24 - 2020/10/15'] })`

	- 突出显示重复值的单元格，content为0
      `luckysheet.setRangeConditionalFormatDefault("duplicateValue",{ type: 'value', content: [0] })`

	- 突出显示唯一值的单元格，content为1
      `luckysheet.setRangeConditionalFormatDefault("duplicateValue",{ type: 'value', content: [1] })`
	
	- 突出显示排名前20名的单元格
      `luckysheet.setRangeConditionalFormatDefault("top",{ type: 'value', content: [20] })`
	
	- 突出显示排名前30%的单元格
      `luckysheet.setRangeConditionalFormatDefault("topPercent",{ type: 'value', content: [30] })`
	
	- 突出显示排名后15名的单元格
      `luckysheet.setRangeConditionalFormatDefault("last",{ type: 'value', content: [15] })`
	
	- 突出显示排名后15%的单元格
      `luckysheet.setRangeConditionalFormatDefault("lastPercent",{ type: 'value', content: [15] })`
	
	- 突出显示高于平均值的单元格
      `luckysheet.setRangeConditionalFormatDefault("AboveAverage",{ type: 'value', content: ['AboveAverage'] })`
	
	- 突出显示低于平均值的单元格
	  `luckysheet.setRangeConditionalFormatDefault("SubAverage",{ type: 'value', content: ['SubAverage'] })`

------------

### setRangeConditionalFormat(type [,setting])

- **参数**：

	- {String} [type]: 条件格式规则类型
	
		`type`可能的值有：
		
		+ `"dataBar"`: 数据条
		+ `"icons"`: 图标集
		+ `"colorGradation"`: 色阶
		 
	- {PlainObject} [setting]: 可选参数
		
      	+ {Array | String} [format]: 颜色设置
    	 
		 	* `type`为`dataBar`时，应设置渐变色；默认值为蓝-白渐变` ["#638ec6", "#ffffff"]`

				推荐的快捷取值：
				```js
				["#638ec6", "#ffffff"],  //蓝-白渐变 数据条
				["#63c384", "#ffffff"],  //绿-白渐变 数据条
				["#ff555a", "#ffffff"],  //红-白渐变 数据条
				["#ffb628", "#ffffff"],  //橙-白渐变 数据条
				["#008aef", "#ffffff"],  //浅蓝-白渐变 数据条
				["#d6007b", "#ffffff"],  //紫-白渐变 数据条
				["#638ec6"],  //蓝色 数据条
				["#63c384"],  //绿色 数据条
				["#ff555a"],  //红色 数据条
				["#ffb628"],  //橙色 数据条
				["#008aef"],  //浅蓝色 数据条
				["#d6007b"]   //紫色 数据条
				```
			
			* `type`为`icons`时，应设置图标类型；默认值为"threeWayArrowMultiColor"：三向箭头彩色，

				可取值为：
				
				`threeWayArrowMultiColor`：三向箭头（彩色），
				
				`threeTriangles`：3个三角形，

				`fourWayArrowMultiColor`：四向箭头（彩色），

				`fiveWayArrowMultiColor`：五向箭头（彩色），

				`threeWayArrowGrayColor`：三向箭头（灰色），

				`fourWayArrowGrayColor`：四向箭头（灰色），

				`fiveWayArrowGrayColor`：五向箭头（灰色），

				`threeColorTrafficLightRimless`：三色交通灯（无边框），

				`threeSigns`：三标志，

				`greenRedBlackGradient`：绿-红-黑渐变，

				`threeColorTrafficLightBordered`：三色交通灯（有边框），

				`fourColorTrafficLight`：四色交通灯，

				`threeSymbolsCircled`：三个符号（有圆圈），

				`tricolorFlag`：三色旗，

				`threeSymbolsnoCircle`：三个符号（无圆圈），

				`threeStars`：3个星形，

				`fiveQuadrantDiagram`：五象限图，

				`fiveBoxes`：5个框，

				`grade4`：四等级，

				`grade5`：五等级，

			* `type`为`colorGradation`时，应设置色阶颜色值；默认值为绿-黄-红色阶` ["rgb(99, 190, 123)", "rgb(255, 235, 132)", "rgb(248, 105, 107)"]`

				推荐的快捷取值：
				```js
				["rgb(99, 190, 123)", "rgb(255, 235, 132)", "rgb(248, 105, 107)"],  //绿-黄-红色阶
				["rgb(248, 105, 107)", "rgb(255, 235, 132)", "rgb(99, 190, 123)"],  //红-黄-绿色阶

				["rgb(99, 190, 123)", "rgb(252, 252, 255)", "rgb(248, 105, 107)"],  //绿-白-红色阶
				["rgb(248, 105, 107)", "rgb(252, 252, 255)", "rgb(99, 190, 123)"],  //红-白-绿色阶
				
				["rgb(90, 138, 198)", "rgb(252, 252, 255)", "rgb(248, 105, 107)"],  //蓝-白-红色阶
				["rgb(248, 105, 107)", "rgb(252, 252, 255)", "rgb(90, 138, 198)"],  //红-白-蓝色阶
				
				["rgb(252, 252, 255)", "rgb(248, 105, 107)"],  //白-红色阶
				["rgb(248, 105, 107)", "rgb(252, 252, 255)"],  //红-白色阶

				["rgb(99, 190, 123)", "rgb(252, 252, 255)"],  //绿-白色阶
				["rgb(252, 252, 255)", "rgb(99, 190, 123)"],  //白-绿色阶

				["rgb(99, 190, 123)", "rgb(255, 235, 132)"],  //绿-黄色阶
				["rgb(255, 235, 132)", "rgb(99, 190, 123)"]   //黄-绿色阶
				```
			
		+ {Array | Object | String} [cellrange]: 选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`，允许多个选区组成的数组；默认为当前选区
    	
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	为指定下标的工作表，选定的范围开启条件格式，返回开启条件格式后的数据。

- **示例**:

    - 当前选区范围开启条件格式，显示渐变色
      `luckysheet.setRangeConditionalFormat("dataBar", { format: ["#63c384", "#ffffff"] })`

------------

### deleteRangeConditionalFormat(itemIndex [,setting])

- **参数**：

	- {Number} [itemIndex]: 条件格式规则索引
		 
	- {PlainObject} [setting]: 可选参数
		  	
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	为指定下标的工作表，删除条件格式规则，返回被删除的条件格式规则。

- **示例**:

    - 删除第三个条件格式规则
      `luckysheet.deleteRangeConditionalFormat(2)`
    
------------

### clearRange([setting])

- **参数**：

	- {PlainObject} [setting]: 可选参数
		+ {Array | Object | String} [range]: 要清除的选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`，允许多个选区组成的数组；默认为当前选区
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标
		+ {Function} [success]: 操作结束的回调函数

- **说明**：
	
	清除指定工作表指定单元格区域的内容，不同于删除选区的功能，不需要设定单元格移动情况

- **示例**:

    - 清空当前选区内容
      `luckysheet.clearRange()`
    
------------

### deleteRange(move [,setting])

- **参数**：
	
	- {String} [move]: 删除后，右侧还是下方的单元格移动
	
		`move`可能的值有：
		
		+ `"left"`: 右侧单元格左移
		+ `"up"`: 下方单元格上移
		
	- {PlainObject} [setting]: 可选参数
		+ {Object | String} [range]: 要删除的选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`；默认为当前选区
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标
		+ {Function} [success]: 操作结束的回调函数

- **说明**：
	
	删除指定工作表指定单元格区域，同时，指定是右侧单元格左移还是下方单元格上移

- **示例**:

    - 删除当前选区并且在删除后，右侧单元格左移
      `luckysheet.deleteRange('left')`
    
------------

### insertRange(move [,setting])

[todo]


- **参数**：
	
	- {String} [move]: 活动单元格右移或者下移
	
		`move`可能的值有：
		
		+ `"right"`: 活动单元格右移
		+ `"bottom"`: 活动单元格下移
		
	- {PlainObject} [setting]: 可选参数
		+ {Array} [data]: 赋值到range区域的单元格二维数组数据，[单元格对象格式参考](/zh/guide/cell.html)；默认值为空数组，即插入空白的区域
		+ {Array | Object | String} [range]: 要插入的位置，选区范围，支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`，默认为当前选区
    	
			当未设置data数据时，允许多个选区组成的数组，插入的空白区域即为这些选区的区域，
			
			当设置了data数据，只能为单个选区，并且会把data数据插入到当前选区的第一个单元格位置
			
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标
		+ {Function} [success]: 操作结束的回调函数

- **说明**：
	
	在指定工作表指定单元格区域，赋值单元格数据，或者新建一块空白区域，返回data数据，同时，指定活动单元格右移或者下移

- **示例**:

    - 当前选区位置插入空白单元格，并且插入后当前选区单元格右移
      `luckysheet.insertRange('right')`
    
------------

### matrixOperation(type [,setting])

- **参数**：
	
	- {String} [type]: 矩阵操作的类型
	
		`type`可能的值有：
		
		+ `"flipUpDown"`: 上下翻转
		+ `"flipLeftRight"`: 左右翻转
		+ `"flipClockwise"`: 顺时针旋转
		+ `"flipCounterClockwise"`: 逆时针旋转api
		+ `"transpose"`: 转置
		+ `"deleteZeroByRow"`: 按行删除两端0值
		+ `"deleteZeroByColumn"`: 按列删除两端0值
		+ `"removeDuplicateByRow"`: 按行删除重复值
		+ `"removeDuplicateByColumn"`: 按列删除重复值
		+ `"newMatrix"`: 生产新矩阵
	- {PlainObject} [setting]: 可选参数
    	+ {Array | Object | String} [range]: 选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`，只能为单个选区；默认为当前选区
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	指定工作表指定单元格区域的数据进行矩阵操作，返回操作成功后的结果数据

- **示例**:

    - 当前选区上下翻转
    		
		`luckysheet.matrixOperation('flipUpDown')`

		原来的选区复制为二维数组：
		
		`[["value1","value3"],["value2","value4"]]`
		
		上下翻转后选区复制为二维数组：
		
		`[["value2","value4"],["value1","value3"]]`
    
------------

### matrixCalculation(type, number [,setting])

- **参数**：
	- {String} [type]: 计算方式
	
		`type`可能的值有：
		
		+ `"plus"`: 加
		+ `"minus"`: 减
		+ `"multiply"`: 乘
		+ `"divided"`: 除
		+ `"power"`: 次方
		+ `"root"`: 次方根
		+ `"log"`: log
	- {Number} [number]: 计算数值，如: 2
	- {PlainObject} [setting]: 可选参数
    	+ {Array | Object | String} [range]: 选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`，只能为单个选区；默认为当前选区
    	+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	指定工作表指定单元格区域的数据进行矩阵计算，返回计算成功后的结果数据

- **示例**:

    - 当前选区所有单元格值加2
    		
		`luckysheet.matrixCalculation('plus', 2)`

		原来的选区复制为二维数组：
		
		`[[1,2],[3,4]]`
		
		加2后选区复制为二维数组：
		
		`[[3,4],[5,6]]`
    
------------

## 工作表操作

### getAllSheets()

- **说明**：

	返回所有工作表配置，格式同工作表配置，得到的结果可用于表格初始化时作为options.data使用。

	所以此API适用于，手动操作配置完一个表格后，将所有工作表信息取出来自行保存，再用于其他地方的表格创建。如果想得到包括工作簿配置在内的所有工作簿数据，推荐使用 [toJson](#toJson())，并且可以直接用于初始化Luckysheet。

- **示例**:

	- 取得第一个工作表的所有基本信息
	`luckysheet.getAllSheets()[0]`
	
------------

### getLuckysheetfile()

- **说明**：

	返回所有表格数据结构的一维数组`luckysheetfile`，不同于`getAllSheets`方法，此方法得到的工作表参数会包含很多内部使用变量，最明显的区别是表格数据操作会维护`luckysheetfile[i].data`，而初始化数据采用的是`options.data[i].celldata`，所以`luckysheetfile`可用于调试使用，但是不适用初始化表格。

	除此之外，加载过的工作表参数中会增加一个`load = 1`，这个参数在初始化数据的时候需要置为0才行。所以，将`getLuckysheetfile()`得到的数据拿来初始化工作簿，需要做两个工作：
	
	- celldata转为data，参考:[transToData](/zh/guide/api.html#transtodata-celldata-setting)
	- load重置为0或者删除此字段

	现在已有`getAllSheets`来完成这个工作，无需再手动转化数据。

- **示例**:

	- 取得第一个工作表的所有调试信息
	`luckysheet.getLuckysheetfile()[0]`
	
------------

### getSheet([setting])

- **参数**：

    - {PlainObject} [setting]: 可选参数
    	+ {Number} [index]: 工作表索引；默认值为当前工作表索引
    	+ {Number} [order]: 工作表下标；默认值为当前工作表下标
    	+ {Number} [name]: 工作表名称；默认值为当前工作表名称

- **说明**：

	根据index/order/name，快捷返回指定工作表的配置，同 `luckysheetfile[i]`。如果设置多个参数，优先级为：index > order > name。
	
------------

### getSheetData([setting])

- **参数**：

    - {PlainObject} [setting]: 可选参数
    	+ {Number} [order]: 工作表下标；默认值为当前工作表下标

- **说明**：

	快捷返回指定工作表的数据，同 `luckysheetfile[i].data`
	
------------

### getConfig([setting])

- **参数**：

    - {PlainObject} [setting]: 可选参数
    	+ {Number} [order]: 工作表下标；默认值为当前工作表下标

- **说明**：

	快捷返回指定工作表的config配置，同 `luckysheetfile[i].config`

------------

### setConfig(cfg, [setting])

- **参数**：
	- {Object} [cfg]: config配置
    - {PlainObject} [setting]: 可选参数
    	+ {Number} [order]: 工作表下标；默认值为当前工作表下标
    	+ {Function} [success]: 操作结束的回调函数
	
- **说明**：

	快捷设置指定工作表config配置

------------
### updataSheet([setting])

- **参数**：

    - {PlainObject} [setting]: 可选参数
    	+ {Array} [data]: 需要更新的工作表配置，参考create这个API的option.data
    	+ {Function} [success]: 操作结束的回调函数
	
- **说明**：

	根据所传的工作表配置，更新相应的工作表

	
------------
### setSheetAdd([setting])

- **参数**：

    - {PlainObject} [setting]: 可选参数
    	+ {Object} [sheetObject]: 新增的工作表的数据；默认值为空对象，工作表数据格式参考[options.data](/zh/guide/sheet.html#初始化配置)
    	+ {Number} [order]: 新增的工作表下标；默认值为最后一个下标位置
    	+ {Function} [success]: 操作结束的回调函数
	
- **说明**：

	新增一个sheet，返回新增的工作表对象，`setting`中可选设置数据为 `sheetObject`，不传`sheetObject`则会新增一个空白的工作表。

- **示例**:

	- 在最后一个工作表下标位置新增一个空白的工作表
	`luckysheet.setSheetAdd()`
	
------------

### setSheetDelete([setting])

- **参数**：

    - {PlainObject} [setting]: 可选参数
    	+ {Number} [order]: 工作表下标；默认值为当前工作表下标
    	+ {Function} [success]: 操作结束的回调函数
	
- **说明**：

	删除指定下标的工作表，返回已删除的工作表对象

- **示例**:

	- 删除当前工作表
	`luckysheet.setSheetDelete()`
			
------------

### setSheetCopy([setting])

- **参数**：

    - {PlainObject} [setting]: 可选参数
		+ {Number} [targetOrder]: 新复制的工作表目标下标位置；默认值为当前工作表下标的下一个下标位置（递增）
    	+ {Number} [order]: 被复制的工作表下标；默认值为当前工作表下标
    	+ {Function} [success]: 操作结束的回调函数
	
- **说明**：

	复制指定下标的工作表到指定下标位置，在`setting`中可选设置指定下标位置`targetOrder`，返回新复制的工作表对象

- **示例**:

	- 复制当前工作表到下一个下标位置
	`luckysheet.setSheetCopy()`

------------

### setSheetHide([setting])

- **参数**：

    - {PlainObject} [setting]: 可选参数
    	+ {Number} [order]: 被隐藏的工作表下标；默认值为当前工作表下标
    	+ {Function} [success]: 操作结束的回调函数

- **说明**：
	
	隐藏指定下标的工作表，返回被隐藏的工作表对象

- **示例**:

	- 隐藏当前工作表
	`luckysheet.setSheetHide()`
	- 隐藏第三个工作表
	`luckysheet.setSheetHide({order:2})`

------------

### setSheetShow([setting])

- **参数**：

    - {PlainObject} [setting]: 可选参数
    	+ {Number} [order]: 被取消隐藏的工作表下标；默认值为当前工作表下标
    	+ {Function} [success]: 操作结束的回调函数

- **说明**：
	
	取消隐藏指定下标的工作表，返回被取消隐藏的工作表对象

- **示例**:

	- 取消隐藏第三个工作表
	`luckysheet.setSheetShow({order:2})`

------------

### setSheetActive(order [,setting])

- **参数**：

	- {Number} [order]: 要激活的工作表下标
	- {PlainObject} [setting]: 可选参数
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	设置指定下标的工作表为当前工作表（激活态），即切换到指定的工作表，返回被激活的工作表对象

- **示例**:

	- 切换到第二个工作表
	`luckysheet.setSheetActive(1)`

------------

### setSheetName(name [,setting])

- **参数**：

    - {String} [name]: 新的工作表名称
	- {PlainObject} [setting]: 可选参数
    	+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数
	
- **说明**：
	
	修改工作表名称

- **示例**:

	- 修改当前工作表名称为"CellSheet"
	`luckysheet.setSheetName("CellSheet")`

------------

### setSheetColor(color [,setting])

- **参数**：
	
	- {String} [color]: 工作表颜色
	- {PlainObject} [setting]: 可选参数
        + {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	设置工作表名称处的颜色

- **示例**:

	- 修改当前工作表名称处的颜色为红色
	`luckysheet.setSheetColor("#ff0000")`

------------

### setSheetMove(type [,setting])

- **参数**：

    - {String | Number} [type]: 工作表移动方向或者移动的目标下标，
		
		`type`可能的值有：
		
		+ `"left"`: 向左
		+ `"right"`: 向右
		+ `1`/`2`/`3`/...: 指定下标
	- {PlainObject} [setting]: 可选参数
    	+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	指定工作表向左边或右边移动一个位置，或者指定下标，返回指定的工作表对象

- **示例**:

	- 当前工作表向左移动一个位置
	`luckysheet.setSheetMove("left")`
	- 第二个工作表移动到第四个工作表的下标位置
	`luckysheet.setSheetMove(3,{order:1})`

------------

### setSheetOrder(orderList [,setting])

- **参数**：

    - {Array} [orderList]: 工作表顺序，设置工作表的index和order来指定位置，如：
	
	```json
	[
		{index:'sheet_01',order: 2},
		{index:'sheet_02',order: 1},
		{index:'sheet_03',order: 0},
	]
	```
	数组中顺序并不重要，关键是指定sheet index和order的对应关系。

	- {PlainObject} [setting]: 可选参数
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	重新排序所有工作表的位置，指定工作表顺序的数组。


- **示例**:

	- 重排工作表，此工作簿含有3个工作表
	```js
	luckysheet.setSheetOrder([
		{index:'sheet_01',order: 2},
		{index:'sheet_02',order: 1},
		{index:'sheet_03',order: 0},
	])
	```

------------

### setSheetZoom(zoom [,setting])

- **参数**：

    - {Number} [zoom]: 工作表缩放比例，值范围为0.1 ~ 4；

	- {PlainObject} [setting]: 可选参数
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	设置工作表缩放比例


- **示例**:

	- 设置当前工作表缩放比例为0.5
	```js
	luckysheet.setSheetZoom(0.5)
	```

------------

### showGridLines([setting])

- **参数**：

    - {PlainObject} [setting]: 可选参数
    	+ {Number} [order]: 需要显示网格线的工作表下标；默认值为当前工作表下标
    	+ {Function} [success]: 操作结束的回调函数

- **说明**：
	
	显示指定下标工作表的网格线，返回操作的工作表对象

- **示例**:

	- 显示当前工作表的网格线
	`luckysheet.showGridLines()`
	- 显示第三个工作表的网格线
	`luckysheet.showGridLines({order:2})`

------------

### hideGridLines([setting])

- **参数**：

    - {PlainObject} [setting]: 可选参数
    	+ {Number} [order]: 需要隐藏网格线的工作表下标；默认值为当前工作表下标
    	+ {Function} [success]: 操作结束的回调函数

- **说明**：
	
	隐藏指定下标工作表的网格线，返回操作的工作表对象

- **示例**:

	- 隐藏当前工作表的网格线
	`luckysheet.hideGridLines()`
	- 隐藏第三个工作表的网格线
	`luckysheet.hideGridLines({order:2})`

------------

## 工作簿操作

### create(options)

- **参数**：
	
	- {Object} [options]:表格的所有配置信息

- **说明**：
	
	初始化一个Luckysheet，可包含多个工作表，参考 [配置列表](/zh/guide/config.html)

------------

### refresh([setting])

- **参数**：
	
	- {PlainObject} [setting]: 可选参数
		+ {Function} [success]: 表格刷新成功后的回调函数

- **说明**：
	
	刷新canvas

------------

### scroll([setting])

- **参数**：
	
	- {PlainObject} [setting]: 可选参数
		+ {Number} [scrollLeft]：横向滚动值。默认为当前横向滚动位置。
		+ {Number} [scrollTop]：纵向滚动值。默认为当前纵向滚动位置。
		+ {Number} [targetRow]：纵向滚动到指定的行号。默认为当前纵向滚动位置。
		+ {Number} [targetColumn]：横向滚动到指定的列号。默认为当前横向滚动位置。
		+ {Function} [success]: 表格刷新成功后的回调函数

- **说明**：
	
	滚动当前工作表位置

------------

### resize([setting])

- **参数**：
		
	- {PlainObject} [setting]: 可选参数
		+ {Function} [success]: 操作结束的回调函数

- **说明**：
	
	根据窗口大小自动resize画布

------------

### destroy([setting])

- **参数**：
	
	- {PlainObject} [setting]: 可选参数
		+ {Function} [success]: 表格释放成功后的回调函数

- **说明**：
	
	删除并释放表格

------------

### getScreenshot([setting])

- **参数**：

    - {PlainObject} [setting]: 可选参数
		+ {Object | String} [range]: 选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`，只能为单个选区；默认为当前选区

- **说明**：
	
	返回当前表格指定选区截图后生成的base64格式的图片

------------

### setWorkbookName(name [,setting])

- **参数**：

    - {String} [name]: 工作簿名称
    - {PlainObject} [setting]: 可选参数
    	+ {Function} [success]: 操作结束的回调函数

- **说明**：
	
	设置工作簿名称

------------

### getWorkbookName([,setting])

- **参数**：

    - {PlainObject} [setting]: 可选参数
    	+ {Function} [success]: 操作结束的回调函数

- **说明**：
	
	获取工作簿名称

------------

### undo([setting])

- **参数**：

	- {PlainObject} [setting]: 可选参数
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	撤销当前操作，返回刚刚撤销的操作对象

------------

### redo([setting])

- **参数**：

	- {PlainObject} [setting]: 可选参数
        + {Function} [success]: 操作结束的回调函数

- **说明**：
	
	重做当前操作，返回刚刚重做的操作对象

------------

### refreshFormula([success])

- **参数**：

	- {Function} [success]: 操作结束的回调函数

- **说明**：
	
	强制刷新公式。当你直接修改了多个单元格的值，且没有触发刷新，且这些单元格跟公式相关联，则可以使用这个api最后强制触发一次公式刷新。

------------

### pagerInit([setting])

- **参数**：

	- {PlainObject} [setting]: 参数配置
		+ {Number} 		[pageIndex]:  当前的页码（必填）。
		+ {Number} 		[pageSize]:   每页显示多少条数据（必填）。
		+ {Number} 		[total]:  总条数（必填）。
		+ {Boolean} 	[showTotal]:  是否显示总数，默认关闭：false。
		+ {Boolean} 	[showSkip]:  是否显示跳页，默认关闭：false。
		+ {Boolean} 	[showPN]:  是否显示上下翻页，默认开启：true。
		+ {Array} 		[selectOption]:  选择分页的条数。
		+ {String} 		[prevPage]:  上翻页文字描述，默认"上一页"。
		+ {String} 		[nextPage]:  下翻页文字描述，默认"下一页"。
		+ {String} 		[totalTxt]:  数据总条数文字描述，默认"总共：{total}"。



- **说明**：
	
	初始化分页器。ps：create阶段，可以直接配置options.pager参数，渲染阶段会将options.pager作为参数来初始化分页器，可通过钩子函数onTogglePager来监听页码的切换

### refreshMenuButtonFocus([data],[r],[c],[success])

- **参数**：

	- {Array}  [data]: 操作数据
	- {Number} [r]: 指定的行
	- {Number} [c]: 指定的列
	- {Function} [success]: 操作结束的回调函数

- **说明**：
	
	刷新指定单元格的顶部状态栏状态。

------------

### checkTheStatusOfTheSelectedCells(type,status)

- **参数**：

	- {String} type: 类型
	- {String} status: 目标状态值

- **说明**：
	
	检查选区内所有cell指定类型的状态是否满足条件（主要是粗体、斜体、删除线和下划线等等）。

------------

## 图表

### insertChart([setting])

[todo]


- **参数**：

    - {PlainObject} [setting]: 可选参数
		+ {Array | Object | String} [range]: 图表数据的选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`，只能为单个选区；默认为当前选区
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标
		+ {Function} [success]: 操作结束的回调函数

- **说明**：
	
	指定工作表指定选区范围生成一个图表，返回图表参数对象，包含图表唯一标识符chart id

------------

### setChart(chartId, attr, value [,setting])

[todo]


- **参数**：
	
	- {String} [chartId]: 指定要修改的图表id
	- {String} [attr]: 属性类型
		
		`attr`可能的值有：
		
		+ `"left"`: 左边到工作表边缘的距离
		+ `"top"`: 上边到工作表边缘的距离
		+ `"width"`: 图表外框的宽度
		+ `"height"`: 图表外框的高度
		+ `"chartOptions"`: 图表的详细设置项
    
	- {Number | Object}} [value]: 属性值，当`attr`为`chartOptions`时，直接设置整个chart的配置对象
	
	- {PlainObject} [setting]: 可选参数
		+ {Function} [success]: 操作结束的回调函数

- **说明**：
	
	修改指定id图表的参数，返回修改后的整个图表参数

------------

### getChart(chartId)

[todo]


- **参数**：
	
	- {String} [chartId]: 指定要获取的图表id

- **说明**：
	
	获取指定id图表的参数

------------

### deleteChart(chartId [,setting])

[todo]


- **参数**：
	
	- {String} [chartId]: 要删除的图表id
	
	- {PlainObject} [setting]: 可选参数
		+ {Function} [success]: 操作结束的回调函数

- **说明**：
	
	删除指定id图表，返回被删除的图表的参数

------------

## 数据验证

### setDataVerification(optionItem, [setting])

- **参数**：
	
	- {Object} [optionItem]: 数据验证的配置信息，具体详细的配置信息参考[dataVerification](/zh/guide/sheet.html#dataVerification)
		
    - {PlainObject} [setting]: 可选参数
        + {Object | String} [range]: 数据验证的选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`，只能为单个选区；默认为当前选区
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标
		+ {Function} [success]: 操作结束的回调函数

- **说明**：
	
	指定工作表范围设置数据验证功能，并设置参数

------------

### deleteDataVerification([setting])

- **参数**：
	
    - {PlainObject} [setting]: 可选参数
		+ {Object | String} [range]: 数据验证的选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`，只能为单个选区；默认为当前选区
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标
		+ {Function} [success]: 操作结束的回调函数

- **说明**：
	
	指定工作表范围删除数据验证功能

------------

## 图片

### insertImage(src, [setting])

- **参数**：

	- {String} [src]: 图片src
	- {PlainObject} [setting]: 可选参数
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标
		+ {Number} [rowIndex]: 要插入图片的单元格行下标；默认为当前选区聚焦单元格行下标 || 0
		+ {Number} [colIndex]: 要插入图片的单元格列下标；默认为当前选区聚焦单元格列下标 || 0
		+ {Function} [success]: 操作结束的回调函数

- **说明**：

	在指定的工作表中指定单元格位置插入图片

### deleteImage([setting])

- **参数**：

	- {PlainObject} [setting]: 可选参数
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标
		+ {String | Array} [idList]: 要删除图片的id集合，也可为字符串`"all"`，all为所有的字符串；默认为`"all"`
		+ {Function} [success]: 操作结束的回调函数

- **说明**：

	删除指定工作表中的图片

### getImageOption([setting])

- **参数**：

	- {PlainObject} [setting]: 可选参数
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标
		+ {Function} [success]: 操作结束的回调函数

- **说明**：

	获取指定工作表的图片配置

## 工作表保护


### setProtection(option, [setting])

[todo]

- **参数**：
	
	- {Object} [option]: 工作表保护的配置信息
    - {PlainObject} [setting]: 可选参数
		+ {Number} [order]: 工作表下标；默认值为当前工作表下标
		+ {Function} [success]: 操作结束的回调函数

- **说明**：
	
	指定工作表设置工作表保护功能

------------

## 工具方法

### transToCellData(data [,setting])<div id='transToCellData'></div>

- **参数**：
	
	- {Array} [data]: data数据
	
	- {PlainObject} [setting]: 可选参数
		+ {Function} [success]: 操作结束的回调函数

- **说明**：
	
	data => celldata ，data二维数组数据转化成 {r, c, v}格式一维数组

------------

### transToData(celldata [,setting])<div id='transToData'></div>

- **参数**：
	
	- {Array} [celldata]: data数据
	
	- {PlainObject} [setting]: 可选参数
		+ {Function} [success]: 操作结束的回调函数

- **说明**：
	
	celldata => data ，celldata一维数组数据转化成表格所需二维数组

------------

### toJson()


- **说明**：
	
	导出的json字符串可以直接当作`luckysheet.create(options)`初始化工作簿时的参数`options`使用，使用场景在用户自己操作表格后想要手动保存全部的参数，再去别处初始化这个表格使用，类似一个luckysheet专有格式的导入导出。

------------

### changLang([lang])

- **参数**：

	+ {String} [lang]: 语言类型；暂支持`"zh"`、`"en"`、`"es"`；默认为`"zh"`；

- **说明**：

	传入目标语言，切换到对应的语言界面

### closeWebsocket()

- **说明**：

	关闭websocket连接

### getRangeByTxt([txt])

- **说明**：
	
	将字符串格式的工作表范围转换为数组形式

- **参数**：

  	+ {String} [txt]: 选区范围,支持选区的格式为`"A1:B2"`或者指定工作表名称的写法`"sheetName!A1:B2"`，只支持单个选区；默认为当前最后一个选区

- **示例**:

	- 当前选区为`A1:B2`，`luckysheet.getRangeByTxt()`返回：`{column: (2) [0, 1],row: (2) [0, 1]}`
	- `luckysheet.getRangeByTxt("A1:B2")`返回：`{column: (2) [0, 1],row: (2) [0, 1]}`
    - `luckysheet.getRangeByTxt("Cell!A1:B2")`返回：`{column: (2) [0, 1],row: (2) [0, 1]}`

------------

### getTxtByRange([range])

- **说明**：
	
	将数组格式的工作表范围转换为字符串格式的形式

- **参数**：

  	+ {Array | Object} [range]: 选区范围,支持选区的格式为`{row:[0,1],column:[0,1]}`，允许多个选区组成的数组；默认为当前选区

- **示例**:

	- 当前选区为`A1:B3`，`luckysheet.getTxtByRange()`返回：当前选区`"A1:B3"`
	- `luckysheet.getTxtByRange({column:[0,1],row:[0,2]})`返回：`"A1:B3"`
	- `luckysheet.getTxtByRange([{column:[0,1],row:[0,2]}])`返回：`"A1:B3"`
	- `luckysheet.getTxtByRange([{column:[0,1],row:[0,2]},{column:[1,1],row:[1,2]}])`返回：`"A1:B3,B2:B3"`

------------


## 旧版API

::: warning
为保持兼容性，仍然支持旧版API，但是已不推荐使用。
:::

### getcellvalue([r] [,c] [,data] [,type])

- **参数**：
	
	- {Number} [r]:单元格所在行数；可选值；从0开始的整数，0表示第一行
	- {Number} [c]:单元格所在列数；可选值；从0开始的整数，0表示第一列
	- {Array} [data]:表数据，二维数组；可选值；默认值为当前表格数据
	- {String} [type]:单元格属性值；可选值；默认值为'v',表示获取单元格的实际值

- **说明**：

	此方法为获取单元格的值。

	- luckysheet.getcellvalue()：返回当前工作表的所有数据；
	- luckysheet.getcellvalue(0)：返回当前工作表第1行数据；
	- luckysheet.getcellvalue(null,0)：返回当前工作表第1列数据；
	- luckysheet.getcellvalue(0,0)：返回当前工作表第1行第1列单元格的数据的v值；
	- luckysheet.getcellvalue(1,1,null,'m'): 返回指定data数据的第2行第2列单元格的原始值。
	
	特殊情况：单元格格式为yyyy-MM-dd，type为'v'时会强制取'm'显示值

	> 推荐使用新API： <a href='#getCellValue'>getCellValue</a>

------------

### getluckysheetfile()

- **说明**：

	返回所有表格数据结构的一维数组`luckysheetfile`

	> 推荐使用新API： [getLuckysheetfile](#getLuckysheetfile())

------------

### getconfig()

- **说明**：

	快捷返回当前表格config配置，每个工作表的config信息仍然包含在luckysheetfile。
	
	> 推荐使用新API： [getConfig](#getConfig([setting]))

------------

### getluckysheet_select_save()

- **说明**：

	返回当前选区对象的数组，可能存在多个选区。

	> 推荐使用新API： [getRange](#getRange())

------------

### getdatabyselection([range] [,sheetOrder])

- **参数**：
	
	- {Object} [range]：选区对象，`object: { row: [r1, r2], column: [c1, c2] }`；默认为当前第一个选区。
	- {Number} [sheetOrder]：表格下标，从0开始的整数，0表示第一个表格；默认为当前表格下标。

- **说明**：

	返回某个表格第一个选区的数据。
	- `luckysheet.getdatabyselection()`: 返回当前工作表当前选区的数据
	- `luckysheet.getdatabyselection(null,1)`: 返回第2个工作表的当前选区的数据

	> 推荐使用新API： [getRangeValue](#getRangeValue([setting]))

------------

### luckysheetrefreshgrid(scrollWidth, scrollHeight)

- **参数**：
	
	- {Number} [scrollWidth]：横向滚动值。默认为当前横向滚动位置。
	- {Number} [scrollHeight]：纵向滚动值。默认为当前纵向滚动位置。

- **说明**：

	按照scrollWidth, scrollHeight刷新canvas展示数据。

	> 推荐使用新API： [scroll](/zh/guide/api.html#scroll-setting)
------------

### setcellvalue(r, c, d, v)

- **参数**：
	
	- {Number} [r]：单元格所在行数；从0开始的整数，0表示第一行。
	- {Number} [c]：单元格所在列数；从0开始的整数，0表示第一列。
	- {Array} [d]：表数据；可选值；二维数组。
	- {Object | String | Number} [v]：要设置的值；可为对象，对象是是要符合单元格对象格式。

- **说明**：

	设置某个单元格的值。可配合`luckysheet.jfrefreshgrid()`刷新查看单元格值改变。

	```js
	luckysheet.setcellvalue(0, 0, luckysheet.flowdata(), 'abc');
	luckysheet.jfrefreshgrid();
	```

------------

### jfrefreshgrid()

- **说明**：

	刷新canvas

	> 推荐使用新API： [refresh](#refresh([setting]))
	
------------

### setluckysheet_select_save(v)

- **参数**：
	
	- {Array} [v]：要设置的选区值(数组)。符合选区格式规则，如`[{ row: [r1, r2], column: [c1, c2] }]`。

- **说明**：
	
	设置当前表格选区的值。配合`luckysheet.selectHightlightShow()`可在界面查看选区改变。
	```js
	luckysheet.setluckysheet_select_save([{ row: [0, 1], column: [0, 1] }]);
	luckysheet.selectHightlightShow();
	```

	> 推荐使用新API：<a href='#setRangeShow'>setRangeShow</a>
	
------------

### selectHightlightShow()

- **说明**：

	高亮当前选区

	> 推荐使用新API：<a href='#setRangeShow'>setRangeShow</a>

------------

### flowdata()

- **说明**：
	
	快捷获取当前表格的数据

	> 推荐使用新API：[getSheetData](#getSheetData())

------------

### buildGridData(file)

- **参数**：
	
	- {Object} [file]：[luckysheetfile](/zh/guide/sheet.html)

- **说明**：
	
	生成表格可以识别的二维数组

	> 推荐使用新API：<a href='#transToData'>transToData</a>

------------

### getGridData(data)

- **参数**：
	
	- {Array} [data]：工作表的二维数组数据

- **说明**：
	
	二维数组数据转化成 `{r, c, v}` 格式 一维数组

	> 推荐使用新API：<a href='#transToCellData'>transToCellData</a>