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 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424
|
---
layout: v2
title: Documentation
bodyclass: api-page
---
<h2>API Reference</h2>
<p>This reference reflects <strong>Leaflet 0.7.x</strong>. Check <a href='reference-versions.html'>this list</a> if you are using a different version of Leaflet.</p>
<div id="toc" class="clearfix">
<div class="toc-col map-col">
<h4>Map</h4>
<ul>
<li><a href="#map-usage">Usage example</a></li>
<li><a href="#map-constructor">Creation</a></li>
<li><a href="#map-options">Options</a></li>
<li><a href="#map-events">Events</a></li>
</ul>
<h4>Map Methods</h4>
<ul>
<li><a href="#map-set-methods">Modifying map state</a></li>
<li><a href="#map-get-methods">Getting map state</a></li>
<li><a href="#map-stuff-methods">Layers and controls</a></li>
<li><a href="#map-conversion-methods">Conversion methods</a></li>
<li><a href="#map-misc-methods">Other methods</a></li>
</ul>
<h4>Map Misc</h4>
<ul>
<li><a href="#map-properties">Properties</a></li>
<li><a href="#map-panes">Panes</a></li>
</ul>
</div>
<div class="toc-col">
<h4>UI Layers</h4>
<ul>
<li><a href="#marker">Marker</a></li>
<li><a href="#popup">Popup</a></li>
</ul>
<h4>Raster Layers</h4>
<ul>
<li><a href="#tilelayer">TileLayer</a></li>
<li><a href="#tilelayer-wms">TileLayer.WMS</a></li>
<li><a href="#tilelayer-canvas">TileLayer.Canvas</a></li>
<li><a href="#imageoverlay">ImageOverlay</a></li>
</ul>
<h4>Vector Layers</h4>
<ul>
<li><a href="#path">Path</a></li>
<li><a href="#polyline">Polyline</a></li>
<li><a href="#multipolyline">MultiPolyline</a></li>
<li><a href="#polygon">Polygon</a></li>
<li><a href="#multipolygon">MultiPolygon</a></li>
<li><a href="#rectangle">Rectangle</a></li>
<li><a href="#circle">Circle</a></li>
<li><a href="#circlemarker">CircleMarker</a></li>
</ul>
</div>
<div class="toc-col">
<h4>Other Layers</h4>
<ul>
<li><a href="#layergroup">LayerGroup</a></li>
<li><a href="#featuregroup">FeatureGroup</a></li>
<li><a href="#geojson">GeoJSON</a></li>
</ul>
<h4>Basic Types</h4>
<ul>
<li><a href="#latlng">LatLng</a></li>
<li><a href="#latlngbounds">LatLngBounds</a></li>
<li><a href="#point">Point</a></li>
<li><a href="#bounds">Bounds</a></li>
<li><a href="#icon">Icon</a></li>
<li><a href="#divicon">DivIcon</a></li>
</ul>
<h4>Controls</h4>
<ul>
<li><a href="#control">Control</a></li>
<li><a href="#control-zoom">Zoom</a></li>
<li><a href="#control-attribution">Attribution</a></li>
<li><a href="#control-layers">Layers</a></li>
<li><a href="#control-scale">Scale</a></li>
</ul>
</div>
<div class="toc-col">
<h4>Events</h4>
<ul>
<li><a href="#events">Event methods</a></li>
<li><a href="#event-objects">Event objects</a></li>
</ul>
<h4>Utility</h4>
<ul>
<li><a href="#class">Class</a></li>
<li><a href="#browser">Browser</a></li>
<li><a href="#util">Util</a></li>
<li><a href="#transformation">Transformation</a></li>
<li><a href="#lineutil">LineUtil</a></li>
<li><a href="#polyutil">PolyUtil</a></li>
</ul>
<h4>DOM Utility</h4>
<ul>
<li><a href="#domevent">DomEvent</a></li>
<li><a href="#domutil">DomUtil</a></li>
<li><a href="#posanimation">PosAnimation</a></li>
<li><a href="#draggable">Draggable</a></li>
</ul>
</div>
<div class="toc-col last-col">
<h4>Interfaces</h4>
<ul>
<li><a href="#ihandler">IHandler</a></li>
<li><a href="#ilayer">ILayer</a></li>
<!--<li><a class="nodocs" href="#">IFeature</a></li>-->
<li><a href="#icontrol">IControl</a></li>
<li><a href="#iprojection">IProjection</a></li>
<li><a href="#icrs">ICRS</a></li>
</ul>
<h4>Misc</h4>
<ul>
<li><a href="#global">global switches</a></li>
<li><a href="#noconflict">noConflict</a></li>
<li><a href="#version">version</a></li>
</ul>
</div>
</div>
<!--<a href="#toc" id="back-to-top">↑</a>-->
<hr />
<h2 id="map-class">Map</h2>
<p>The central class of the API — it is used to create a map on a page and manipulate it.</p>
<h3 id="map-usage">Usage example</h3>
<pre><code class="javascript">// initialize the map on the "map" div with a given center and zoom
var map = L.map('map', {
center: [51.505, -0.09],
zoom: 13
});</code></pre>
<h3 id="map-constructor" class="left">Creation</h3>
<table data-id='map'>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>L.map</b>(
<nobr><HTMLElement|String> <i>id</i>,</nobr>
<nobr><<a href="#map-options">Map options</a>> <i>options?</i> )</nobr>
</code></td>
<td>Instantiates a map object given a div element (or its id) and optionally an object literal with map options described below.</td>
</tr>
</table>
<h3 id="map-options">Options</h3>
<h4>Map State Options</h4>
<table data-id='map'>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>center</b></code></td>
<td><code><a href="#latlng">LatLng</a></code></td>
<td><code><span class="hljs-literal">null</span></code></td>
<td>Initial geographical center of the map.</td>
</tr>
<tr>
<td><code><b>zoom</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-literal">null</span></code></td>
<td>Initial map zoom.</td>
</tr>
<tr>
<td><code><b>layers</b></code></td>
<td><code><a href="#ilayer">ILayer</a>[]</code></td>
<td><code><span class="hljs-literal">null</span></code></td>
<td>Layers that will be added to the map initially.</td>
</tr>
<tr>
<td><code><b>minZoom</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-literal">null</span></code></td>
<td>Minimum zoom level of the map. Overrides any <code>minZoom</code> set on map layers.</td>
</tr>
<tr>
<td><code><b>maxZoom</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-literal">null</span></code></td>
<td>Maximum zoom level of the map. This overrides any <code>maxZoom</code> set on map layers.</td>
</tr>
<tr id="map-maxbounds">
<td><code><b>maxBounds</b></code></td>
<td><code><a href="#latlngbounds">LatLngBounds</a></code></td>
<td><code><span class="hljs-literal">null</span></code></td>
<td>When this option is set, the map restricts the view to the given geographical bounds, bouncing the user back when they try to pan outside the view. To set the restriction dynamically, use <a href="#map-setmaxbounds">setMaxBounds</a> method.</td>
</tr>
<tr>
<td><code><b>crs</b></code></td>
<td><code><a href="#icrs">CRS</a></code></td>
<td><code>L.CRS.<br/>EPSG3857</code></td>
<td>Coordinate Reference System to use. Don't change this if you're not sure what it means.</td>
</tr>
</table>
<h4>Interaction Options</h4>
<table data-id='map'>
<tr>
<th class="width140">Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>dragging</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code></td>
<td>Whether the map be draggable with mouse/touch or not.</td>
</tr>
<tr>
<td><code><b>touchZoom</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code></td>
<td>Whether the map can be zoomed by touch-dragging with two fingers.</td>
</tr>
<tr>
<td><code><b>scrollWheelZoom</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code></td>
<td>Whether the map can be zoomed by using the mouse wheel. If passed <code><span class="hljs-string">'center'</span></code>, it will zoom to the center of the view regardless of where the mouse was.</td>
</tr>
<tr>
<td><code><b>doubleClickZoom</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code></td>
<td>Whether the map can be zoomed in by double clicking on it and zoomed out by double clicking while holding shift. If passed <code><span class="hljs-string">'center'</span></code>, double-click zoom will zoom to the center of the view regardless of where the mouse was.</td>
</tr>
<tr>
<td><code><b>boxZoom</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code></td>
<td>Whether the map can be zoomed to a rectangular area specified by dragging the mouse while pressing shift.</td>
</tr>
<tr>
<td><code><b>tap</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code></td>
<td>Enables mobile hacks for supporting instant taps (fixing 200ms click delay on iOS/Android) and touch holds (fired as <code>contextmenu</code> events).</td>
</tr>
<tr>
<td><code><b>tapTolerance</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-number">15</span></code></td>
<td>The max number of pixels a user can shift his finger during touch for it to be considered a valid tap.</td>
</tr>
<tr>
<td><code><b>trackResize</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code></td>
<td>Whether the map automatically handles browser window resize to update itself.</td>
</tr>
<tr>
<td><code><b>worldCopyJump</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">false</span></code></td>
<td>With this option enabled, the map tracks when you pan to another "copy" of the world and seamlessly jumps to the original one so that all overlays like markers and vector layers are still visible.</td>
</tr>
<tr>
<td><code><b>closePopupOnClick</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code></td>
<td>Set it to <code><span class="hljs-literal">false</span></code> if you don't want popups to close when user clicks the map.</td>
</tr>
<tr>
<td><code><b>bounceAtZoomLimits</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code></td>
<td>Set it to <code><span class="hljs-literal">false</span></code> if you don't want the map to zoom beyond min/max zoom and then bounce back when pinch-zooming.</td>
</tr>
</table>
<h4>Keyboard Navigation Options</h4>
<table data-id='map'>
<tr>
<th class="width140">Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>keyboard</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code></td>
<td>Makes the map focusable and allows users to navigate the map with keyboard arrows and <code>+</code>/<code>-</code> keys.</td>
</tr>
<tr>
<td><code><b>keyboardPanOffset</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-number">80</span></code></td>
<td>Amount of pixels to pan when pressing an arrow key.</td>
</tr>
<tr>
<td><code><b>keyboardZoomOffset</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-number">1</span></code></td>
<td>Number of zoom levels to change when pressing <code>+</code> or <code>-</code> key.</td>
</tr>
</table>
<h4>Panning Inertia Options</h4>
<table data-id='map'>
<tr>
<th class="width140">Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>inertia</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code></td>
<td>If enabled, panning of the map will have an inertia effect where the map builds momentum while dragging and continues moving in the same direction for some time. Feels especially nice on touch devices.</td>
</tr>
<tr>
<td><code><b>inertiaDeceleration</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-number">3000</span></code></td>
<td>The rate with which the inertial movement slows down, in pixels/second<sup>2</sup>.</td>
</tr>
<tr>
<td><code><b>inertiaMaxSpeed</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-number">1500</span></code></td>
<td>Max speed of the inertial movement, in pixels/second.</td>
</tr>
<tr>
<td><code><b>inertiaThreshold</b></code></td>
<td><code>Number</code></td>
<td><code>depends</code></td>
<td>Number of milliseconds that should pass between stopping the movement and releasing the mouse or touch to prevent inertial movement. <code><span class="hljs-number">32</span></code> for touch devices and <code><span class="hljs-number">14</span></code> for the rest by default.</td>
</tr>
</table>
<h4>Control options</h4>
<table data-id='map'>
<tr>
<th class="width140">Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>zoomControl</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code></td>
<td>Whether the <a href="#control-zoom">zoom control</a> is added to the map by default.</td>
</tr>
<tr>
<td><code><b>attributionControl</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code></td>
<td>Whether the <a href="#control-attribution">attribution control</a> is added to the map by default.</td>
</tr>
</table>
<h4>Animation options</h4>
<table data-id='map'>
<tr>
<th class="width140">Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>fadeAnimation</b></code></td>
<td><code>Boolean</code></td>
<td>depends</td>
<td>Whether the tile fade animation is enabled. By default it's enabled in all browsers that support CSS3 Transitions except Android.</td>
</tr>
<tr>
<td><code><b>zoomAnimation</b></code></td>
<td><code>Boolean</code></td>
<td>depends</td>
<td>Whether the tile zoom animation is enabled. By default it's enabled in all browsers that support CSS3 Transitions except Android.</td>
</tr>
<tr>
<td><code><b>zoomAnimationThreshold</b></code></td>
<td><code>Number</code></td>
<td><span class="hljs-number">4</span></td>
<td>Won't animate zoom if the zoom difference exceeds this value.</td>
</tr>
<tr>
<td><code><b>markerZoomAnimation</b></code></td>
<td><code>Boolean</code></td>
<td>depends</td>
<td>Whether markers animate their zoom with the zoom animation, if disabled they will disappear for the length of the animation. By default it's enabled in all browsers that support CSS3 Transitions except Android.</td>
</tr>
</table>
<h3 id="map-events">Events</h3>
<p>You can subscribe to the following events using <a href="#events">these methods</a>.</p>
<table data-id='map'>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>click</b></code></td>
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
<td>Fired when the user clicks (or taps) the map.</td>
</tr>
<tr>
<td><code><b>dblclick</b></code></td>
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
<td>Fired when the user double-clicks (or double-taps) the map.</td>
</tr>
<tr>
<td><code><b>mousedown</b></code></td>
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
<td>Fired when the user pushes the mouse button on the map.</td>
</tr>
<tr>
<td><code><b>mouseup</b></code></td>
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
<td>Fired when the user releases the mouse button on the map.</td>
</tr>
<tr>
<td><code><b>mouseover</b></code></td>
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
<td>Fired when the mouse enters the map.</td>
</tr>
<tr>
<td><code><b>mouseout</b></code></td>
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
<td>Fired when the mouse leaves the map.</td>
</tr>
<tr>
<td><code><b>mousemove</b></code></td>
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
<td>Fired while the mouse moves over the map.</td>
</tr>
<tr>
<td><code><b>contextmenu</b></code></td>
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
<td>Fired when the user pushes the right mouse button on the map, prevents default browser context menu from showing if there are listeners on this event. Also fired on mobile when the user holds a single touch for a second (also called long press).</td>
</tr>
<tr>
<td><code><b>focus</b></code></td>
<td><code><a href="#event">Event</a></code></td>
<td>Fired when the user focuses the map either by tabbing to it or clicking/panning.</td>
</tr>
<tr>
<td><code><b>blur</b></code></td>
<td><code><a href="#event">Event</a></code></td>
<td>Fired when the map loses focus.</td>
</tr>
<tr>
<td><code><b>preclick</b></code></td>
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
<td>Fired before mouse click on the map (sometimes useful when you want something to happen on click before any existing click handlers start running).</td>
</tr>
<tr>
<td><code><b>load</b></code></td>
<td><code><a href="#event">Event</a></code></td>
<td>Fired when the map is initialized (when its center and zoom are set for the first time).</td>
</tr>
<tr>
<td><code><b>unload</b></code></td>
<td><code><a href="#event">Event</a></code></td>
<td>Fired when the map is destroyed with <a href="#map-remove">remove</a> method.</td>
</tr>
<tr id="map-viewreset">
<td><code><b>viewreset</b></code></td>
<td><code><a href="#event">Event</a></code></td>
<td>Fired when the map needs to redraw its content (this usually happens on map zoom or load). Very useful for creating custom overlays.</td>
</tr>
<tr>
<td><code><b>movestart</b></code></td>
<td><code><a href="#event">Event</a></code></td>
<td>Fired when the view of the map starts changing (e.g. user starts dragging the map).</td>
</tr>
<tr>
<td><code><b>move</b></code></td>
<td><code><a href="#event">Event</a></code></td>
<td>Fired on any movement of the map view.</td>
</tr>
<tr id="map-moveend">
<td><code><b>moveend</b></code></td>
<td><code><a href="#event">Event</a></code></td>
<td>Fired when the view of the map stops changing (e.g. user stopped dragging the map).</td>
</tr>
<tr>
<td><code><b>dragstart</b></code></td>
<td><code><a href="#event">Event</a></code></td>
<td>Fired when the user starts dragging the map.</td>
</tr>
<tr>
<td><code><b>drag</b></code></td>
<td><code><a href="#event">Event</a></code></td>
<td>Fired repeatedly while the user drags the map.</td>
</tr>
<tr>
<td><code><b>dragend</b></code></td>
<td><code><a href="#dragend-event">DragEndEvent</a></code></td>
<td>Fired when the user stops dragging the map.</td>
</tr>
<tr>
<td><code><b>zoomstart</b></code></td>
<td><code><a href="#event">Event</a></code></td>
<td>Fired when the map zoom is about to change (e.g. before zoom animation).</td>
</tr>
<tr>
<td><code><b>zoomend</b></code></td>
<td><code><a href="#event">Event</a></code></td>
<td>Fired when the map zoom changes.</td>
</tr>
<tr>
<td><code><b>zoomlevelschange</b></code></td>
<td><code><a href="#event">Event</a></code></td>
<td>Fired when the number of zoomlevels on the map is changed due to adding or removing a layer.</td>
</tr>
<tr>
<td><code><b>resize</b></code></td>
<td><code><a href="#resize-event">ResizeEvent</a></code></td>
<td>Fired when the map is resized.</td>
</tr>
<tr>
<td><code><b>autopanstart</b></code></td>
<td><code><a href="#event">Event</a></code></td>
<td>Fired when the map starts autopanning when opening a popup.</td>
</tr>
<tr>
<td><code><b>layeradd</b></code></td>
<td><code><a href="#layer-event">LayerEvent</a></code></td>
<td>Fired when a new layer is added to the map.</td>
</tr>
<tr>
<td><code><b>layerremove</b></code></td>
<td><code><a href="#layer-event">LayerEvent</a></code></td>
<td>Fired when some layer is removed from the map.</td>
</tr>
<tr>
<td><code><b>baselayerchange</b></code></td>
<td><code><a href="#layer-event">LayerEvent</a></code>
<td>Fired when the base layer is changed through the <a href="#control-layers">layer control</a>.</td>
</tr>
<tr>
<td><code><b>overlayadd</b></code></td>
<td><code><a href="#layer-event">LayerEvent</a></code>
<td>Fired when an overlay is selected through the <a href="#control-layers">layer control</a>.</td>
</tr>
<tr>
<td><code><b>overlayremove</b></code></td>
<td><code><a href="#layer-event">LayerEvent</a></code>
<td>Fired when an overlay is deselected through the <a href="#control-layers">layer control</a>.</td>
</tr>
<tr>
<td><code><b>locationfound</b></code></td>
<td><code><a href="#location-event">LocationEvent</a></code>
<td>Fired when geolocation (using the <a href="#map-locate">locate</a> method) went successfully.</td>
</tr>
<tr>
<td><code><b>locationerror</b></code></td>
<td><code><a href="#error-event">ErrorEvent</a></code>
<td>Fired when geolocation (using the <a href="map-locate">locate</a> method) failed.</td>
</tr>
<tr>
<td><code><b>popupopen</b></code></td>
<td><code><a href="#popup-event">PopupEvent</a></code></td>
<td>Fired when a popup is opened (using <code>openPopup</code> method).</td>
</tr>
<tr>
<td><code><b>popupclose</b></code></td>
<td><code><a href="#popup-event">PopupEvent</a></code></td>
<td>Fired when a popup is closed (using <code>closePopup</code> method).</td>
</tr>
</table>
<h3 id="map-set-methods">Methods for Modifying Map State</h3>
<table data-id='map'>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>setView</b>(
<nobr><<a href="#latlng">LatLng</a>> <i>center</i>,</nobr>
<nobr><Number> <i>zoom?</i>,</nobr>
<nobr><<a href="#map-zoompanoptions">zoom/pan options</a>> <i>options?</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Sets the view of the map (geographical center and zoom) with the given animation options.</td>
</tr>
<tr>
<td><code><b>setZoom</b>(
<nobr><Number> <i>zoom</i></nobr>,
<nobr><<a href="#map-zoomoptions">zoom options</a>> <i>options?</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Sets the zoom of the map.</td>
</tr>
<tr>
<td><code><b>zoomIn</b>(
<nobr><Number> <em>delta?</em></nobr>,
<nobr><<a href="#map-zoomoptions">zoom options</a>> <i>options?</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Increases the zoom of the map by <code>delta</code> (<code><span class="hljs-number">1</span></code> by default).</td>
</tr>
<tr>
<td><code><b>zoomOut</b>(
<nobr><Number> <em>delta?</em></nobr>,
<nobr><<a href="#map-zoomoptions">zoom options</a>> <i>options?</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Decreases the zoom of the map by <code>delta</code> (<code><span class="hljs-number">1</span></code> by default).</td>
</tr>
<tr>
<td><code><b>setZoomAround</b>(
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i>, </nobr>
<nobr><Number> <i>zoom</i></nobr>,
<nobr><<a href="#map-zoomoptions">zoom options</a>> <i>options?</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Zooms the map while keeping a specified point on the map stationary (e.g. used internally for scroll zoom and double-click zoom).</td>
</tr>
<tr id="map-fitbounds">
<td><code><b>fitBounds</b>(
<nobr><<a href="#latlngbounds">LatLngBounds</a>> <i>bounds</i></nobr>,
<nobr><<a href="#map-fitboundsoptions">fitBounds options</a>> <i>options?</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Sets a map view that contains the given geographical bounds with the maximum zoom level possible.</td>
</tr>
<tr id="map-fitworld">
<td><code><b>fitWorld</b>(
<nobr><<a href="#map-fitboundsoptions">fitBounds options</a>> <i>options?</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Sets a map view that mostly contains the whole world with the maximum zoom level possible.</td>
</tr>
<tr>
<td><code><b>panTo</b>(
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i></nobr>,
<nobr><<a href="#map-panoptions">pan options</a>> <i>options?</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Pans the map to a given center. Makes an animated pan if new center is not more than one screen away from the current one.</td>
</tr>
<tr id="map-paninsidebounds">
<td><code><b>panInsideBounds</b>(
<nobr><<a href="#latlngbounds">LatLngBounds</a>> <i>bounds</i></nobr>,
<nobr><<a href="#map-panoptions">pan options</a>> <i>options?</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Pans the map to the closest view that would lie inside the given bounds (if it's not already), controlling the animation using the options specific, if any.</td>
</tr>
<tr>
<td><code><b>panBy</b>(
<nobr><<a href="#point">Point</a>> <i>point</i></nobr>,
<nobr><<a href="#map-panoptions">pan options</a>> <i>options?</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Pans the map by a given number of pixels (animated).</td>
</tr>
<tr>
<td><code><b>invalidateSize</b>(
<nobr><Boolean> <i>animate</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Checks if the map container size changed and updates the map if so — call it after you've changed the map size dynamically, also animating pan by default.</td>
</tr>
<tr>
<td><code><b>invalidateSize</b>(
<nobr><<a href="#map-zoompanoptions">zoom/pan options</a>> <i>options</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Checks if the map container size changed and updates the map if so — call it after you've changed the map size dynamically, also animating pan by default. If <code>options.pan</code> is <code><span class="hljs-literal">false</span></code>, panning will not occur. If <code>options.debounceMoveend</code> is <code><span class="hljs-literal">true</span></code>, it will delay <code>moveend</code> event so that it doesn't happen often even if the method is called many times in a row.</td>
</tr>
<tr id="map-setmaxbounds">
<td><code><b>setMaxBounds</b>(
<nobr><<a href="#latlngbounds">LatLngBounds</a>> <i>bounds</i></nobr><!--,
<nobr><<a href="#map-zoompanoptions">zoom/pan options</a>> <i>options?</i> )</nobr>-->
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Restricts the map view to the given bounds (see <a href="#map-maxbounds">map maxBounds</a> option)<!--, animating the map view if bounds are changed. The given animation options are passed through to `setView` or `panInsideBounds`, depending on map zoom level, and can be used to control how the map animates during this change-->.</td>
</tr>
<tr id="map-locate">
<td><code><b>locate</b>(
<nobr><<a href="#map-locate-options">Locate options</a>> <i>options?</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Tries to locate the user using the <a href="https://en.wikipedia.org/wiki/W3C_Geolocation_API">Geolocation API</a>, firing a <code>locationfound</code> event with location data on success or a <code>locationerror</code> event on failure, and optionally sets the map view to the user's location with respect to detection accuracy (or to the world view if geolocation failed). See <a href="#map-locate-options">Locate options</a> for more details.</td>
</tr>
<tr>
<td><code><b>stopLocate</b>()</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Stops watching location previously initiated by <code><b>map.locate</b>({watch: true})</code> and aborts resetting the map view if <code>map.locate</code> was called with <code>{setView: true}</code>.</td>
</tr>
<tr id="map-remove">
<td><code><b>remove</b>()</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Destroys the map and clears all related event listeners.</td>
</tr>
</table>
<h3 id="map-get-methods">Methods for Getting Map State</h3>
<table data-id='map'>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>getCenter</b>()</code></td>
<td><code><a href="#latlng">LatLng</a></code></td>
<td>Returns the geographical center of the map view.</td>
</tr>
<tr>
<td><code><b>getZoom</b>()</code></td>
<td><code>Number</code></td>
<td>Returns the current zoom of the map view.</td>
</tr>
<tr>
<td><code><b>getMinZoom</b>()</code></td>
<td><code>Number</code></td>
<td>Returns the minimum zoom level of the map.</td>
</tr>
<tr>
<td><code><b>getMaxZoom</b>()</code></td>
<td><code>Number</code></td>
<td>Returns the maximum zoom level of the map.</td>
</tr>
<tr>
<td><code><b>getBounds</b>()</code></td>
<td><code><a href="#latlngbounds">LatLngBounds</a></code></td>
<td>Returns the LatLngBounds of the current map view.</td>
</tr>
<tr>
<td><code><b>getBoundsZoom</b>(
<nobr><<a href="#latlngbounds">LatLngBounds</a>> <i>bounds</i>,</nobr>
<nobr><Boolean> <i>inside?</i> )</nobr>
</code></td>
<td><code>Number</code></td>
<td>Returns the maximum zoom level on which the given bounds fit to the map view in its entirety. If <code>inside</code> (optional) is set to <code><span class="hljs-literal">true</span></code>, the method instead returns the minimum zoom level on which the map view fits into the given bounds in its entirety.</td>
</tr>
<tr>
<td><code><b>getSize</b>()</code></td>
<td><code><a href="#point">Point</a></code></td>
<td>Returns the current size of the map container.</td>
</tr>
<tr>
<td><code><b>getPixelBounds</b>()</code></td>
<td><code><a href="#bounds">Bounds</a></code></td>
<td>Returns the bounds of the current map view in projected pixel coordinates (sometimes useful in layer and overlay implementations).</td>
</tr>
<tr>
<td><code><b>getPixelOrigin</b>()</code></td>
<td><code><a href="#point">Point</a></code></td>
<td>Returns the projected pixel coordinates of the top left point of the map layer (useful in custom layer and overlay implementations).</td>
</tr>
</table>
<h3 id="map-stuff-methods">Methods for Layers and Controls</h3>
<table data-id='map'>
<tr>
<th class="width250">Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr id="map-addlayer">
<td><code><b>addLayer</b>(
<nobr><<a href="#ilayer">ILayer</a>> <i>layer</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Adds the given layer to the map.</td>
</tr>
<tr>
<td><code><b>removeLayer</b>(
<nobr><<a href="#ilayer">ILayer</a>> <i>layer</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Removes the given layer from the map.</td>
</tr>
<tr>
<td><code><b>hasLayer</b>(
<nobr><<a href="#ilayer">ILayer</a>> <i>layer</i> )</nobr>
</code></td>
<td><code>Boolean</code></td>
<td>Returns <code><span class="hljs-literal">true</span></code> if the given layer is currently added to the map.</td>
</tr>
<tr>
<td><code><b>eachLayer</b>(
<nobr><Function> <i>fn</i></nobr>,
<nobr><Object> <i>context?</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Iterates over the layers of the map, optionally specifying context of the iterator function.
<pre><code>map.eachLayer(function (layer) {
layer.bindPopup('Hello');
});</code></pre>
</td>
</tr>
<tr id="map-openpopup">
<td><code><b>openPopup</b>(
<nobr><<a href="#popup">Popup</a>> <i>popup</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Opens the specified popup while closing the previously opened (to make sure only one is opened at one time for usability).</td>
</tr>
<tr id="map-openpopup2">
<td><code><b>openPopup</b>(
<nobr><String> <i>html</i> </nobr> | <nobr><HTMLElement> <i>el</i>,
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i></nobr>,
<nobr><<a href="#popup-options">Popup options</a>> <i>options?</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Creates a popup with the specified options and opens it in the given point on a map.</td>
</tr>
<tr id="map-closepopup">
<td><code><b>closePopup</b>(
<nobr><<a href="#popup">Popup</a>> <i>popup?</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Closes the popup previously opened with <a href="#map-openpopup">openPopup</a> (or the given one).</td>
</tr>
<tr id="map-addcontrol">
<td><code><b>addControl</b>(
<nobr><<a href="#icontrol">IControl</a>> <i>control</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Adds the given control to the map.</td>
</tr>
<tr>
<td><code><b>removeControl</b>(
<nobr><<a href="#icontrol">IControl</a>> <i>control</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Removes the given control from the map.</td>
</tr>
</table>
<h3 id="map-conversion-methods">Conversion Methods</h3>
<table data-id='map'>
<tr>
<th class="width200">Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>latLngToLayerPoint</b>(
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i> )</nobr>
</code></td>
<td><code><a href="#point">Point</a></code></td>
<td>Returns the map layer point that corresponds to the given geographical coordinates (useful for placing overlays on the map).</td>
</tr>
<tr>
<td><code><b>layerPointToLatLng</b>(
<nobr><<a href="#point">Point</a>> <i>point</i> )</nobr>
</code></td>
<td><code><a href="#latlng">LatLng</a></code></td>
<td>Returns the geographical coordinates of a given map layer point.</td>
</tr>
<tr>
<td><code><b>containerPointToLayerPoint</b>(
<nobr><<a href="#point">Point</a>> <i>point</i> )</nobr>
</code></td>
<td><code><a href="#point">Point</a></code></td>
<td>Converts the point relative to the map container to a point relative to the map layer.</td>
</tr>
<tr>
<td><code><b>layerPointToContainerPoint</b>(
<nobr><<a href="#point">Point</a>> <i>point</i> )</nobr>
</code></td>
<td><code><a href="#point">Point</a></code></td>
<td>Converts the point relative to the map layer to a point relative to the map container.</td>
</tr>
<tr>
<td><code><b>latLngToContainerPoint</b>(
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i> )</nobr>
</code></td>
<td><code><a href="#point">Point</a></code></td>
<td>Returns the map container point that corresponds to the given geographical coordinates.</td>
</tr>
<tr>
<td><code><b>containerPointToLatLng</b>(
<nobr><<a href="#point">Point</a>> <i>point</i> )</nobr>
</code></td>
<td><code><a href="#latlng">LatLng</a></code></td>
<td>Returns the geographical coordinates of a given map container point.</td>
</tr>
<tr>
<td><code><b>project</b>(
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i>,</nobr>
<nobr><Number> <i>zoom?</i> )</nobr>
</code></td>
<td><code><a href="#point">Point</a></code></td>
<td>Projects the given geographical coordinates to absolute pixel coordinates for the given zoom level (current zoom level by default).</td>
</tr>
<tr>
<td><code><b>unproject</b>(
<nobr><<a href="#point">Point</a>> <i>point</i>,</nobr>
<nobr><Number> <i>zoom?</i> )</nobr>
</code></td>
<td><code><a href="#latlng">LatLng</a></code></td>
<td>Projects the given absolute pixel coordinates to geographical coordinates for the given zoom level (current zoom level by default).</td>
</tr>
<tr>
<td><code><b>mouseEventToContainerPoint</b>(
<nobr><MouseEvent> <i>event</i> )</nobr>
</code></td>
<td><code><a href="#point">Point</a></code></td>
<td>Returns the pixel coordinates of a mouse click (relative to the top left corner of the map) given its event object.</td>
</tr>
<tr>
<td><code><b>mouseEventToLayerPoint</b>(
<nobr><MouseEvent> <i>event</i> )</nobr>
</code></td>
<td><code><a href="#point">Point</a></code></td>
<td>Returns the pixel coordinates of a mouse click relative to the map layer given its event object.
</tr>
<tr>
<td><code><b>mouseEventToLatLng</b>(
<nobr><MouseEvent> <i>event</i> )</nobr>
</code></td>
<td><code><a href="#latlng">LatLng</a></code></td>
<td>Returns the geographical coordinates of the point the mouse clicked on given the click's event object.</td>
</tr>
</table>
<h3 id="map-misc-methods">Other Methods</h3>
<table data-id='map'>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>getContainer</b>()</code></td>
<td><code>HTMLElement</code></td>
<td>Returns the container element of the map.</td>
</tr>
<tr>
<td><code><b>getPanes</b>()</code></td>
<td><code><a href="#map-panes">MapPanes</a></code></td>
<td>Returns an object with different map panes (to render overlays in).</td>
</tr>
<tr>
<td><code><b>whenReady</b>(
<nobr><Function> <i>fn</i></nobr>,
<nobr><Object> <i>context?</i> )</nobr></code></td>
<td><code>this</code></td>
<td>Runs the given callback when the map gets initialized with a place and zoom, or immediately if it happened already, optionally passing a function context.</td>
</tr>
</table>
<h3 id="map-locate-options">Locate options</h3>
<table data-id='map'>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>watch</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">false</span></code></td>
<td>If <code><span class="hljs-literal">true</span></code>, starts continuous watching of location changes (instead of detecting it once) using W3C <code>watchPosition</code> method. You can later stop watching using <code><b>map.stopLocate</b>()</code> method.</td>
</tr>
<tr>
<td><code><b>setView</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">false</span></code></td>
<td>If <code><span class="hljs-literal">true</span></code>, automatically sets the map view to the user location with respect to detection accuracy, or to world view if geolocation failed.</td>
</tr>
<tr>
<td><code><b>maxZoom</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-number">Infinity</span></code></td>
<td>The maximum zoom for automatic view setting when using `setView` option.</td>
</tr>
<tr>
<td><code><b>timeout</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-number">10000</span></code></td>
<td>Number of milliseconds to wait for a response from geolocation before firing a <code>locationerror</code> event.</td>
</tr>
<tr>
<td><code><b>maximumAge</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-number">0</span></code></td>
<td>Maximum age of detected location. If less than this amount of milliseconds passed since last geolocation response, <code>locate</code> will return a cached location.</td>
</tr>
<tr>
<td><code><b>enableHighAccuracy</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">false</span></code></td>
<td>Enables high accuracy, see <a href="http://dev.w3.org/geo/api/spec-source.html#high-accuracy">description in the W3C spec</a>.</td>
</tr>
</table>
<h3 id="map-zoompanoptions">Zoom/pan options</h3>
<table data-id='map'>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>reset</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">false</span></code></td>
<td>If <code><span class="hljs-literal">true</span></code>, the map view will be completely reset (without any animations).</td>
</tr>
<tr>
<td><code><b>pan</b></code></td>
<td><code><a href="#map-panoptions">pan options</a></code></td>
<td><code>-</code></td>
<td>Sets the options for the panning (without the zoom change) if it occurs.</td>
</tr>
<tr>
<td><code><b>zoom</b></code></td>
<td><code><a href="#map-zoomoptions">zoom options</a></code></td>
<td><code>-</code></td>
<td>Sets the options for the zoom change if it occurs.</td>
</tr>
<tr>
<td><code><b>animate</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">-</span></code></td>
<td>An equivalent of passing <code>animate</code> to both zoom and pan options (see below).</td>
</tr>
</table>
<h3 id="map-panoptions">Pan options</h3>
<table data-id='map'>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>animate</b></code></td>
<td><code>Boolean</code></td>
<td><code>-</code></td>
<td>If <code><span class="hljs-literal">true</span></code>, panning will always be animated if possible. If <code><span class="hljs-literal">false</span></code>, it will not animate panning, either resetting the map view if panning more than a screen away, or just setting a new offset for the map pane (except for `panBy` which always does the latter).</td>
</tr>
<tr>
<td><code><b>duration</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-number">0.25</span></code></td>
<td>Duration of animated panning.</td>
</tr>
<tr>
<td><code><b>easeLinearity</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-number">0.25</span></code></td>
<td>The curvature factor of panning animation easing (third parameter of the <a href="http://cubic-bezier.com/">Cubic Bezier curve</a>). <span class="hljs-number">1.0</span> means linear animation, the less the more bowed the curve.</td>
</tr>
<tr>
<td><code><b>noMoveStart</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">false</span></code></td>
<td>If <code><span class="hljs-literal">true</span></code>, panning won't fire <code>movestart</code> event on start (used internally for panning inertia).</td>
</tr>
</table>
<h3 id="map-zoomoptions">Zoom options</h3>
<table data-id='map'>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>animate</b></code></td>
<td><code>Boolean</code></td>
<td><code>-</code></td>
<td>If not specified, zoom animation will happen if the zoom origin is inside the current view. If <code><span class="hljs-literal">true</span></code>, the map will attempt animating zoom disregarding where zoom origin is. Setting <code><span class="hljs-literal">false</span></code> will make it always reset the view completely without animation.</td>
</tr>
</table>
<h3 id="map-fitboundsoptions">fitBounds options</h3>
<p>The same as <a href="#map-zoompanoptions">zoom/pan options</a> and additionally:</p>
<table data-id='map'>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>paddingTopLeft</b></code></td>
<td><code><a href="#point">Point</a></code></td>
<td><code><nobr>[<span class="hljs-number">0</span>, <span class="hljs-number">0</span>]</nobr>
<td>Sets the amount of padding in the top left corner of a map container that shouldn't be accounted for when setting the view to fit bounds. Useful if you have some control overlays on the map like a sidebar and you don't want them to obscure objects you're zooming to.</td>
</tr>
<tr>
<td><code><b>paddingBottomRight</b></code></td>
<td><code><a href="#point">Point</a></code></td>
<td><code><nobr>[<span class="hljs-number">0</span>, <span class="hljs-number">0</span>]</nobr>
<td>The same for bottom right corner of the map.</td>
</tr>
<tr>
<td><code><b>padding</b></code></td>
<td><code><a href="#point">Point</a></code></td>
<td><code><nobr>[<span class="hljs-number">0</span>, <span class="hljs-number">0</span>]</nobr>
<td>Equivalent of setting both top left and bottom right padding to the same value.</td>
</tr>
<tr>
<td><code><b>maxZoom</b></code></td>
<td><code>Number</code></td>
<td><code><nobr><span class="hljs-literal">null</span></nobr></code></td>
<td>The maximum possible zoom to use.</td>
</tr>
</table>
<h3 id="map-properties">Properties</h3>
<p>Map properties include interaction handlers that allow you to control interaction behavior in runtime, enabling or disabling certain features such as dragging or touch zoom (see <a href="#ihandler">IHandler</a> methods). Example:</p>
<pre><code class="javascript">map.doubleClickZoom.disable();</code></pre>
<p>You can also access default map controls like attribution control through map properties:</p>
<pre><code class="javascript">map.attributionControl.addAttribution("Earthquake data &copy; GeoNames");</code></pre>
<table data-id='map'>
<tr>
<th class="minwidth">Property</th>
<th class="minwidth">Type</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>dragging</b></code></td>
<td><a href="#ihandler"><code>IHandler</code></a></td>
<td>Map dragging handler (by both mouse and touch).</td>
</tr>
<tr>
<td><code><b>touchZoom</b></code></td>
<td><a href="#ihandler"><code>IHandler</code></a></td>
<td>Touch zoom handler.</td>
</tr>
<tr>
<td><code><b>doubleClickZoom</b></code></td>
<td><a href="#ihandler"><code>IHandler</code></a></td>
<td>Double click zoom handler.</td>
</tr>
<tr>
<td><code><b>scrollWheelZoom</b></code></td>
<td><a href="#ihandler"><code>IHandler</code></a></td>
<td>Scroll wheel zoom handler.</td>
</tr>
<tr>
<td><code><b>boxZoom</b></code></td>
<td><a href="#ihandler"><code>IHandler</code></a></td>
<td>Box (shift-drag with mouse) zoom handler.</td>
</tr>
<tr>
<td><code><b>keyboard</b></code></td>
<td><a href="#ihandler"><code>IHandler</code></a></td>
<td>Keyboard navigation handler.</td>
</tr>
<tr>
<td><code><b>tap</b></code></td>
<td><a href="#ihandler"><code>IHandler</code></a></td>
<td>Mobile touch hacks (quick tap and touch hold) handler.</td>
</tr>
<tr>
<td><code><b>zoomControl</b></code></td>
<td><a href="#control-zoom"><code>Control.Zoom</code></a></td>
<td>Zoom control.</td>
</tr>
<tr>
<td><code><b>attributionControl</b></code></td>
<td><a href="#control-attribution"><code>Control.Attribution</code></a></td>
<td>Attribution control.</td>
</tr>
</table>
<h3 id="map-panes">Map Panes</h3>
<p>An object literal (returned by <a href="#map-getpanes">map.getPanes</a></code>) that contains different map panes that you can use to put your custom overlays in. The difference is mostly in zIndex order that such overlays get.</p>
<table data-id='map'>
<tr>
<th class="width100">Property</th>
<th class="width100">Type</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>mapPane</b></code></td>
<td><code>HTMLElement</code></td>
<td>Pane that contains all other map panes.</td>
</tr>
<tr>
<td><code><b>tilePane</b></code></td>
<td><code>HTMLElement</code></td>
<td>Pane for tile layers.</td>
</tr>
<tr>
<td><code><b>objectsPane</b></code></td>
<td><code>HTMLElement</code></td>
<td>Pane that contains all the panes except tile pane.</td>
</tr>
<tr>
<td><code><b>shadowPane</b></code></td>
<td><code>HTMLElement</code></td>
<td>Pane for overlay shadows (e.g. marker shadows).</td>
</tr>
<tr>
<td><code><b>overlayPane</b></code></td>
<td><code>HTMLElement</code></td>
<td>Pane for overlays like polylines and polygons.</td>
</tr>
<tr>
<td><code><b>markerPane</b></code></td>
<td><code>HTMLElement</code></td>
<td>Pane for marker icons.</td>
</tr>
<tr>
<td><code><b>popupPane</b></code></td>
<td><code>HTMLElement</code></td>
<td>Pane for popups.</td>
</tr>
</table>
<h2 id="marker">Marker</h2>
<p>Used to put markers on the map.</p>
<pre><code class="javascript">L.marker([50.5, 30.5]).addTo(map);</code></pre>
<h3>Creation</h3>
<table data-id='marker'>
<tr>
<th class="width200">Factory</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>L.marker</b>(
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i>,</nobr>
<nobr><<a href="#marker-options">Marker options</a>> <i>options?</i> )</nobr>
</code></td>
<td>Instantiates a Marker object given a geographical point and optionally an options object.</td>
</tr>
</table>
<h3 id="marker-options">Options</h3>
<table data-id='marker'>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>icon</b></code></td>
<td><code><a href="#icon">L.Icon</a></code></td>
<td>*</td>
<td>Icon class to use for rendering the marker. See <a href="#icon">Icon documentation</a> for details on how to customize the marker icon. Set to <code>new L.Icon.Default()</code> by default.</td>
</tr>
<tr>
<td><code><b>clickable</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code></td>
<td>If <code><span class="hljs-literal">false</span></code>, the marker will not emit mouse events and will act as a part of the underlying map.</td>
</tr>
<tr>
<td><code><b>draggable</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">false</span></code></td>
<td>Whether the marker is draggable with mouse/touch or not.</td>
</tr>
<tr>
<td><code><b>keyboard</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code></td>
<td>Whether the marker can be tabbed to with a keyboard and clicked by pressing enter.</td>
</tr>
<tr>
<td><code><b>title</b></code></td>
<td><code>String</code></td>
<td><code><span class="hljs-string">''</span></code></td>
<td>Text for the browser tooltip that appear on marker hover (no tooltip by default).</td>
</tr>
<tr>
<td><code><b>alt</b></code></td>
<td><code>String</code></td>
<td><code><span class="hljs-string">''</span></code></td>
<td>Text for the <code>alt</code> attribute of the icon image (useful for accessibility).</td>
</tr>
<tr id="marker-zindexoffset">
<td><code><b>zIndexOffset</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-number">0</span></code></td>
<td>By default, zIndex for the marker image is set automatically based on its latitude. Use this option if you want to put the marker on top of all others (or below), specifying a high value like <code>1000</code> (or high negative value, respectively).</td>
</tr>
<tr>
<td><code><b>opacity</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-number">1.0</span></code></td>
<td>The opacity of the marker.</td>
</tr>
<tr>
<td><code><b>riseOnHover</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">false</span></code></td>
<td>If <code><span class="hljs-literal">true</span></code>, the marker will get on top of others when you hover the mouse over it.</td>
</tr>
<tr>
<td><code><b>riseOffset</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-number">250</span></code></td>
<td>The z-index offset used for the <code>riseOnHover</code> feature.</td>
</tr>
</table>
<h3>Events</h3>
<p>You can subscribe to the following events using <a href="#events">these methods</a>.</p>
<table data-id='marker'>
<tr>
<th class="width100">Event</th>
<th class="width100">Data</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>click</b></code></td>
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
<td>Fired when the user clicks (or taps) the marker.</td>
</tr>
<tr>
<td><code><b>dblclick</b></code></td>
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
<td>Fired when the user double-clicks (or double-taps) the marker.</td>
</tr>
<tr>
<td><code><b>mousedown</b></code></td>
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
<td>Fired when the user pushes the mouse button on the marker.</td>
</tr>
<tr>
<td><code><b>mouseover</b></code></td>
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
<td>Fired when the mouse enters the marker.</td>
</tr>
<tr>
<td><code><b>mouseout</b></code></td>
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
<td>Fired when the mouse leaves the marker.</td>
</tr>
<tr>
<td><code><b>contextmenu</b></code></td>
<td><code><a href="#mouse-event">MouseEvent</a></code>
<td>Fired when the user right-clicks on the marker.</td>
</tr>
<tr>
<td><code><b>dragstart</b></code></td>
<td><code><a href="#event">Event</a></code></td>
<td>Fired when the user starts dragging the marker.</td>
</tr>
<tr>
<td><code><b>drag</b></code></td>
<td><code><a href="#event">Event</a></code></td>
<td>Fired repeatedly while the user drags the marker.</td>
</tr>
<tr>
<td><code><b>dragend</b></code></td>
<td><code><a href="#dragend-event">DragEndEvent</a></code></td>
<td>Fired when the user stops dragging the marker.</td>
</tr>
<tr>
<td><code><b>move</b></code></td>
<td><code><a href="#event">Event</a></code></td>
<td>Fired when the marker is moved via setLatLng. New coordinate include in event arguments.</td>
</tr>
<tr>
<td><code><b>add</b></code></td>
<td><code><a href="#event">Event</a></code></td>
<td>Fired when the marker is added to the map.</td>
</tr>
<tr>
<td><code><b>remove</b></code></td>
<td><code><a href="#event">Event</a></code></td>
<td>Fired when the marker is removed from the map.</td>
</tr>
<tr>
<td><code><b>popupopen</b></code></td>
<td><code><a href="#popup-event">PopupEvent</a></code></td>
<td>Fired when a popup bound to the marker is open.</td>
</tr>
<tr>
<td><code><b>popupclose</b></code></td>
<td><code><a href="#popup-event">PopupEvent</a></code></td>
<td>Fired when a popup bound to the marker is closed.</td>
</tr>
</table>
<h3>Methods</h3>
<table data-id='marker'>
<tr>
<th class="width250">Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>addTo</b>(
<nobr><<a href="#map-class">Map</a>> <i>map</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Adds the marker to the map.</td>
</tr>
<tr>
<td><code><b>getLatLng</b>()</code></td>
<td><code><a href="#latlng">LatLng</a></code></td>
<td>Returns the current geographical position of the marker.</td>
</tr>
<tr>
<td><code><b>setLatLng</b>(
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Changes the marker position to the given point.</td>
</tr>
<tr>
<td><code><b>setIcon</b>(
<nobr><<a href="#icon">Icon</a>> <i>icon</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Changes the marker icon.</td>
</tr>
<tr>
<td><code><b>setZIndexOffset</b>(
<nobr><Number> <i>offset</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Changes the <a href="#marker-zindexoffset">zIndex offset</a> of the marker.</td>
</tr>
<tr>
<td><code><b>setOpacity</b>(
<nobr><Number> <i>opacity</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Changes the opacity of the marker.</td>
</tr>
<tr>
<td><code><b>update</b>()</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Updates the marker position, useful if coordinates of its <code>latLng</code> object were changed directly.</td>
</tr>
<tr id="marker-bindpopup">
<td><code><b>bindPopup</b>(
<nobr><String> <i>html</i> |</nobr> <nobr><HTMLElement> <i>el</i> |</nobr> <nobr><<a href="#popup">Popup</a>> <i>popup</i>,</nobr>
<nobr><<a href="#popup-options">Popup options</a>> <i>options?</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Binds a popup with a particular HTML content to a click on this marker. You can also open the bound popup with the Marker <a href="#marker-openpopup">openPopup</a> method.</td>
</tr>
<tr id="marker-unbindpopup">
<td><code><b>unbindPopup</b>()</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Unbinds the popup previously bound to the marker with <code>bindPopup</code>.</td>
</tr>
<tr id="marker-openpopup">
<td><code><b>openPopup</b>()</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Opens the popup previously bound by the <a href="#marker-bindpopup">bindPopup</a> method.</td>
</tr>
<tr>
<td><code><b>getPopup</b>()</code></td>
<td><code><a href="#popup">Popup</a></code></td>
<td>Returns the popup previously bound by the <a href="#marker-bindpopup">bindPopup</a> method.</td>
</tr>
<tr id="marker-closepopup">
<td><code><b>closePopup</b>()</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Closes the bound popup of the marker if it's opened.</td>
</tr>
<tr id="marker-togglepopup">
<td><code><b>togglePopup</b>()</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Toggles the popup previously bound by the <a href="#marker-bindpopup">bindPopup</a> method.</td>
</tr>
<tr id="marker-bindpopup">
<td><code><b>setPopupContent</b>(
<nobr><String> <i>html</i> |</nobr> <nobr><HTMLElement> <i>el</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Sets an HTML content of the popup of this marker.</td>
</tr>
<tr id="marker-togeojson">
<td><code><b>toGeoJSON</b>()</code></td>
<td><code>Object</code></td>
<td>Returns a <a href="http://en.wikipedia.org/wiki/GeoJSON">GeoJSON</a> representation of the marker (GeoJSON Point Feature).</td>
</tr>
</table>
<h3 id="marker-interaction-handlers">Interaction handlers</h3>
<p>Interaction handlers are properties of a marker instance that allow you to control interaction behavior in runtime, enabling or disabling certain features such as dragging (see <a href="#ihandler">IHandler</a> methods). Example:</p>
<pre><code class="javascript">marker.dragging.disable();</code></pre>
<table data-id='marker'>
<tr>
<th class="width100">Property</th>
<th class="width100">Type</th>
<th>Description</th>
</tr>
<tr>
<td>dragging</td>
<td><a href="#ihandler"><code>IHandler</code></a></td>
<td>Marker dragging handler (by both mouse and touch).</td>
</tr>
</table>
<h2 id="popup">Popup</h2>
<p>Used to open popups in certain places of the map. Use <a href="#map-openpopup">Map#openPopup</a> to open popups while making sure that only one popup is open at one time (recommended for usability), or use <a href="#map-addlayer">Map#addLayer</a> to open as many as you want.</p>
<h3>Usage example</h3>
<p>If you want to just bind a popup to marker click and then open it, it's really easy:</p>
<pre><code class="javascript">marker.bindPopup(popupContent).openPopup();</code></pre>
<p>Path overlays like polylines also have a <code>bindPopup</code> method. Here's a more complicated way to open a popup on a map:</p>
<pre><code class="javascript">var popup = L.popup()
.setLatLng(latlng)
.setContent('<p>Hello world!<br />This is a nice popup.</p>')
.openOn(map);</code></pre>
<h3>Creation</h3>
<table data-id='popup'>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>L.popup</b>(
<nobr><<a href="#popup-options">Popup options</a>> <i>options?</i>,</nobr>
<nobr><<a href="#ilayer">ILayer</a>> <i>source?</i> )</nobr>
</code></td>
<td>Instantiates a Popup object given an optional options object that describes its appearance and location and an optional source object that is used to tag the popup with a reference to the ILayer to which it refers.</td>
</tr>
</table>
<h3 id="popup-options">Options</h3>
<table data-id='popup'>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>maxWidth</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-number">300</span></code></td>
<td>Max width of the popup.</td>
</tr>
<tr>
<td><code><b>minWidth</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-number">50</span></code></td>
<td>Min width of the popup.</td>
</tr>
<tr>
<td><code><b>maxHeight</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-literal">null</span></code></td>
<td>If set, creates a scrollable container of the given height inside a popup if its content exceeds it.</td>
</tr>
<tr>
<td><code><b>autoPan</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code></td>
<td>Set it to <code><span class="hljs-literal">false</span></code> if you don't want the map to do panning animation to fit the opened popup.</td>
</tr>
<tr>
<td><code><b>keepInView</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">false</span></code></td>
<td>Set it to <code><span class="hljs-literal">true</span></code> if you want to prevent users from panning the popup off of the screen while it is open.</td>
</tr>
<tr>
<td><code><b>closeButton</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code></td>
<td>Controls the presence of a close button in the popup.</td>
</tr>
<tr>
<td><code><b>offset</b></code></td>
<td><code><a href="#point">Point</a></code></td>
<td><code><nobr>Point(<span class="hljs-number">0</span>, <span class="hljs-number">6</span>)</nobr>
</code></td>
<td>The offset of the popup position. Useful to control the anchor of the popup when opening it on some overlays.</td>
</tr>
<tr>
<td><code><b>autoPanPaddingTopLeft</b></code></td>
<td><code><a href="#point">Point</a></code></td>
<td><code><span class="hljs-literal">null</span></code></td>
</code></td>
<td>The margin between the popup and the top left corner of the map view after autopanning was performed.</td>
</tr>
<tr>
<td><code><b>autoPanPaddingBottomRight</b></code></td>
<td><code><a href="#point">Point</a></code></td>
<td><code><span class="hljs-literal">null</span></code></td>
</code></td>
<td>The margin between the popup and the bottom right corner of the map view after autopanning was performed.</td>
</tr>
<tr>
<td><code><b>autoPanPadding</b></code></td>
<td><code><a href="#point">Point</a></code></td>
<td><code><nobr>Point(<span class="hljs-number">5</span>, <span class="hljs-number">5</span>)</nobr>
</code></td>
<td>Equivalent of setting both top left and bottom right autopan padding to the same value.</td>
</tr>
<tr>
<td><code><b>zoomAnimation</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code></td>
<td>Whether to animate the popup on zoom. Disable it if you have problems with Flash content inside popups.</td>
</tr>
<tr>
<td><code><b>closeOnClick</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">null</span></code></td>
<td>Set it to <code><span class="hljs-literal">false</span></code> if you want to override the default behavior of the popup closing when user clicks the map (set globally by the <code>Map</code> <code>closePopupOnClick</code> option).</td>
</tr>
<tr>
<td><code><b>className</b></code></td>
<td><code>String</code></td>
<td><code class="javascript"><span class="hljs-string">''</span></code></td>
<td>A custom class name to assign to the popup.</td>
</tr>
</table>
<h3>Methods</h3>
<table data-id='popup'>
<tr>
<th class="width250">Method</th>
<th class="minwidth">Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>addTo</b>(
<nobr><<a href="#map-class">Map</a>> <i>map</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Adds the popup to the map.</td>
</tr>
<tr>
<td><code><b>openOn</b>(
<nobr><<a href="#map-class">Map</a>> <i>map</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Adds the popup to the map and closes the previous one. The same as <code>map.openPopup(popup)</code>.</td>
</tr>
<tr>
<td><code><b>setLatLng</b>(
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Sets the geographical point where the popup will open.</td>
</tr>
<tr>
<td><code><b>getLatLng</b>()</code></td>
<td><code><a href="#latlng">LatLng</a></code></td>
<td>Returns the geographical point of popup.</td>
</tr>
<tr>
<td><code><b>setContent</b>(
<nobr><String|HTMLElement> <i>htmlContent</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Sets the HTML content of the popup.</td>
</tr>
<tr>
<td><code><b>getContent</b>()</code></td>
<td><code><String|HTMLElement></code></td>
<td>Returns the content of the popup.</td>
</tr>
<tr>
<td><code><b>update</b>()</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Updates the popup content, layout and position. Useful for updating the popup after something inside changed, e.g. image loaded.</td>
</tr>
</table>
<h2 id="tilelayer">TileLayer</h2>
<p>Used to load and display tile layers on the map, implements <a href="#ilayer">ILayer</a> interface.</p>
<h3>Usage example</h3>
<pre><code class="javascript">L.tileLayer('https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png?{foo}', {foo: 'bar'}).addTo(map);</code></pre>
<h3>Creation</h3>
<table data-id='tilelayer'>
<tr>
<th class="width250">Factory</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>L.tileLayer</b>(
<nobr><String> <i><a href="#url-template">urlTemplate</a></i>,</nobr>
<nobr><<a href="#tilelayer-options">TileLayer options</a>> <i>options?</i> )</nobr>
</code></td>
<td>Instantiates a tile layer object given a <a href="#url-template">URL template</a> and optionally an options object.</td>
</tr>
</table>
<h3 id="url-template">URL template</h3>
<p>A string of the following form:</p>
<pre><code class="javascript">'http://{s}.somedomain.com/blabla/{z}/{x}/{y}.png'</code></pre>
<p><code>{s}</code> means one of the available subdomains (used sequentially to help with browser parallel requests per domain limitation; subdomain values are specified in options; <code>a</code>, <code>b</code> or <code>c</code> by default, can be omitted), <code>{z}</code> — zoom level, <code>{x}</code> and <code>{y}</code> — tile coordinates.</p>
<p>You can use custom keys in the template, which will be <a href="#util-template">evaluated</a> from TileLayer options, like this:</p>
<pre><code class="javascript">L.tileLayer('http://{s}.somedomain.com/{foo}/{z}/{x}/{y}.png', {foo: 'bar'});</code></pre>
<h3 id="tilelayer-options">Options</h3>
<table data-id='tilelayer'>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>minZoom</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-number">0</span></code></td>
<td>Minimum zoom number.</td>
</tr>
<tr>
<td><code><b>maxZoom</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-number">18</span></code></td>
<td>Maximum zoom number.</td>
</tr>
<tr>
<td><code><b>maxNativeZoom</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-literal">null</span></code></td>
<td>Maximum zoom number the tiles source has available. If it is specified, the tiles on all zoom levels higher than <code>maxNativeZoom</code> will be loaded from <code>maxNativeZoom</code> level and auto-scaled.</td>
</tr>
<tr>
<td><code><b>tileSize</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-number">256</span></code></td>
<td>Tile size (width and height in pixels, assuming tiles are square).</td>
</tr>
<tr>
<td><code><b>subdomains</b></code></td>
<td><code>String</code> or <code>String[]</code></td>
<td><code><span class="hljs-string">'abc'</span></code></td>
<td>Subdomains of the tile service. Can be passed in the form of one string (where each letter is a subdomain name) or an array of strings.</td>
</tr>
<tr>
<td><code><b>errorTileUrl</b></code></td>
<td><code>String</code></td>
<td><code><span class="hljs-string">''</span></code></td>
<td>URL to the tile image to show in place of the tile that failed to load.</td>
</tr>
<tr>
<td><code><b>attribution</b></code></td>
<td><code>String</code></td>
<td><code><span class="hljs-string">''</span></code></td>
<td>e.g. "© Mapbox" — the string used by the attribution control, describes the layer data.</td>
</tr>
<tr>
<td><code><b>tms</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">false</span></code></td>
<td>If <code><span class="hljs-literal">true</span></code>, inverses Y axis numbering for tiles (turn this on for TMS services).</td>
</tr>
<tr>
<td><code><b>continuousWorld</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">false</span></code></td>
<td>If set to <code><span class="hljs-literal">true</span></code>, the tile coordinates won't be wrapped by world width (-180 to 180 longitude) or clamped to lie within world height (-90 to 90). Use this if you use Leaflet for maps that don't reflect the real world (e.g. game, indoor or photo maps).</td>
</tr>
<tr>
<td><code><b>noWrap</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">false</span></code></td>
<td>If set to <code><span class="hljs-literal">true</span></code>, the tiles just won't load outside the world width (-180 to 180 longitude) instead of repeating.</td>
</tr>
<tr>
<td><code><b>zoomOffset</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-number">0</span></code></td>
<td>The zoom number used in tile URLs will be offset with this value.</td>
</tr>
<tr>
<td><code><b>zoomReverse</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">false</span></code></td>
<td>If set to <code><span class="hljs-literal">true</span></code>, the zoom number used in tile URLs will be reversed (<code>maxZoom - zoom</code> instead of <code>zoom</code>).</td>
</tr>
<tr>
<td><code><b>opacity</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-number">1.0</span></code></td>
<td>The opacity of the tile layer.</td>
</tr>
<tr>
<td><code><b>zIndex</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-literal">null</span></code></td>
<td>The explicit zIndex of the tile layer. Not set by default.</td>
</tr>
<tr>
<td><code><b>unloadInvisibleTiles</b></code></td>
<td><code>Boolean</code></td>
<td>depends</td>
<td>If <code><span class="hljs-literal">true</span></code>, all the tiles that are not visible after panning are removed (for better performance). <code><span class="hljs-literal">true</span></code> by default on mobile WebKit, otherwise <code><span class="hljs-literal">false</span></code>.</td>
</tr>
<tr>
<td><code><b>updateWhenIdle</b></code></td>
<td><code>Boolean</code></td>
<td>depends</td>
<td>If <code><span class="hljs-literal">false</span></code>, new tiles are loaded during panning, otherwise only after it (for better performance). <code><span class="hljs-literal">true</span></code> by default on mobile WebKit, otherwise <code><span class="hljs-literal">false</span></code>.</td>
</tr>
<tr>
<td><code><b>detectRetina</b></code></td>
<td><code><code>Boolean</code></code></td>
<td><code><span class="hljs-literal">false</span></code></td>
<td>If <code><span class="hljs-literal">true</span></code> and user is on a retina display, it will request four tiles of half the specified size and a bigger zoom level in place of one to utilize the high resolution.</td>
</tr>
<tr>
<td><code><b>reuseTiles</b></code></td>
<td><code><code>Boolean</code></code></td>
<td><code><span class="hljs-literal">false</span></code></td>
<td>If <code><span class="hljs-literal">true</span></code>, all the tiles that are not visible after panning are placed in a reuse queue from which they will be fetched when new tiles become visible (as opposed to dynamically creating new ones). This will in theory keep memory usage low and eliminate the need for reserving new memory whenever a new tile is needed.</td>
</tr>
<tr>
<td><code><b>bounds</b></code></td>
<td><code><a href="#latlngbounds">LatLngBounds</a></code></td>
<td><code><span class="hljs-literal">null</span></code></td>
<td>When this option is set, the TileLayer only loads tiles that are in the given geographical bounds.</td>
</tr>
</table>
<h3>Events</h3>
<p>You can subscribe to the following events using <a href="#events">these methods</a>.</p>
<table data-id='tilelayer'>
<tr>
<th class="width100">Event</th>
<th class="width100">Data</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>loading</b></code></td>
<td><code><a href="#event">Event</a></code></td>
<td>Fired when the tile layer starts loading tiles.</td>
</tr>
<tr>
<td><code><b>load</b></code></td>
<td><code><a href="#event">Event</a></code></td>
<td>Fired when the tile layer loaded all visible tiles.</td>
</tr>
<tr>
<td><code><b>tileloadstart</b></code></td>
<td><code><a href="#tile-event">TileEvent</a></code></td>
<td>Fired when a tile is requested and starts loading.</td>
</tr>
<tr>
<td><code><b>tileload</b></code></td>
<td><code><a href="#tile-event">TileEvent</a></code></td>
<td>Fired when a tile loads.</td>
</tr>
<tr>
<td><code><b>tileunload</b></code></td>
<td><code><a href="#tile-event">TileEvent</a></code></td>
<td>Fired when a tile is removed (e.g. when you have <code>unloadInvisibleTiles</code> on).</td>
</tr>
<tr>
<td><code><b>tileerror</b></code></td>
<td><code><a href="#tileerror-event">TileEvent</a></code></td>
<td>Fired when there is an error loading a tile.</td>
</tr>
</table>
<h3>Methods</h3>
<table data-id='tilelayer'>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>addTo</b>(
<nobr><<a href="#map-class">Map</a>> <i>map</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Adds the layer to the map.</td>
</tr>
<tr>
<td><code><b>bringToFront</b>()</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Brings the tile layer to the top of all tile layers.</td>
</tr>
<tr>
<td><code><b>bringToBack</b>()</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Brings the tile layer to the bottom of all tile layers.</td>
</tr>
<tr>
<td><code><b>setOpacity</b>(
<nobr><Number> <i>opacity</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Changes the opacity of the tile layer.</td>
</tr>
<tr>
<td><code><b>setZIndex</b>(
<nobr><Number> <i>zIndex</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Sets the zIndex of the tile layer.</td>
</tr>
<tr>
<td><code><b>redraw</b>()</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Causes the layer to clear all the tiles and request them again.</td>
</tr>
<tr>
<td><code><b>setUrl</b>(
<nobr><String> <i><a href="#url-template">urlTemplate</a></i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Updates the layer's URL template and redraws it.</td>
</tr>
<tr>
<td><code><b>getContainer</b>()</nobr>
</code></td>
<td><code>HTMLElement</code></td>
<td>Returns the HTML element that contains the tiles for this layer.</td>
</tr>
</table>
<h2 id="tilelayer-wms">TileLayer.WMS</h2>
<p>Used to display WMS services as tile layers on the map. Extends <a href="#tilelayer">TileLayer</a>.</p>
<h3>Usage example</h3>
<pre><code class="javascript">var nexrad = L.tileLayer.wms("http://mesonet.agron.iastate.edu/cgi-bin/wms/nexrad/n0r.cgi", {
layers: 'nexrad-n0r-900913',
format: 'image/png',
transparent: true,
attribution: "Weather data © 2012 IEM Nexrad"
});</code></pre>
<h3>Creation</h3>
<table data-id='tilelayer-wms'>
<tr>
<th class="width250">Factory</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>L.tileLayer.wms</b>(
<nobr><String> <i>baseUrl</i></nobr>,
<nobr><<a href="#tilelayer-wms-options">TileLayer.WMS options</a>> <i>options</i> )</nobr>
<td>Instantiates a WMS tile layer object given a base URL of the WMS service and a WMS parameters/options object.</td>
</tr>
</table>
<h3 id="tilelayer-wms-options">Options</h3>
<p>Includes all <a href="#tilelayer-options">TileLayer options</a> and additionally:</p>
<table data-id='tilelayer-wms'>
<tr>
<th class="width100">Option</th>
<th class="width100">Type</th>
<th class="width100">Default</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>layers</b></code></td>
<td><code>String</code></td>
<td><code><span class="hljs-string">''</span></code></td>
<td><b>(required)</b> Comma-separated list of WMS layers to show.</td>
</tr>
<tr>
<td><code><b>styles</b></code></td>
<td><code>String</code></td>
<td><code><span class="hljs-string">''</span></code></td>
<td>Comma-separated list of WMS styles.</td>
</tr>
<tr>
<td><code><b>format</b></code></td>
<td><code>String</code></td>
<td><code><span class="hljs-string">'image/jpeg'</span></code></td>
<td>WMS image format (use <code><span class="hljs-string">'image/png'</span></code> for layers with transparency).</td>
</tr>
<tr>
<td><code><b>transparent</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">false</span></code></td>
<td>If <code><span class="hljs-literal">true</span></code>, the WMS service will return images with transparency.</td>
</tr>
<tr>
<td><code><b>version</b></code></td>
<td><code>String</code></td>
<td><code><span class="hljs-string">'1.1.1'</span></code></td>
<td>Version of the WMS service to use.</td>
</tr>
<tr>
<td><code><b>crs</b></code></td>
<td><code><a href="#icrs">CRS</a></code></td>
<td><code><span class="hljs-literal">null</span></code></td>
<td>Coordinate Reference System to use for the WMS requests, defaults to map CRS. Don't change this if you're not sure what it means.</td>
</tr>
</table>
<h3>Methods</h3>
<table data-id='tilelayer-wms'>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>setParams</b>(
<nobr><<a href="#tilelayer-wms-options">WMS parameters</a>> <i>params</i></nobr>,
<nobr><Boolean> <i>noRedraw?</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Merges an object with the new parameters and re-requests tiles on the current screen (unless <code>noRedraw</code> was set to <code><span class="hljs-literal">true</span></code>).</td>
</tr>
</table>
<h2 id="tilelayer-canvas">TileLayer.Canvas</h2>
<p>Used to create Canvas-based tile layers where tiles get drawn on the browser side. Extends <a href="#tilelayer">TileLayer</a>.</p>
<h3>Usage example</h3>
<pre><code class="javascript">var canvasTiles = L.tileLayer.canvas();
canvasTiles.drawTile = function(canvas, tilePoint, zoom) {
var ctx = canvas.getContext('2d');
// draw something on the tile canvas
}</code></pre>
<h3>Creation</h3>
<table data-id='tilelayer-canvas'>
<tr>
<th class="width200">Factory</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>L.tileLayer.canvas</b>(
<nobr><<a href="#tilelayer-options">TileLayer options</a>> <i>options?</i> )</nobr>
</code></td>
<td>Instantiates a Canvas tile layer object given an options object (optionally).</td>
</tr>
</table>
<h3>Options</h3>
<table data-id='tilelayer-canvas'>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>async</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">false</span></code></td>
<td>Indicates that tiles will be drawn asynchronously. <a href="#tilelayer-canvas-tiledrawn">tileDrawn</a> method should be called for each tile after drawing completion.</td>
</tr>
</table>
<h3>Methods</h3>
<table data-id='tilelayer-canvas'>
<tr>
<th class="width200">Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr id = "tilelayer-canvas-drawtile">
<td><code><b>drawTile</b>(
<nobr><HTMLCanvasElement> <i>canvas</i></nobr>,
<nobr><<a href="#point">Point</a>> <i>tilePoint</i></nobr>,
<nobr><Number> <i>zoom</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>You need to define this method after creating the instance to draw tiles; <code>canvas</code> is the actual canvas tile on which you can draw, <code>tilePoint</code> represents the tile numbers, and <code>zoom</code> is the current zoom.</td>
</tr>
<tr id="tilelayer-canvas-tiledrawn">
<td><code><b>tileDrawn</b>( <nobr><HTMLCanvasElement> <i>canvas</i></nobr> )</code></td>
<td>-</td>
<td>If <code>async</code> option is defined, this function should be called for each tile after drawing completion. <code>canvas</code> is the same canvas element, that was passed to <a href="#tilelayer-canvas-drawtile">drawTile</a>.</td>
</tr>
</table>
<h2 id="imageoverlay">ImageOverlay</h2>
<p>Used to load and display a single image over specific bounds of the map, implements <a href="#ilayer">ILayer</a> interface.</p>
<h3>Usage example</h3>
<pre><code class="javascript">var imageUrl = 'http://www.lib.utexas.edu/maps/historical/newark_nj_1922.jpg',
imageBounds = [[40.712216, -74.22655], [40.773941, -74.12544]];
L.imageOverlay(imageUrl, imageBounds).addTo(map);</code></pre>
<h3>Creation</h3>
<table data-id='imageoverlay'>
<tr>
<th class="width250">Factory</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>L.ImageOverlay</b>(
<nobr><String> <i>imageUrl</i></nobr>,
<nobr><<a href="#latlngbounds">LatLngBounds</a>> <i>bounds</i></nobr>,
<nobr><<a href="#imageoverlay-options">ImageOverlay options</a>> <i>options?</i> )</nobr>
</code></td>
<td>Instantiates an image overlay object given the URL of the image and the geographical bounds it is tied to.</td>
</tr>
</table>
<h3 id="imageoverlay-options">Options</h3>
<table data-id='imageoverlay'>
<tr>
<th>Option</th>
<th>Type</th>
<th class="minwidth">Default</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>opacity</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-number">1.0</span></code></td>
<td>The opacity of the image overlay.</td>
</tr>
<tr>
<td><code><b>attribution</b></code></td>
<td><code>String</code></td>
<td><code><span class="hljs-string">''</span></code></td>
<td>The attribution text of the image overlay.</td>
</tr>
</table>
<h3 id="imageoverlay-methods">Methods</h3>
<table data-id='imageoverlay'>
<tr>
<th class="width250">Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>addTo</b>(
<nobr><<a href="#map-class">Map</a>> <i>map</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Adds the overlay to the map.</td>
</tr>
<tr>
<td><code><b>setOpacity</b>(
<nobr><Number> <i>opacity</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Sets the opacity of the overlay.</td>
</tr>
<tr>
<td><code><b>setUrl</b>(
<nobr><String> <i>imageUrl</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Changes the URL of the image.</td>
</tr>
<tr>
<td><code><b>bringToFront</b>()</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Brings the layer to the top of all overlays.</td>
</tr>
<tr>
<td><code><b>bringToBack</b>()</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Brings the layer to the bottom of all overlays.</td>
</tr>
</table>
<h2 id="path">Path</h2>
<p>An abstract class that contains options and constants shared between vector overlays (Polygon, Polyline, Circle). Do not use it directly.
<h3 id="path-options">Options</h3>
<table data-id='path'>
<tr>
<th>Option</th>
<th>Type</th>
<th class="minwidth">Default</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>stroke</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code></td>
<td>Whether to draw stroke along the path. Set it to <code><span class="hljs-literal">false</span></code> to disable borders on polygons or circles.</td>
</tr>
<tr>
<td><code><b>color</b></code></td>
<td><code>String</code></td>
<td><code><span class="hljs-string">'#03f'</span></code></td>
<td>Stroke color.</td>
</tr>
<tr>
<td><code><b>weight</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-number">5</span></code></td>
<td>Stroke width in pixels.</td>
</tr>
<tr>
<td><code><b>opacity</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-number">0.5</span></code></td>
<td>Stroke opacity.</td>
</tr>
<tr>
<td><code><b>fill</b></code></td>
<td><code>Boolean</code></td>
<td>depends</td>
<td>Whether to fill the path with color. Set it to <code><span class="hljs-literal">false</span></code> to disable filling on polygons or circles.</td>
</tr>
<tr>
<td><code><b>fillColor</b></code></td>
<td><code>String</code></td>
<td>same as color</td>
<td>Fill color.</td>
</tr>
<tr>
<td><code><b>fillOpacity</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-number">0.2</span></code></td>
<td>Fill opacity.</td>
</tr>
<tr>
<td><code><b>fillRule</b></code></td>
<td><code>String</code></td>
<td><code><span class="hljs-string">'evenodd'</span></code></td>
<td>A string that defines <a href="https://developer.mozilla.org/docs/Web/SVG/Attribute/fill-rule">how the inside of a shape</a> is determined.</td>
</tr>
<tr>
<td><code><b>dashArray</b></code></td>
<td><code>String</code></td>
<td><code><span class="hljs-literal">null</span></code></td>
<td>A string that defines the stroke <a href="https://developer.mozilla.org/en/SVG/Attribute/stroke-dasharray">dash pattern</a>. Doesn't work on canvas-powered layers (e.g. Android 2).</td>
</tr>
<tr>
<td><code><b>lineCap</b></code></td>
<td><code>String</code></td>
<td><code><span class="hljs-literal">null</span></code></td>
<td>A string that defines <a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linecap">shape to be used at the end</a> of the stroke.</td>
</tr>
<tr>
<td><code><b>lineJoin</b></code></td>
<td><code>String</code></td>
<td><code><span class="hljs-literal">null</span></code></td>
<td>A string that defines <a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linejoin">shape to be used at the corners</a> of the stroke.</td>
</tr>
<tr>
<td><code><b>clickable</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code></td>
<td>If <code><span class="hljs-literal">false</span></code>, the vector will not emit mouse events and will act as a part of the underlying map.</td>
</tr>
<tr>
<td><code><b>pointerEvents</b></code></td>
<td><code>String</code></td>
<td><code><span class="hljs-literal">null</span></code></td>
<td>Sets the <code>pointer-events</code> attribute on the path if SVG backend is used.</td>
</tr>
<tr>
<td><code><b>className</b></code></td>
<td><code>String</code></td>
<td><code><span class="hljs-string">''</span></code></td>
<td>Custom class name set on an element.</td>
</tr>
</table>
<h3>Events</h3>
<p>You can subscribe to the following events using <a href="#events">these methods</a>.</p>
<table data-id='path'>
<tr>
<th class="width100">Event</th>
<th class="width100">Data</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>click</b></code></td>
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
<td>Fired when the user clicks (or taps) the object.</td>
</tr>
<tr>
<td><code><b>dblclick</b></code></td>
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
<td>Fired when the user double-clicks (or double-taps) the object.</td>
</tr>
<tr>
<td><code><b>mousedown</b></code></td>
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
<td>Fired when the user pushes the mouse button on the object.</td>
</tr>
<tr>
<td><code><b>mouseover</b></code></td>
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
<td>Fired when the mouse enters the object.</td>
</tr>
<tr>
<td><code><b>mouseout</b></code></td>
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
<td>Fired when the mouse leaves the object.</td>
</tr>
<tr>
<td><code><b>contextmenu</b></code></td>
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
<td>Fired when the user pushes the right mouse button on the object, prevents default browser context menu from showing if there are listeners on this event.</td>
</tr>
<tr>
<td><code><b>add</b></code></td>
<td><code><a href="#event">Event</a></code>
<td>Fired when the path is added to the map.</td>
</tr>
<tr>
<td><code><b>remove</b></code></td>
<td><code><a href="#event">Event</a></code></td>
<td>Fired when the path is removed from the map.</td>
</tr>
<tr>
<td><code><b>popupopen</b></code></td>
<td><code><a href="#popup-event">PopupEvent</a></code></td>
<td>Fired when a popup bound to the path is open.</td>
</tr>
<tr>
<td><code><b>popupclose</b></code></td>
<td><code><a href="#popup-event">PopupEvent</a></code></td>
<td>Fired when a popup bound to the path is closed.</td>
</tr>
</table>
<h3 id="path-methods">Methods</h3>
<table data-id='path'>
<tr>
<th class="width250">Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>addTo</b>(
<nobr><<a href="#map-class">Map</a>> <i>map</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Adds the layer to the map.</td>
</tr>
<tr id="path-bindpopup">
<td><code><b>bindPopup</b>(
<nobr><String> <i>html</i> |</nobr> <nobr><HTMLElement> <i>el</i> |</nobr> <nobr><<a href="#popup">Popup</a>> <i>popup</i>,</nobr>
<nobr><<a href="#popup-options">Popup options</a>> <i>options?</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Binds a popup with a particular HTML content to a click on this path.</td>
</tr>
<tr>
<td><code><b>bindPopup</b>(
<nobr><<a href="#popup">Popup</a>> <i>popup</i></nobr>,
<nobr><<a href="#popup-options">Popup options</a>> <i>options?</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Binds a given popup object to the path.</td>
</tr>
<tr id="path-unbindpopup">
<td><code><b>unbindPopup</b>()</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Unbinds the popup previously bound to the path with <code>bindPopup</code>.</td>
</tr>
<tr id="path-openpopup">
<td><code><b>openPopup</b>(
<nobr><<a href="#latlng">LatLng</a>> <i>latlng?</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Opens the popup previously bound by the <a href="#path-bindpopup">bindPopup</a> method in the given point, or in one of the path's points if not specified.</td>
</tr>
<tr id="path-closepopup">
<td><code><b>closePopup</b>()</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Closes the path's bound popup if it is opened.</td>
</tr>
<tr id="path-setstyle">
<td><code><b>setStyle</b>(
<nobr><<a href="#path-options">Path options</a>> <i>object</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Changes the appearance of a Path based on the options in the <a href="#path-options">Path options</a> object.</td>
</tr>
<tr id="path-getbounds">
<td><code><b>getBounds</b>()</code></td>
<td><code><a href="#latlngbounds">LatLngBounds</a></code></td>
<td>Returns the LatLngBounds of the path.</td>
</tr>
<tr>
<td><code><b>bringToFront</b>()</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Brings the layer to the top of all path layers.</td>
</tr>
<tr>
<td><code><b>bringToBack</b>()</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Brings the layer to the bottom of all path layers.</td>
</tr>
<tr>
<td><code><b>redraw</b>()</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Redraws the layer. Sometimes useful after you changed the coordinates that the path uses.</td>
</tr>
</table>
<h3>Static properties</h3>
<table data-id='path'>
<tr>
<th>Constant</th>
<th>Type</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td><code>SVG</code></td>
<td><code>Boolean</code></td>
<td>depends</td>
<td>True if SVG is used for vector rendering (true for most modern browsers).</td>
</tr>
<tr>
<td><code>VML</code></td>
<td><code>Boolean</code></td>
<td>depends</td>
<td>True if VML is used for vector rendering (IE 6-8).</td>
</tr>
<tr>
<td><code>CANVAS</code></td>
<td><code>Boolean</code></td>
<td>depends</td>
<td>True if Canvas is used for vector rendering (Android 2). You can also force this by setting global variable <code>L_PREFER_CANVAS</code> to <code><span class="hljs-literal">true</span></code> <em>before</em> the Leaflet include on your page — sometimes it can increase performance dramatically when rendering thousands of circle markers, but currently suffers from a bug that causes removing such layers to be extremely slow.</td>
</tr>
<tr>
<td><code>CLIP_PADDING</code></td>
<td><code>Number</code></td>
<td><nobr><code><span class="hljs-number">0.5</span></code> for SVG</nobr><br /><nobr><code><span class="hljs-number">0.02</span></code> for VML</nobr></td>
<td>How much to extend the clip area around the map view (relative to its size, e.g. 0.5 is half the screen in each direction). Smaller values mean that you will see clipped ends of paths while you're dragging the map, and bigger values decrease drawing performance.</td>
</tr>
</table>
<h2 id="polyline">Polyline</h2>
<p>A class for drawing polyline overlays on a map. Extends <a href="#path">Path</a>. Use <a href="#map-addlayer">Map#addLayer</a> to add it to the map.</p>
<h3>Usage example</h3>
<pre><code class="javascript">// create a red polyline from an array of LatLng points
var polyline = L.polyline(latlngs, {color: 'red'}).addTo(map);
// zoom the map to the polyline
map.fitBounds(polyline.getBounds());</code></pre>
<h3>Creation</h3>
<table data-id='polyline'>
<tr>
<th class="width250">Factory</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>L.polyline</b>(
<nobr><<a href="#latlng">LatLng</a>[]> <i>latlngs</i></nobr>,
<nobr><<a href="#polyline-options">Polyline options</a>> <i>options?</i> )</nobr>
</code></td>
<td>Instantiates a polyline object given an array of geographical points and optionally an options object.</td>
</tr>
</table>
<h3 id="polyline-options">Options</h3>
<p>You can use <a href="#path-options">Path options</a> and additionally the following options:</p>
<table data-id='polyline'>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>smoothFactor</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-number">1.0</span></code></td>
<td>How much to simplify the polyline on each zoom level. More means better performance and smoother look, and less means more accurate representation.</td>
</tr>
<tr>
<td><code><b>noClip</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">false</span></code></td>
<td>Disabled polyline clipping.</td>
</tr>
</table>
<h3>Methods</h3>
<p>You can use <a href="#path-methods">Path methods</a> and additionally the following methods:</p>
<table data-id='polyline'>
<tr>
<th class="width250">Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>addLatLng</b>(
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Adds a given point to the polyline.</td>
</tr>
<tr>
<td><code><b>setLatLngs</b>(
<nobr><<a href="#latlng">LatLng</a>[]> <i>latlngs</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Replaces all the points in the polyline with the given array of geographical points.</td>
</tr>
<tr>
<td><code><b>getLatLngs</b>()</code></td>
<td><code><a href="#latlng">LatLng</a>[]</code></td>
<td>Returns an array of the points in the path.</td>
</tr>
<tr>
<td><code><b>spliceLatLngs</b>(
<nobr><Number> <i>index</i></nobr>,
<nobr><Number> <i>pointsToRemove</i></nobr>,
<nobr><<a href="#latlng">LatLng</a>> <i>latlng?</i>, … )</nobr>
</code></td>
<td><code><a href="#latlng">LatLng</a>[]</code></td>
<td>Allows adding, removing or replacing points in the polyline. Syntax is the same as in <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array/splice">Array#splice</a>. Returns the array of removed points (if any).</td>
</tr>
<tr id="path-getbounds">
<td><code><b>getBounds</b>()</code></td>
<td><code><a href="#latlngbounds">LatLngBounds</a></code></td>
<td>Returns the LatLngBounds of the polyline.</td>
</tr>
<tr id="polyline-togeojson">
<td><code><b>toGeoJSON</b>()</code></td>
<td><code>Object</code></td>
<td>Returns a <a href="http://en.wikipedia.org/wiki/GeoJSON">GeoJSON</a> representation of the polyline (GeoJSON LineString Feature).</td>
</tr>
</table>
<h2 id="multipolyline">MultiPolyline</h2>
<p>Extends <a href="#featuregroup">FeatureGroup</a> to allow creating multi-polylines (single layer that consists of several polylines that share styling/popup).</p>
<h3>Creation</h3>
<table data-id='multipolyline'>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>L.multiPolyline</b>(
<nobr><<a href="#latlng">LatLng</a>[][]> <i>latlngs</i></nobr>,
<nobr><<a href="#polyline-options">Polyline options</a>> <i>options?</i> )</nobr>
</code></td>
<td>Instantiates a multi-polyline object given an array of arrays of geographical points (one for each individual polyline) and optionally an options object.</td>
</tr>
</table>
<h3>Methods</h3>
<p>MultiPolylines accept all <a href="#polyline">Polyline methods</a> but
have different behavior around their coordinate contents since they can contain
multiple line features:</p>
<table data-id='multipolyline'>
<tr>
<th class="width250">Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>setLatLngs</b>(
<nobr><<a href="#latlng">LatLng</a>[][]> <i>latlngs</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Replace all lines and their paths with the given array of arrays of
geographical points.</td>
</tr>
<tr>
<td><code><b>getLatLngs</b>()</td>
<td><code><nobr><<a href="#latlng">LatLng</a>[][]> <i>latlngs</i></nobr>
</code></td>
<td>Returns an array of arrays of geographical points in each line.</td>
</tr>
<tr>
<td><code><b>openPopup</b>()</td>
<td><code>this</code></td>
<td>Opens the popup previously bound by <a href="#path-bindpopup">bindPopup</a>.</td>
</tr>
<tr id="multipolyline-togeojson">
<td><code><b>toGeoJSON</b>()</code></td>
<td><code>Object</code></td>
<td>Returns a <a href="http://en.wikipedia.org/wiki/GeoJSON">GeoJSON</a> representation of the multipolyline (GeoJSON MultiLineString Feature).</td>
</tr>
</table>
<h2 id="polygon">Polygon</h2>
<p>A class for drawing polygon overlays on a map. Extends <a href="#polyline">Polyline</a>. Use <a href="#map-addlayer">Map#addLayer</a> to add it to the map.</p>
<p>Note that points you pass when creating a polygon shouldn't have an additional last point equal to the first one — it's better to filter out such points.</p>
<h3>Creation</h3>
<table data-id='polygon'>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>L.polygon</b>(
<nobr><<a href="#latlng">LatLng</a>[]> <i>latlngs</i></nobr>,
<nobr><<a href="#polyline-options">Polyline options</a>> <i>options?</i> )</nobr>
</code></td>
<td>Instantiates a polygon object given an array of geographical points and optionally an options object (the same as for Polyline). You can also create a polygon with holes by passing an array of arrays of latlngs, with the first latlngs array representing the exterior ring while the remaining represent the holes inside.</td>
</tr>
</table>
<h3>Methods</h3>
<p>Polygon has the same options and methods as Polyline, with the following differences:</p>
<table data-id='polygon'>
<tr>
<th class="width250">Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr id="polygon-togeojson">
<td><code><b>toGeoJSON</b>()</code></td>
<td><code>Object</code></td>
<td>Returns a <a href="http://en.wikipedia.org/wiki/GeoJSON">GeoJSON</a> representation of the polygon (GeoJSON Polygon Feature).</td>
</tr>
</table>
<h2 id="multipolygon">MultiPolygon</h2>
<p>Extends <a href="#featuregroup">FeatureGroup</a> to allow creating multi-polygons (single layer that consists of several polygons that share styling/popup).</p>
<h3>Creation</h3>
<table data-id='multipolygon'>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>L.multiPolygon</b>(
<nobr><<a href="#latlng">LatLng</a>[][]> <i>latlngs</i></nobr>,
<nobr><<a href="#polyline-options">Polyline options</a>> <i>options?</i> )</nobr>
</code></td>
<td>Instantiates a multi-polygon object given an array of latlngs arrays (one for each individual polygon) and optionally an options object (the same as for MultiPolyline).</td>
</tr>
</table>
<h3>Methods</h3>
<p>MultiPolygons accept all <a href="#polyline">Polyline methods</a> but
have different behavior around their coordinate contents since they can contain
multiple polygon features:</p>
<table data-id='multipolygon'>
<tr>
<th class="width250">Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>setLatLngs</b>(
<nobr><<a href="#latlng">LatLng</a>[][]> <i>latlngs</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Replace all polygons and their paths with the given array of arrays of
geographical points.</td>
</tr>
<tr>
<td><code><b>getLatLngs</b>()</td>
<td><code><nobr><<a href="#latlng">LatLng</a>[][]> <i>latlngs</i></nobr>
</code></td>
<td>Returns an array of arrays of geographical points in each polygon.</td>
</tr>
<tr>
<td><code><b>openPopup</b>()</td>
<td><code>this</code></td>
<td>Opens the popup previously bound by <a href="#path-bindpopup">bindPopup</a>.</td>
</tr>
<tr id="multipolygon-togeojson">
<td><code><b>toGeoJSON</b>()</code></td>
<td><code>Object</code></td>
<td>Returns a <a href="http://en.wikipedia.org/wiki/GeoJSON">GeoJSON</a> representation of the multipolygon (GeoJSON MultiPolygon Feature).</td>
</tr>
</table>
<h2 id="rectangle">Rectangle</h2>
<p>A class for drawing rectangle overlays on a map. Extends <a href="#polygon">Polygon</a>. Use <a href="#map-addlayer">Map#addLayer</a> to add it to the map.</p>
<h3>Usage example</h3>
<pre><code class="javascript">// define rectangle geographical bounds
var bounds = [[54.559322, -5.767822], [56.1210604, -3.021240]];
// create an orange rectangle
L.rectangle(bounds, {color: "#ff7800", weight: 1}).addTo(map);
// zoom the map to the rectangle bounds
map.fitBounds(bounds);</code></pre>
<h3>Creation</h3>
<table data-id='rectangle'>
<tr>
<th class="width250">Factory</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>L.rectangle</b>(
<nobr><<a href="#latlngbounds">LatLngBounds</a>> <i>bounds</i></nobr>,
<nobr><<a href="#path-options">Path options</a>> <i>options?</i> )</nobr>
</code></td>
<td>Instantiates a rectangle object with the given geographical bounds and optionally an options object.</td>
</tr>
</table>
<h3>Methods</h3>
<p>You can use <a href="#path-methods">Path methods</a> and additionally the following methods:</p>
<table data-id='rectangle'>
<tr>
<th class="width250">Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>setBounds</b>(
<nobr><<a href="#latlngbounds">LatLngBounds</a>> <i>bounds</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Redraws the rectangle with the passed bounds.</td>
</tr>
</table>
<h2 id="circle">Circle</h2>
<p>A class for drawing circle overlays on a map. Extends <a href="#path">Path</a>. Use <a href="#map-addlayer">Map#addLayer</a> to add it to the map.</p>
<pre><code class="javascript">L.circle([50.5, 30.5], 200).addTo(map);</pre></code>
<h3>Creation</h3>
<table data-id='circle'>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>L.circle</b>(
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i></nobr>,
<nobr><Number> <i>radius</i></nobr>,
<nobr><<a href="#path-options">Path options</a>> <i>options?</i> )</nobr>
</code></td>
<td>Instantiates a circle object given a geographical point, a radius in meters and optionally an options object.</td>
</tr>
</table>
<h3>Methods</h3>
<table data-id='circle'>
<tr>
<th class="width200">Method</th>
<th class="minwidth">Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>getLatLng</b>()</code></td>
<td><code><a href="#latlng">LatLng</a></code></td>
<td>Returns the current geographical position of the circle.</td>
</tr>
<tr>
<td><code><b>getRadius</b>()</code></td>
<td><code>Number</code></td>
<td>Returns the current radius of a circle. Units are in meters.</td>
</tr>
<tr>
<td><code><b>setLatLng</b>(
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Sets the position of a circle to a new location.</td>
</tr>
<tr>
<td><code><b>setRadius</b>(
<nobr><Number> <i>radius</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Sets the radius of a circle. Units are in meters.</td>
</tr>
<tr id="circle-togeojson">
<td><code><b>toGeoJSON</b>()</code></td>
<td><code>Object</code></td>
<td>Returns a <a href="http://en.wikipedia.org/wiki/GeoJSON">GeoJSON</a> representation of the circle (GeoJSON Point Feature).</td>
</tr>
</table>
<h2 id="circlemarker">CircleMarker</h2>
<p>A circle of a fixed size with radius specified in pixels. Extends <a href="#circle">Circle</a>. Use <a href="#map-addlayer">Map#addLayer</a> to add it to the map.</p>
<h3>Creation</h3>
<table data-id='circlemarker'>
<tr>
<th class="width200">Factory</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>L.circleMarker</b>(
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i></nobr>,
<nobr><<a href="#path-options">Path options</a>> <i>options?</i> )</nobr>
</code></td>
<td>Instantiates a circle marker given a geographical point and optionally an options object. The default radius is 10 and can be altered by passing a "radius" member in the path options object.</td>
</tr>
</table>
<h3>Methods</h3>
<table data-id='circlemarker'>
<tr>
<th class="width200">Method</th>
<th class="minwidth">Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>setLatLng</b>(
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Sets the position of a circle marker to a new location.</td>
</tr>
<tr>
<td><code><b>setRadius</b>(
<nobr><Number> <i>radius</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Sets the radius of a circle marker. Units are in pixels.</td>
</tr>
<tr id="circlemarker-togeojson">
<td><code><b>toGeoJSON</b>()</code></td>
<td><code>Object</code></td>
<td>Returns a <a href="http://en.wikipedia.org/wiki/GeoJSON">GeoJSON</a> representation of the circle marker (GeoJSON Point Feature).</td>
</tr>
</table>
<h2 id="layergroup">LayerGroup</h2>
<p>Used to group several layers and handle them as one. If you add it to the map, any layers added or removed from the group will be added/removed on the map as well. Implements <a href="#ilayer">ILayer</a> interface.</p>
<pre><code class="javascript">L.layerGroup([marker1, marker2])
.addLayer(polyline)
.addTo(map);</code></pre>
<h3>Creation</h3>
<table data-id='layergroup'>
<tr>
<th class="width250">Factory</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>L.layerGroup</b>(
<nobr><<a href="#ilayer">ILayer</a>[]> <i>layers?</i> )</nobr>
</code></td>
<td>Create a layer group, optionally given an initial set of layers.</td>
</tr>
</table>
<h3>Methods</h3>
<table data-id='layergroup'>
<tr>
<th class="width200">Method</th>
<th class="minwidth">Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>addTo</b>(
<nobr><<a href="#map-class">Map</a>> <i>map</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Adds the group of layers to the map.</td>
</tr>
<tr>
<td><code><b>addLayer</b>(
<nobr><<a href="#ilayer">ILayer</a>> <i>layer</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Adds a given layer to the group.</td>
</tr>
<tr>
<td><code><b>removeLayer</b>(
<nobr><<a href="#ilayer">ILayer</a>> <i>layer</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Removes a given layer from the group.</td>
</tr>
<tr>
<td><code><b>removeLayer</b>(
<nobr><String> <i>id</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Removes a given layer of the given id from the group.</td>
</tr>
<tr>
<td><code><b>hasLayer</b>(
<nobr><<a href="#ilayer">ILayer</a>> <i>layer</i> )</nobr>
</code></td>
<td><code>Boolean</code></td>
<td>Returns <code><span class="hljs-literal">true</span></code> if the given layer is currently added to the group.</td>
</tr>
<tr>
<td><code><b>getLayer</b>(
<nobr><String> <i>id</i> )</nobr>
</code></td>
<td><code><a href="#ilayer">ILayer</a></code></td>
<td>Returns the layer with the given id.</td>
</tr>
<tr>
<td><code><b>getLayers</b>()</code></td>
<td><code>Array</code></td>
<td>Returns an array of all the layers added to the group.</td>
</tr>
<tr>
<td><code><b>clearLayers</b>()</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Removes all the layers from the group.</td>
</tr>
<tr>
<td><code><b>eachLayer</b>(
<nobr><Function> <i>fn</i></nobr>,
<nobr><Object> <i>context?</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Iterates over the layers of the group, optionally specifying context of the iterator function.
<pre><code>group.eachLayer(function (layer) {
layer.bindPopup('Hello');
});</code></pre>
</td>
</tr>
<tr id="layergroup-togeojson">
<td><code><b>toGeoJSON</b>()</code></td>
<td><code>Object</code></td>
<td>Returns a <a href="http://en.wikipedia.org/wiki/GeoJSON">GeoJSON</a> representation of the layer group (GeoJSON FeatureCollection).</td>
</tr>
</table>
<h2 id="featuregroup">FeatureGroup</h2>
<p>Extended <a href="#layergroup">layerGroup</a> that also has mouse events (propagated from members of the group) and a shared bindPopup method. Implements <a href="#ilayer">ILayer</a> interface.</p>
<pre><code class="javascript">L.featureGroup([marker1, marker2, polyline])
.bindPopup('Hello world!')
.on('click', function() { alert('Clicked on a group!'); })
.addTo(map);</code></pre>
<h3>Creation</h3>
<table data-id='featuregroup'>
<tr>
<th class="width300">Factory</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>L.featureGroup</b>(
<nobr><<a href="#ilayer">ILayer</a>[]> <i>layers?</i> )</nobr>
</code></td>
<td>Create a layer group, optionally given an initial set of layers.</td>
</tr>
</table>
<h3>Methods</h3>
<p>Has all <a href="#layergroup">layerGroup</a> methods and additionally:</p>
<table data-id='featuregroup'>
<tr>
<th class="width250">Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>bindPopup</b>(
<nobr><String> <i>htmlContent</i></nobr>,
<nobr><<a href="#popup-options">Popup options</a>> <i>options?</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Binds a popup with a particular HTML content to a click on any layer from the group that has a <code>bindPopup</code> method.</td>
</tr>
<tr>
<td><code><b>getBounds</b>()</code></td>
<td><code><a href="#latlngbounds">LatLngBounds</a></code></td>
<td>Returns the LatLngBounds of the Feature Group (created from bounds and coordinates of its children).</td>
</tr>
<tr>
<td><code><b>setStyle</b>(
<nobr><<a href="#path-options">Path options</a>> <i>style</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Sets the given path options to each layer of the group that has a <code>setStyle</code> method.</td>
</tr>
<tr>
<td><code><b>bringToFront</b>()</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Brings the layer group to the top of all other layers.</td>
</tr>
<tr>
<td><code><b>bringToBack</b>()</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Brings the layer group to the bottom of all other layers.</td>
</tr>
</table>
<h3>Events</h3>
<p>You can subscribe to the following events using <a href="#events">these methods</a>.</p>
<table data-id='featuregroup'>
<tr>
<th class="width100">Event</th>
<th class="width100">Data</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>click</b></code></td>
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
<td>Fired when the user clicks (or taps) the group.</td>
</tr>
<tr>
<td><code><b>dblclick</b></code></td>
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
<td>Fired when the user double-clicks (or double-taps) the group.</td>
</tr>
<tr>
<td><code><b>mouseover</b></code></td>
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
<td>Fired when the mouse enters the group.</td>
</tr>
<tr>
<td><code><b>mouseout</b></code></td>
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
<td>Fired when the mouse leaves the group.</td>
</tr>
<tr>
<td><code><b>mousemove</b></code></td>
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
<td>Fired while the mouse moves over the layers of the group.</td>
</tr>
<tr>
<td><code><b>contextmenu</b></code></td>
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
<td>Fired when the user right-clicks on one of the layers.</td>
</tr>
<tr>
<td><code><b>layeradd</b></code></td>
<td><code><a href="#layer-event">LayerEvent</a></code>
<td>Fired when a layer is added to the group.</td>
</tr>
<tr>
<td><code><b>layerremove</b></code></td>
<td><code><a href="#layer-event">LayerEvent</a></code>
<td>Fired when a layer is removed from the map.</td>
</tr>
</table>
<h2 id="geojson">GeoJson</h2>
<p>Represents a <a href="http://geojson.org/geojson-spec.html">GeoJSON</a> object or an array of GeoJSON objects. Allows you to parse GeoJSON data and display it on the map. Extends <a href="#featuregroup">FeatureGroup</a>.</p>
<pre><code class="javascript">L.geoJson(data, {
style: function (feature) {
return {color: feature.properties.color};
},
onEachFeature: function (feature, layer) {
layer.bindPopup(feature.properties.description);
}
}).addTo(map);</code></pre>
<p>Each feature layer created by it gets a <code>feature</code> property that links to the GeoJSON feature data the layer was created from (so that you can access its properties later).</p>
<h3>Creation</h3>
<table data-id='geojson'>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>L.geoJson</b>(
<nobr><Object> <i>geojson?</i></nobr>,
<nobr><<a href="#geojson-options">GeoJSON options</a>> <i>options?</i> )</nobr>
</code></td>
<td>Creates a GeoJSON layer. Optionally accepts an object in <a href="http://geojson.org/geojson-spec.html">GeoJSON format</a> to display on the map (you can alternatively add it later with <code>addData</code> method) and an options object.</td>
</tr>
</table>
<h3 id="geojson-options">Options</h3>
<table data-id='geojson'>
<tr>
<th>Option</th>
<th>Description</th>
</tr>
<tr id="geojson-pointtolayer">
<td><code><b>pointToLayer</b>(
<nobr><GeoJSON> <i>featureData</i></nobr>,
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i> )</nobr>
</code></td>
<td>Function that will be used for creating layers for GeoJSON points (if not specified, simple markers will be created).</td>
</tr>
<tr id="geojson-style">
<td><code><b>style</b>(
<nobr><GeoJSON> <i>featureData</i> )</nobr>
</code></td>
<td>Function that will be used to get style options for vector layers created for GeoJSON features.</td>
</tr>
<tr id="geojson-oneachfeature">
<td><code><b>onEachFeature</b>(
<nobr><GeoJSON> <i>featureData</i></nobr>,
<nobr><<a href="#ilayer">ILayer</a>> <i>layer</i> )</nobr>
</code></td>
<td>Function that will be called on each created feature layer. Useful for attaching events and popups to features.</td>
</tr>
<tr id="geojson-filter">
<td><code><b>filter</b>(
<nobr><GeoJSON> <i>featureData</i></nobr>,
<nobr><<a href="#ilayer">ILayer</a>> <i>layer</i> )</nobr>
</code></td>
<td>Function that will be used to decide whether to show a feature or not.</td>
</tr>
<tr id="geojson-coordstolatlng">
<td><code><b>coordsToLatLng</b>(
<nobr><Array> <i>coords</i></nobr> )</nobr>
</code></td>
<td>Function that will be used for converting GeoJSON coordinates to <a href="#latlng">LatLng</a> points (if not specified, coords will be assumed to be WGS84 — standard <code>[longitude, latitude]</code> values in degrees).</td>
</tr>
</table>
<p>Additionally accepts all <a href="#path-options">Path options</a> for polylines and polygons.</p>
<h3>Methods</h3>
<table data-id='geojson'>
<tr>
<th class="width250">Method</th>
<th class="minwidth">Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>addData</b>(
<nobr><GeoJSON> <i>data</i> )</nobr>
</code></td>
<td><code>this</code></td>
<td>Adds a GeoJSON object to the layer.</td>
</tr>
<tr id="geojson-setstyle">
<td><code><b>setStyle</b>(
<nobr><Function> <i><a href="#geojson-style">style</a></i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Changes styles of GeoJSON vector layers with the given style function.</td>
</tr>
<tr id="geojson-resetstyle">
<td><code><b>resetStyle</b>(
<nobr><<a href="#path">Path</a>> <i>layer</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Resets the given vector layer's style to the original GeoJSON style, useful for resetting style after hover events.</td>
</tr>
</table>
<h3>Static methods</h3>
<table data-id='geojson'>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>geometryToLayer</b>(
<nobr><GeoJSON> <i>featureData</i></nobr>,
<nobr><<a href="#geojson-pointtolayer">Function</a>> <i>pointToLayer?</i> )</nobr>
</code></td>
<td><code><a href="#ilayer">ILayer</a></code></td>
<td>Creates a layer from a given GeoJSON feature.</td>
</tr>
<tr>
<td><code><b>coordsToLatLng</b>(
<nobr><Array> <i>coords</i></nobr>,
<nobr><Boolean> <i>reverse?</i> )</nobr>
</code></td>
<td><code><a href="#latlng">LatLng</a></code></td>
<td>Creates a LatLng object from an array of 2 numbers (latitude, longitude) used in GeoJSON for points. If <code>reverse</code> is set to <code><span class="hljs-literal">true</span></code>, the numbers will be interpreted as (longitude, latitude).</td>
</tr>
<tr>
<td><code><b>coordsToLatLngs</b>(
<nobr><Array> <i>coords</i></nobr>,
<nobr><Number> <i>levelsDeep?</i></nobr>,
<nobr><Boolean> <i>reverse?</i> )</nobr>
</code></td>
<td><code>Array</code></td>
<td>Creates a multidimensional array of LatLng objects from a GeoJSON coordinates array. <code>levelsDeep</code> specifies the nesting level (0 is for an array of points, 1 for an array of arrays of points, etc., 0 by default). If <code>reverse</code> is set to <code><span class="hljs-literal">true</span></code>, the numbers will be interpreted as (longitude, latitude).</td>
</tr>
</table>
<h2 id="latlng">LatLng</h2>
<p>Represents a geographical point with a certain latitude and longitude.</p>
<pre><code class="javascript">var latlng = L.latLng(50.5, 30.5);</code></pre>
<p>All Leaflet methods that accept LatLng objects also accept them in a simple Array form and simple object form (unless noted otherwise), so these lines are equivalent:</p>
<pre><code>map.panTo([50, 30]);
map.panTo({lon: 30, lat: 50});
map.panTo({lat: 50, lng: 30});
map.panTo(L.latLng(50, 30));</code></pre>
<h3>Creation</h3>
<table data-id='latlng'>
<tr>
<th class="width200">Factory</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>L.latLng</b>(
<nobr><Number> <i>latitude</i></nobr>,
<nobr><Number> <i>longitude</i></nobr>,
<nobr><Number> <i>altitude?</i> )</nobr>
</code></td>
<td>Creates an object representing a geographical point with the given latitude and longitude (and optionally altitude).</td>
</tr>
</table>
<h3>Properties</h3>
<table data-id='latlng'>
<tr>
<th class="width100">Property</th>
<th class="width100">Type</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>lat</b></code></td>
<td><code>Number</code></td>
<td>Latitude in degrees.</td>
</tr>
<tr>
<td><code><b>lng</b></code></td>
<td><code>Number</code></td>
<td>Longitude in degrees.</td>
</tr>
</table>
<h3>Methods</h3>
<table data-id='latlng'>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>distanceTo</b>(
<nobr><<a href="#latlng">LatLng</a>> <i>otherLatlng</i> )</nobr>
</code></td>
<td><code>Number</code></td>
<td>Returns the distance (in meters) to the given LatLng calculated using the Haversine formula. See <a href="http://en.wikipedia.org/wiki/Haversine_formula">description on wikipedia</a>.</td>
</tr>
<tr>
<td><code><b>equals</b>(
<nobr><<a href="#latlng">LatLng</a>> <i>otherLatlng</i> )</nobr>
</code></td>
<td><code>Boolean</code></td>
<td>Returns <code><span class="hljs-literal">true</span></code> if the given LatLng point is at the same position (within a small margin of error).</td>
</tr>
<tr>
<td><code><b>toString</b>()</code></td>
<td><code>String</code></td>
<td>Returns a string representation of the point (for debugging purposes).</td>
</tr>
<tr>
<td><code><b>wrap</b>(
<nobr><Number> <i>left</i></nobr>,
<nobr><Number> <i>right</i> )</nobr>
</code></td>
<td><code><a href="#latlng">LatLng</a></code></td>
<td>Returns a new <code>LatLng</code> object with the longitude wrapped around <code>left</code> and <code>right</code> boundaries (<code><span class="hljs-number">-180</span></code> to <code><span class="hljs-number">180</span></code> by default).</td>
</tr>
</table>
<h3>Constants</h3>
<table data-id='latlng'>
<tr>
<th class="width100">Constant</th>
<th class="width100">Type</th>
<th class="width100">Value</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>DEG_TO_RAD</b></code></td>
<td><code>Number</code></td>
<td><code>Math.PI / <span class="hljs-number">180</span></code></td>
<td>A multiplier for converting degrees into radians.</td>
</tr>
<tr>
<td><code><b>RAD_TO_DEG</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-number">180</span> / Math.PI</code></td>
<td>A multiplier for converting radians into degrees.</td>
</tr>
<tr>
<td><code><b>MAX_MARGIN</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-number">1.0E-9</span></code></td>
<td>Max margin of error for the equality check.</td>
</tr>
</table>
<h2 id="latlngbounds">LatLngBounds</h2>
<p>Represents a rectangular geographical area on a map.</p>
<pre><code class="javascript">var southWest = L.latLng(40.712, -74.227),
northEast = L.latLng(40.774, -74.125),
bounds = L.latLngBounds(southWest, northEast);</code></pre>
<p>All Leaflet methods that accept LatLngBounds objects also accept them in a simple Array form (unless noted otherwise), so the bounds example above can be passed like this:</p>
<pre><code class="javascript">map.fitBounds([
[40.712, -74.227],
[40.774, -74.125]
]);</code></pre>
<h3>Creation</h3>
<table data-id='latlngbounds'>
<tr>
<th class="width250">Factory</th>
<th>Description</th>
</tr>
<tr>
<td>
<code><b>L.latLngBounds</b>(
<nobr><<a href="#latlng">LatLng</a>> <i>southWest</i></nobr>,
<nobr><<a href="#latlng">LatLng</a>> <i>northEast</i></nobr> )</code>
</td>
<td>Creates a latLngBounds object by defining south-west and north-east corners of the rectangle.</td>
</tr>
<tr>
<td><code><b>L.latLngBounds</b>(
<nobr><<a href="#latlng">LatLng</a>[]> <i>latlngs</i> )</nobr>
</code></td>
<td>Creates a LatLngBounds object defined by the geographical points it contains. Very useful for zooming the map to fit a particular set of locations with <a href="#map-fitbounds">fitBounds</a>.</td>
</tr>
</table>
<h3>Methods</h3>
<table data-id='latlngbounds'>
<tr>
<th class="width300">Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>extend</b>(
<nobr><<a href="#latlng">LatLng</a>|<a href="#latlngbounds">LatLngBounds</a>> <i>latlng</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Extends the bounds to contain the given point or bounds.</td>
</tr>
<tr>
<td><code><b>getSouthWest</b>()</code></td>
<td><code><a href="#latlng">LatLng</a></code></td>
<td>Returns the south-west point of the bounds.</td>
</tr>
<tr>
<td><code><b>getNorthEast</b>()</code></td>
<td><code><a href="#latlng">LatLng</a></code></td>
<td>Returns the north-east point of the bounds.</td>
</tr>
<tr>
<td><code><b>getNorthWest</b>()</code></td>
<td><code><a href="#latlng">LatLng</a></code></td>
<td>Returns the north-west point of the bounds.</td>
</tr>
<tr>
<td><code><b>getSouthEast</b>()</code></td>
<td><code><a href="#latlng">LatLng</a></code></td>
<td>Returns the south-east point of the bounds.</td>
</tr>
<tr>
<td><code><b>getWest</b>()</code></td>
<td><code>Number</code></td>
<td>Returns the west longitude of the bounds.</td>
</tr>
<tr>
<td><code><b>getSouth</b>()</code></td>
<td><code>Number</code></td>
<td>Returns the south latitude of the bounds.</td>
</tr>
<tr>
<td><code><b>getEast</b>()</code></td>
<td><code>Number</code></td>
<td>Returns the east longitude of the bounds.</td>
</tr>
<tr>
<td><code><b>getNorth</b>()</code></td>
<td><code>Number</code></td>
<td>Returns the north latitude of the bounds.</td>
</tr>
<tr>
<td><code><b>getCenter</b>()</code></td>
<td><code><a href="#latlng">LatLng</a></code></td>
<td>Returns the center point of the bounds.</td>
</tr>
<tr>
<td><code><b>contains</b>(
<nobr><<a href="#latlngbounds">LatLngBounds</a>> <i>otherBounds</i> )</nobr>
</code></td>
<td><code>Boolean</code></td>
<td>Returns <code><span class="hljs-literal">true</span></code> if the rectangle contains the given one.</td>
</tr>
<tr>
<td><code><b>contains</b>(
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i> )</nobr>
</code></td>
<td><code>Boolean</code></td>
<td>Returns <code><span class="hljs-literal">true</span></code> if the rectangle contains the given point.</td>
</tr>
<tr>
<td><code><b>intersects</b>(
<nobr><<a href="#latlngbounds">LatLngBounds</a>> <i>otherBounds</i> )</nobr>
</code></td>
<td><code>Boolean</code></td>
<td>Returns <code><span class="hljs-literal">true</span></code> if the rectangle intersects the given bounds.</td>
</tr>
<tr>
<td><code><b>equals</b>(
<nobr><<a href="#latlngbounds">LatLngBounds</a>> <i>otherBounds</i> )</nobr>
</code></td>
<td><code>Boolean</code></td>
<td>Returns <code><span class="hljs-literal">true</span></code> if the rectangle is equivalent (within a small margin of error) to the given bounds.</td>
</tr>
<tr>
<td><code><b>toBBoxString</b>()</code></td>
<td><code>String</code></td>
<td>Returns a string with bounding box coordinates in a <code><span class="hljs-string">'southwest_lng,southwest_lat,northeast_lng,northeast_lat'</span></code> format. Useful for sending requests to web services that return geo data.</td>
</tr>
<tr>
<td><code><b>pad</b>(
<nobr><Number> <i>bufferRatio</i> )</nobr>
</code></td>
<td><code><a href="#latlngbounds">LatLngBounds</a></code></td>
<td>Returns bigger bounds created by extending the current bounds by a given percentage in each direction.</td>
</tr>
<tr>
<td><code><b>isValid</b>()</nobr>
</code></td>
<td><code>Boolean</code></td>
<td>Returns <code><span class="hljs-literal">true</span></code> if the bounds are properly initialized.</td>
</tr>
</table>
<h2 id="point">Point</h2>
<p>Represents a point with x and y coordinates in pixels.</p>
<pre><code>var point = L.point(200, 300);</code></pre>
<p>All Leaflet methods and options that accept Point objects also accept them in a simple Array form (unless noted otherwise), so these lines are equivalent:</p>
<pre><code>map.panBy([200, 300]);
map.panBy(L.point(200, 300));</code></pre>
<h3>Creation</h3>
<table data-id='point'>
<tr>
<th class="width250">Factory</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>L.point</b>(
<nobr><Number> <i>x</i>, <Number> <i>y</i></nobr>,
<nobr><Boolean> <i>round?</i> )</nobr>
</code></td>
<td>Creates a Point object with the given <code>x</code> and <code>y</code> coordinates. If optional <code>round</code> is set to <code><span class="hljs-literal">true</span></code>, rounds the <code>x</code> and <code>y</code> values.</td>
</tr>
</table>
<h3>Properties</h3>
<table data-id='point'>
<tr>
<th class="width100">Property</th>
<th class="width100">Type</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>x</b></code></td>
<td><code>Number</code></td>
<td>The x coordinate.</td>
</tr>
<tr>
<td><code><b>y</b></code></td>
<td><code>Number</code></td>
<td>The y coordinate.</td>
</tr>
</table>
<h3>Methods</h3>
<table data-id='point'>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>add</b>(
<nobr><<a href="#point">Point</a>> <i>otherPoint</i> )</nobr>
</code></td>
<td><code><a href="#point">Point</a></code></td>
<td>Returns the result of addition of the current and the given points.</td>
</tr>
<tr>
<td><code><b>subtract</b>(
<nobr><<a href="#point">Point</a>> <i>otherPoint</i> )</nobr>
</code></td>
<td><code><a href="#point">Point</a></code></td>
<td>Returns the result of subtraction of the given point from the current.</td>
</tr>
<tr>
<td><code><b>multiplyBy</b>(
<nobr><Number> <i>number</i> )</nobr>
</code></td>
<td><code><a href="#point">Point</a></code></td>
<td>Returns the result of multiplication of the current point by the given number.</td>
</tr>
<tr>
<td><code><b>divideBy</b>(
<nobr><Number> <i>number</i></nobr>,
<nobr><Boolean> <i>round?</i> )</nobr>
</code></td>
<td><code><a href="#point">Point</a></code></td>
<td>Returns the result of division of the current point by the given number. If optional <code>round</code> is set to <code><span class="hljs-literal">true</span></code>, returns a rounded result.</td>
</tr>
<tr>
<td><code><b>distanceTo</b>(
<nobr><<a href="#point">Point</a>> <i>otherPoint</i> )</nobr>
</code></td>
<td><code>Number</code></td>
<td>Returns the distance between the current and the given points.</td>
</tr>
<tr>
<td><code><b>clone</b>()</code></td>
<td><code><a href="#point">Point</a></code></td>
<td>Returns a copy of the current point.</td>
</tr>
<tr>
<td><code><b>round</b>()</code></td>
<td><code><a href="#point">Point</a></code></td>
<td>Returns a copy of the current point with rounded coordinates.</td>
</tr>
<tr>
<td><code><b>floor</b>()</code></td>
<td><code><a href="#point">Point</a></code></td>
<td>Returns a copy of the current point with floored coordinates (rounded down).</td>
</tr>
<tr>
<td><code><b>equals</b>(
<nobr><<a href="#point">Point</a>> <i>otherPoint</i> )</nobr>
</code></td>
<td><code>Boolean</code></td>
<td>Returns <code><span class="hljs-literal">true</span></code> if the given point has the same coordinates.</td>
</tr>
<tr>
<td><code><b>contains</b>(
<nobr><<a href="#point">Point</a>> <i>otherPoint</i> )</nobr>
</code></td>
<td><code>Boolean</code></td>
<td>Returns <code><span class="hljs-literal">true</span></code> if the both coordinates of the given point are less than the corresponding current point coordinates (in absolute values).</td>
</tr>
<tr>
<td><code><b>toString</b>()</code></td>
<td><code>String</code></td>
<td>Returns a string representation of the point for debugging purposes.</td>
</tr>
</table>
<h2 id="bounds">Bounds</h2>
<p>Represents a rectangular area in pixel coordinates.</p>
<pre><code class="javascript">var p1 = L.point(10, 10),
p2 = L.point(40, 60),
bounds = L.bounds(p1, p2);</code></pre>
<p>All Leaflet methods that accept Bounds objects also accept them in a simple Array form (unless noted otherwise), so the bounds example above can be passed like this:</p>
<pre><code class="javascript">otherBounds.intersects([[10, 10], [40, 60]]);</code></pre>
<h3>Creation</h3>
<table data-id='bounds'>
<tr>
<th class="width250">Factory</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>L.bounds</b>(
<nobr><<a href="#point">Point</a>> <i>topLeft</i></nobr>,
<nobr><<a href="#point">Point</a>> <i>bottomRight</i> )</nobr>
</code></td>
<td>Creates a Bounds object from two coordinates (usually top-left and bottom-right corners).</td>
</tr>
<tr>
<td><code><b>L.bounds</b>(
<nobr><<a href="#point">Point</a>[]> <i>points</i> )</nobr>
</code></td>
<td>Creates a Bounds object defined by the points it contains.</td>
</tr>
</table>
<h3>Properties</h3>
<table data-id='bounds'>
<tr>
<th class="width100">Property</th>
<th class="width100">Type</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>min</b></code></td>
<td><code><a href="#point">Point</a></code></td>
<td>The top left corner of the rectangle.</td>
</tr>
<tr>
<td><code><b>max</b></code></td>
<td><code><a href="#point">Point</a></code></td>
<td>The bottom right corner of the rectangle.</td>
</tr>
</table>
<h3>Methods</h3>
<table data-id='bounds'>
<tr>
<th class="width250">Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>extend</b>(
<nobr><<a href="#point">Point</a>> <i>point</i> )</nobr>
</code></td>
<td>-</td>
<td>Extends the bounds to contain the given point.</td>
</tr>
<tr>
<td><code><b>getCenter</b>()</code></td>
<td><code><a href="#point">Point</a></code></td>
<td>Returns the center point of the bounds.</td>
</tr>
<tr>
<td><code><b>contains</b>(
<nobr><<a href="#bounds">Bounds</a>> <i>otherBounds</i> )</nobr>
</code></td>
<td><code>Boolean</code></td>
<td>Returns <code><span class="hljs-literal">true</span></code> if the rectangle contains the given one.</td>
</tr>
<tr>
<td><code><b>contains</b>(
<nobr><<a href="#point">Point</a>> <i>point</i> )</nobr>
</code></td>
<td><code>Boolean</code></td>
<td>Returns <code><span class="hljs-literal">true</span></code> if the rectangle contains the given point.</td>
</tr>
<tr>
<td><code><b>intersects</b>(
<nobr><<a href="#bounds">Bounds</a>> <i>otherBounds</i> )</nobr>
</code></td>
<td><code>Boolean</code></td>
<td>Returns <code><span class="hljs-literal">true</span></code> if the rectangle intersects the given bounds.</td>
</tr>
<tr>
<td><code><b>isValid</b>()</code></td>
<td><code>Boolean</code></td>
<td>Returns <code><span class="hljs-literal">true</span></code> if the bounds are properly initialized.</td>
</tr>
<tr>
<td><code><b>getSize</b>()</code></td>
<td><code><a href="#point">Point</a></code></td>
<td>Returns the size of the given bounds.</td>
</tr>
</table>
<h2 id="icon">Icon</h2>
<p>Represents an icon to provide when creating a marker.</p>
<pre><code class="javascript">var myIcon = L.icon({
iconUrl: 'my-icon.png',
iconRetinaUrl: 'my-icon@2x.png',
iconSize: [38, 95],
iconAnchor: [22, 94],
popupAnchor: [-3, -76],
shadowUrl: 'my-icon-shadow.png',
shadowRetinaUrl: 'my-icon-shadow@2x.png',
shadowSize: [68, 95],
shadowAnchor: [22, 94]
});
L.marker([50.505, 30.57], {icon: myIcon}).addTo(map);</code></pre>
<p><code>L.Icon.Default</code> extends <code>L.Icon</code> and is the blue icon Leaflet uses for markers by default.</p>
<h3>Creation</h3>
<table data-id='icon'>
<tr>
<th class="width250">Factory</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>L.icon</b>(
<nobr><<a href="#icon-options">Icon options</a>> <i>options</i> )</nobr>
</code></td>
<td>Creates an icon instance with the given options.</td>
</tr>
</table>
<h3 id="icon-options">Options</h3>
<table data-id='icon'>
<tr>
<th>Option</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>iconUrl</b></code></td>
<td><code>String</code>
<td>(required) The URL to the icon image (absolute or relative to your script path).</td>
</tr>
<tr>
<td><code><b>iconRetinaUrl</b></code></td>
<td><code>String</code>
<td>The URL to a retina sized version of the icon image (absolute or relative to your script path). Used for Retina screen devices.</td>
</tr>
<tr>
<td><code><b>iconSize</b></code></td>
<td><code><a href="#point">Point</a></code></td>
<td>Size of the icon image in pixels.</td>
</tr>
<tr>
<td><code><b>iconAnchor</b></code></td>
<td><code><a href="#point">Point</a></code></td>
<td>The coordinates of the "tip" of the icon (relative to its top left corner). The icon will be aligned so that this point is at the marker's geographical location. Centered by default if size is specified, also can be set in CSS with negative margins.</td>
</tr>
<tr>
<td><code><b>shadowUrl</b></code></td>
<td><code>String</code>
<td>The URL to the icon shadow image. If not specified, no shadow image will be created.</td>
</tr>
<tr>
<td><code><b>shadowRetinaUrl</b></code></td>
<td><code>String</code>
<td>The URL to the retina sized version of the icon shadow image. If not specified, no shadow image will be created. Used for Retina screen devices.</td>
</tr>
<tr>
<td><code><b>shadowSize</b></code></td>
<td><code><a href="#point">Point</a></code></td>
<td>Size of the shadow image in pixels.</td>
</tr>
<tr>
<td><code><b>shadowAnchor</b></code></td>
<td><code><a href="#point">Point</a></code></td>
<td>The coordinates of the "tip" of the shadow (relative to its top left corner) (the same as <code>iconAnchor</code> if not specified).</td>
</tr>
<tr>
<td><code><b>popupAnchor</b></code></td>
<td><code><a href="#point">Point</a></code></td>
<td>The coordinates of the point from which popups will "open", relative to the icon anchor.</td>
</tr>
<tr>
<td><code><b>className</b></code></td>
<td><code>String</code>
<td>A custom class name to assign to both icon and shadow images. Empty by default.</td>
</tr>
</table>
<h2 id="divicon">DivIcon</h2>
<p>Represents a lightweight icon for markers that uses a simple <code>div</code> element instead of an image.</p>
<pre><code class="javascript">var myIcon = L.divIcon({className: 'my-div-icon'});
// you can set .my-div-icon styles in CSS
L.marker([50.505, 30.57], {icon: myIcon}).addTo(map);</code></pre>
<p>By default, it has a <code><span class="hljs-string">'leaflet-div-icon'</span></code> class and is styled as a little white square with a shadow.</p>
<h3>Creation</h3>
<table data-id='divicon'>
<tr>
<th class="width250">Factory</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>L.divIcon</b>(
<nobr><<a href="#divicon-options">DivIcon options</a>> <i>options</i> )</nobr>
</code></td>
<td>Creates a div icon instance with the given options.</td>
</tr>
</table>
<h3 id="divicon-options">Options</h3>
<table data-id='divicon'>
<tr>
<th>Option</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>iconSize</b></code></td>
<td><code><a href="#point">Point</a></code></td>
<td>Size of the icon in pixels. Can be also set through CSS.</td>
</tr>
<tr>
<td><code><b>iconAnchor</b></code></td>
<td><code><a href="#point">Point</a></code></td>
<td>The coordinates of the "tip" of the icon (relative to its top left corner). The icon will be aligned so that this point is at the marker's geographical location. Centered by default if size is specified, also can be set in CSS with negative margins.</td>
</tr>
<tr>
<td><code><b>popupAnchor</b></code></td>
<td><code><a href="#point">Point</a></code></td>
<td>The coordinates of the point from which popups will "open", relative to the icon anchor.</td>
</tr>
<tr>
<td><code><b>className</b></code></td>
<td><code>String</code>
<td>A custom class name to assign to the icon. <code><span class="hljs-string">'leaflet-div-icon'</span></code> by default.</td>
</tr>
<tr>
<td><code><b>html</b></code></td>
<td><code>String</code>
<td>A custom HTML code to put inside the div element, empty by default.</td>
</tr>
</table>
<h2 id="control">Control</h2>
<p>The base class for all Leaflet controls. Implements <a href="#icontrol">IControl</a> interface. You can add controls to the map like this:</p>
<pre><code>control.addTo(map);
// the same as
map.addControl(control);</code></pre>
<h3>Creation</h3>
<table data-id='control'>
<tr>
<th class="width300">Factory</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>L.control</b>(
<nobr><<a href="#control-options">Control options</a>> <i>options?</i> )</nobr>
</code></td>
<td>Creates a control with the given options.</td>
</tr>
</table>
<h3 id="control-options">Options</h3>
<table data-id='control'>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>position</b></code></td>
<td><code>String</code></td>
<td><code><span class="hljs-string">'topright'</span></td>
<td>The initial position of the control (one of the map corners). See <a href="#control-positions">control positions</a>.</td>
</tr>
</table>
<h3 id="control-methods">Methods</h3>
<table data-id='control'>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>setPosition</b>(
<nobr><String> <i>position</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Sets the position of the control. See <a href="#control-positions">control positions</a>.</td>
</tr>
<tr>
<td><code><b>getPosition</b>()</code></td>
<td><code>String</code></td>
<td>Returns the current position of the control.</td>
</tr>
<tr>
<td><code><b>addTo</b>(
<nobr><<a href="#map-class">Map</a>> <i>map</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Adds the control to the map.</td>
</tr>
<tr>
<td><code><b>removeFrom</b>(
<nobr><<a href="#map-class">Map</a>> <i>map</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Removes the control from the map.</td>
</tr>
<tr>
<td><code><b>getContainer</b>()</code></td>
<td><code>HTMLElement</code></td>
<td>Returns the HTML container of the control.</td>
</tr>
</table>
<h3 id="control-positions">Control Positions</h3>
<p>Control positions (map corner to put a control to) are set using strings. Margins between controls and the map border are set with CSS, so that you can easily override them.</p>
<table data-id='control'>
<tr>
<th class="minwidth">Position</th>
<th>Description</th>
</tr>
<tr>
<td><code><span class="hljs-string">'topleft'</span></code></td>
<td>Top left of the map.</td>
</tr>
<tr>
<td><code><span class="hljs-string">'topright'</span></code></td>
<td>Top right of the map.</td>
</tr>
<tr>
<td><code><span class="hljs-string">'bottomleft'</span></code></td>
<td>Bottom left of the map.</td>
</tr>
<tr>
<td><code><span class="hljs-string">'bottomright'</span></code></td>
<td>Bottom right of the map.</td>
</tr>
</table>
<h2 id="control-zoom">Control.zoom</h2>
<p>A basic zoom control with two buttons (zoom in and zoom out). It is put on the map by default unless you set its <code>zoomControl</code> option to <code><span class="hljs-literal">false</span></code>. Extends <a href="#control">Control</a>.</p>
<h3>Creation</h3>
<table data-id='control-zoom'>
<tr>
<th>Factory</th>
<th class="width200">Description</th>
</tr>
<tr>
<td><code><b>L.control.zoom</b>(
<nobr><<a href="#control-zoom-options">Control.Zoom options</a>> <i>options?</i> )</nobr>
</code></td>
<td>Creates a zoom control.</td>
</tr>
</table>
<h3 id="control-zoom-options">Options</h3>
<table data-id='control-zoom'>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>position</b></code></td>
<td><code>String</code></td>
<td><code><span class="hljs-string">'topleft'</span></td>
<td>The position of the control (one of the map corners). See <a href="#control-positions">control positions</a>.</td>
</tr>
<tr>
<td><code><b>zoomInText</b></code></td>
<td><code>String</code></td>
<td><code><span class="hljs-string">'+'</span></td>
<td>The text set on the zoom in button.</td>
</tr>
<tr>
<td><code><b>zoomOutText</b></code></td>
<td><code>String</code></td>
<td><code><span class="hljs-string">'-'</span></td>
<td>The text set on the zoom out button.</td>
</tr>
<tr>
<td><code><b>zoomInTitle</b></code></td>
<td><code>String</code></td>
<td><code><span class="hljs-string">'Zoom in'</span></td>
<td>The title set on the zoom in button.</td>
</tr>
<tr>
<td><code><b>zoomOutTitle</b></code></td>
<td><code>String</code></td>
<td><code><span class="hljs-string">'Zoom out'</span></td>
<td>The title set on the zoom out button.</td>
</tr>
</table>
<h2 id="control-attribution">Control.Attribution</h2>
<p>The attribution control allows you to display attribution data in a small text box on a map. It is put on the map by default unless you set its <code>attributionControl</code> option to <code><span class="hljs-literal">false</span></code>, and it fetches attribution texts from layers with <code>getAttribution</code> method automatically. Extends <a href="#control">Control</a>.</p>
<h3>Creation</h3>
<table data-id='control-attribution'>
<tr>
<th class="width200">Factory</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>L.control.attribution</b>(
<nobr><<a href="#control-attribution-options">Control.Attribution options</a>> <i>options?</i> )</nobr>
</code></td>
<td>Creates an attribution control.</td>
</tr>
</table>
<h3 id="control-attribution-options">Options</h3>
<table data-id='control-attribution'>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>position</b></code></td>
<td><code>String</code></td>
<td><code><span class="hljs-string">'bottomright'</span></td>
<td>The position of the control (one of the map corners). See <a href="#control-positions">control positions</a>.</td>
</tr>
<tr>
<td><code><b>prefix</b></code></td>
<td><code>String</code></td>
<td><code><span class="hljs-string">'Leaflet'</span></td>
<td>The HTML text shown before the attributions. Pass <code><span class="hljs-literal">false</span></code> to disable.</td>
</tr>
</table>
<h3>Methods</h3>
<table data-id='control-attribution'>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>setPrefix</b>(
<nobr><String> <i>prefix</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Sets the text before the attributions.</td>
</tr>
<tr>
<td><code><b>addAttribution</b>(
<nobr><String> <i>text</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Adds an attribution text (e.g. <code><span class="hljs-string">'Vector data &copy; Mapbox'</span></code>).</td>
</tr>
<tr>
<td><code><b>removeAttribution</b>(
<nobr><String> <i>text</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Removes an attribution text.</td>
</tr>
</table>
<h2 id="control-layers">Control.Layers</h2>
<p>The layers control gives users the ability to switch between different base layers and switch overlays on/off (check out the <a href="https://leafletjs.com/examples/layers-control.html">detailed example</a>). Extends <a href="#control">Control</a>.</p>
<pre><code>var baseLayers = {
"Mapbox": mapbox,
"OpenStreetMap": osm
};
var overlays = {
"Marker": marker,
"Roads": roadsLayer
};
L.control.layers(baseLayers, overlays).addTo(map);</code></pre>
<h3>Creation</h3>
<table data-id='control-layers'>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>L.control.layers</b>(
<nobr><<a href="#control-layers-config">Layer Config</a>> <i>baseLayers?</i></nobr>,
<nobr><<a href="#control-layers-config">Layer Config</a>> <i>overlays?</i></nobr>,
<nobr><<a href="#control-layers-options">Control.Layers options</a>> <i>options?</i> )</nobr>
</code></td>
<td>Creates an attribution control with the given layers. Base layers will be switched with radio buttons, while overlays will be switched with checkboxes. Note that all base layers should be passed in the base layers object, but only one should be added to the map during map instantiation.</td>
</tr>
</table>
<h3>Methods</h3>
<table data-id='control-layers'>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>addBaseLayer</b>(
<nobr><<a href="#ilayer">ILayer</a>> <i>layer</i></nobr>,
<nobr><String> <i>name</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Adds a base layer (radio button entry) with the given name to the control.</td>
</tr>
<tr>
<td><code><b>addOverlay</b>(
<nobr><<a href="#ilayer">ILayer</a>> <i>layer</i></nobr>,
<nobr><String> <i>name</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Adds an overlay (checkbox entry) with the given name to the control.</td>
</tr>
<tr>
<td><code><b>removeLayer</b>(
<nobr><<a href="#ilayer">ILayer</a>> <i>layer</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Remove the given layer from the control.</td>
</tr>
</table>
<h3 id="control-layers-options">Options</h3>
<table data-id='control-layers'>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>position</b></code></td>
<td><code>String</code></td>
<td><code><span class="hljs-string">'topright'</span></td>
<td>The position of the control (one of the map corners). See <a href="#control-positions">control positions</a>.</td>
</tr>
<tr>
<td><code><b>collapsed</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code></td>
<td>If <code><span class="hljs-literal">true</span></code>, the control will be collapsed into an icon and expanded on mouse hover or touch.</td>
</tr>
<tr>
<td><code><b>autoZIndex</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code></td>
<td>If <code><span class="hljs-literal">true</span></code>, the control will assign zIndexes in increasing order to all of its layers so that the order is preserved when switching them on/off.</td>
</tr>
</table>
<h3 id="control-layers-config">Layer Config</h3>
<p>An object literal with layer names as keys and layer objects as values:</p>
<pre><code>{
"<someName1>": layer1,
"<someName2>": layer2
}</code></pre>
<p>The layer names can contain HTML, which allows you to add additional styling to the items:</p>
<pre><code>{"<img src='my-layer-icon' /> <span class='my-layer-item'>My Layer</span>": myLayer}</code></pre>
<h3>Events</h3>
<p>You can subscribe to the following events on the <a href="#map-class">Map</a> object using <a href="#events">these methods</a>.</p>
<table data-id='control-layers'>
<tr>
<th class="width100">Event</th>
<th class="width100">Data</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>baselayerchange</b></code></td>
<td><code><a href="#layers-control-event">LayersControlEvent</a></code>
<td>Fired when the base layer is changed through the control.</td>
</tr>
<tr>
<td><code><b>overlayadd</b></code></td>
<td><code><a href="#layers-control-event">LayersControlEvent</a></code>
<td>Fired when an overlay is selected through the control.</td>
</tr>
<tr>
<td><code><b>overlayremove</b></code></td>
<td><code><a href="#layers-control-event">LayersControlEvent</a></code>
<td>Fired when an overlay is deselected through the control.</td>
</tr>
</table>
<h2 id="control-scale">Control.Scale</h2>
<p>A simple scale control that shows the scale of the current center of screen in metric (m/km) and imperial (mi/ft) systems. Extends <a href="#control">Control</a>.</p>
<pre><code>L.control.scale().addTo(map);</code></pre>
<h3>Creation</h3>
<table data-id='control-scale'>
<tr>
<th class="width200">Factory</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>L.control.scale</b>(
<nobr><<a href="#control-scale-options">Control.Scale options</a>> <i>options?</i> )</nobr>
</code></td>
<td>Creates an scale control with the given options.</td>
</tr>
</table>
<h3 id="control-scale-options">Options</h3>
<table data-id='control-scale'>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>position</b></code></td>
<td><code>String</code></td>
<td><code><span class="hljs-string">'bottomleft'</span></td>
<td>The position of the control (one of the map corners). See <a href="#control-positions">control positions</a>.</td>
</tr>
<tr>
<td><code><b>maxWidth</b></code></td>
<td><code>Number</code></td>
<td><code><span class="hljs-number">100</span></code></td>
<td>Maximum width of the control in pixels. The width is set dynamically to show round values (e.g. 100, 200, 500).</td>
</tr>
<tr>
<td><code><b>metric</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code></td>
<td>Whether to show the metric scale line (m/km).</td>
</tr>
<tr>
<td><code><b>imperial</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code></td>
<td>Whether to show the imperial scale line (mi/ft).</td>
</tr>
<tr>
<td><code><b>updateWhenIdle</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">false</span></code></td>
<td>If <code><span class="hljs-literal">true</span></code>, the control is updated on <code>moveend</code>, otherwise it's always up-to-date (updated on <code>move</code>).</td>
</tr>
</table>
<h2 id="events">Events methods</h2>
<p>A set of methods shared between event-powered classes (like Map). Generally, events allow you to execute some function when something happens with an object (e.g. the user clicks on the map, causing the map <code><span class="hljs-string">'click'</span></code> event).</p>
<h3>Example</h3>
<pre><code class="javascript">map.on('click', function(e) {
alert(e.latlng);
});</code></pre>
<p>Leaflet deals with event listeners by reference, so if you want to add a listener and then remove it, define it as a function:</p>
<pre><code>function onClick(e) { ... }
map.on('click', onClick);
map.off('click', onClick);</code></pre>
<h3>Methods</h3>
<table data-id='events'>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>addEventListener</b>(
<nobr><String> <i>type</i></nobr>,
<nobr><Function> <i>fn</i></nobr>,
<nobr><Object> <i>context?</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Adds a listener function (<code>fn</code>) to a particular event type of the object. You can optionally specify the context of the listener (object the <code><span class="hljs-keyword">this</span></code> keyword will point to). You can also pass several space-separated types (e.g. <code><span class="hljs-string">'click dblclick'</span></code>).</td>
</tr>
<tr>
<td><code><b>addOneTimeEventListener</b>(
<nobr><String> <i>type</i></nobr>,
<nobr><Function> <i>fn</i></nobr>,
<nobr><Object> <i>context?</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>The same as above except the listener will only get fired once and then removed.</td>
</tr>
<tr>
<td><code><b>addEventListener</b>(
<nobr><Object> <i>eventMap</i></nobr>,
<nobr><Object> <i>context?</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Adds a set of type/listener pairs, e.g. <code>{click: onClick, mousemove: onMouseMove}</code></td>
</tr>
<tr>
<td><code><b>removeEventListener</b>(
<nobr><String> <i>type</i></nobr>,
<nobr><Function> <i>fn?</i></nobr>,
<nobr><Object> <i>context?</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to <code>addEventListener</code>, you must pass the same context to <code>removeEventListener</code> in order to remove the listener.</td>
</tr>
<tr>
<td><code><b>removeEventListener</b>(
<nobr><Object> <i>eventMap</i></nobr>,
<nobr><Object> <i>context?</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Removes a set of type/listener pairs.</code></td>
</tr>
<tr>
<td><code><b>removeEventListener</b>()</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Removes all listeners. An alias to <code>clearAllEventListeners</code> when you use it without arguments.</td>
</tr>
<tr>
<td><code><b>hasEventListeners</b>(
<nobr><String> <i>type</i> )</nobr>
</code></td>
<td><code>Boolean</code></td>
<td>Returns <code><span class="hljs-literal">true</span></code> if a particular event type has some listeners attached to it.</td>
</tr>
<tr>
<td><code><b>fireEvent</b>(
<nobr><String> <i>type</i></nobr>,
<nobr><Object> <i>data?</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Fires an event of the specified type. You can optionally provide an data object — the first argument of the listener function will contain its properties.</td>
</tr>
<tr>
<td><code><b>clearAllEventListeners</b>()</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Removes all listeners to all events on the object.</code></td>
</tr>
<tr>
<td><code><b>on</b>( … )</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Alias to <code>addEventListener</code>.</td>
</tr>
<tr>
<td><code><b>once</b>( … )</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Alias to <code>addOneTimeEventListener</code>.</td>
</tr>
<tr>
<td><code><b>off</b>( … )</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Alias to <code>removeEventListener</code>.</td>
</tr>
<tr>
<td><code><b>fire</b>( … )</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Alias to <code>fireEvent</code>.</td>
</tr>
</table>
<h2 id="event-objects">Event objects</h2>
<p>Event object is an object that you receive as an argument in a listener function when some event is fired, containing useful information about that event. For example:</p>
<pre><code class="javascript">map.on('click', function(e) {
alert(e.latlng); // e is an event object (MouseEvent in this case)
});</code></pre>
<h3 id="event">Event</h3>
<p>The base event object. All other event objects contain these properties too.</p>
<table data-id='events'>
<tr>
<th class="width100">property</th>
<th class="width100">type</th>
<th>description</th>
</tr>
<tr>
<td><code><b>type</b></code></td>
<td><code>String</code></td>
<td>The event type (e.g. <code><span class="hljs-string">'click'</span></code>).</td>
</tr>
<tr>
<td><code><b>target</b></code></td>
<td><code>Object</code></td>
<td>The object that fired the event.</td>
</tr>
</table>
<h3 id="mouse-event">MouseEvent</h3>
<table data-id='events'>
<tr>
<th class="width100">property</th>
<th>type</th>
<th>description</th>
</tr>
<tr>
<td><code><b>latlng</b></code></td>
<td><code><a href="#latlng">LatLng</a></code></td>
<td>The geographical point where the mouse event occurred.</td>
</tr>
<tr>
<td><code><b>layerPoint</b></code></td>
<td><code><a href="#point">Point</a></code></td>
<td>Pixel coordinates of the point where the mouse event occurred relative to the map layer.</td>
</tr>
<tr>
<td><code><b>containerPoint</b></code></td>
<td><code><a href="#point">Point</a></code></td>
<td>Pixel coordinates of the point where the mouse event occurred relative to the map сontainer.</td>
</tr>
<tr>
<td><code><b>originalEvent</b></code></td>
<td><code>DOMMouseEvent</code></td>
<td>The original DOM mouse event fired by the browser.</td>
</tr>
</table>
<h3 id="location-event">LocationEvent</h3>
<table data-id='events'>
<tr>
<th class="width100">property</th>
<th>type</th>
<th>description</th>
</tr>
<tr>
<td><code><b>latlng</b></code></td>
<td><code><a href="#latlng">LatLng</a></code></td>
<td>Detected geographical location of the user.</td>
</tr>
<tr>
<td><code><b>bounds</b></code></td>
<td><code><a href="#latlngbounds">LatLngBounds</a></code></td>
<td>Geographical bounds of the area user is located in (with respect to the accuracy of location).</td>
</tr>
<tr>
<td><code><b>accuracy</b></code></td>
<td><code>Number</code></td>
<td>Accuracy of location in meters.</td>
</tr>
<tr>
<td><code><b>altitude</b></code></td>
<td><code>Number</code></td>
<td>Height of the position above the WGS84 ellipsoid in meters.</td>
</tr>
<tr>
<td><code><b>altitudeAccuracy</b></code></td>
<td><code>Number</code></td>
<td>Accuracy of altitude in meters.</td>
</tr>
<tr>
<td><code><b>heading</b></code></td>
<td><code>Number</code></td>
<td>The direction of travel in degrees counting clockwise from true North.</td>
</tr>
<tr>
<td><code><b>speed</b></code></td>
<td><code>Number</code></td>
<td>Current velocity in meters per second.</td>
</tr>
<tr>
<td><code><b>timestamp</b></code></td>
<td><code>Number</code></td>
<td>The time when the position was acquired.</td>
</tr>
</table>
<h3 id="error-event">ErrorEvent</h3>
<table data-id='error-event'>
<tr>
<th class="width100">property</th>
<th class="width100">type</th>
<th>description</th>
</tr>
<tr>
<td><code><b>message</b></code></td>
<td><code>String</code></td>
<td>Error message.</td>
</tr>
<tr>
<td><code><b>code</b></code></td>
<td><code>Number</code></td>
<td>Error code (if applicable).</td>
</tr>
</table>
<h3 id="layer-event">LayerEvent</h3>
<table data-id='layer-event'>
<tr>
<th class="width100">property</th>
<th class="width100">type</th>
<th>description</th>
</tr>
<tr>
<td><code><b>layer</b></code></td>
<td><code><a href="#ilayer">ILayer</a></code></td>
<td>The layer that was added or removed.</td>
</tr>
</table>
<h3 id="layers-control-event">LayersControlEvent</h3>
<table data-id='layer-control-event'>
<tr>
<th class="width100">property</th>
<th class="width100">type</th>
<th>description</th>
</tr>
<tr>
<td><code><b>layer</b></code></td>
<td><code><a href="#ilayer">ILayer</a></code></td>
<td>The layer that was added or removed.</td>
</tr>
<tr>
<td><code><b>name</b></code></td>
<td><code>String</code></td>
<td>The name of the layer that was added or removed.</td>
</tr>
</table>
<h3 id="tile-event">TileEvent</h3>
<table data-id='tile-event'>
<tr>
<th class="width100">property</th>
<th class="width100">type</th>
<th>description</th>
</tr>
<tr>
<td><code><b>tile</b></code></td>
<td><code>HTMLElement</code></td>
<td>The tile element (image).</td>
</tr>
<tr>
<td><code><b>url</b></code></td>
<td><code>String</code></td>
<td>The source URL of the tile.</td>
</tr>
</table>
<h3 id="tileerror-event">TileErrorEvent</h3>
<table data-id='tileerror-event'>
<tr>
<th class="width100">property</th>
<th class="width100">type</th>
<th>description</th>
</tr>
<tr>
<td><code><b>tile</b></code></td>
<td><code>HTMLElement</code></td>
<td>The tile element (image).</td>
</tr>
<tr>
<td><code><b>url</b></code></td>
<td><code>String</code></td>
<td>The <code>src</code> attribute of the tile element.</td>
</tr>
</table>
<h3 id="resize-event">ResizeEvent</h3>
<table data-id='resize-event'>
<tr>
<th class="width100">property</th>
<th class="width100">type</th>
<th>description</th>
</tr>
<tr>
<td><code><b>oldSize</b></code></td>
<td><code><a href="#point">Point</a></code></td>
<td>The old size before resize event.</td>
</tr>
<tr>
<td><code><b>newSize</b></code></td>
<td><code><a href="#point">Point</a></code></td>
<td>The new size after the resize event.</td>
</tr>
</table>
<h3 id="geojson-event">GeoJSON event</h3>
<table data-id='geojson-event'>
<tr>
<th class="width100">property</th>
<th class="width100">type</th>
<th>description</th>
</tr>
<tr>
<td><code><b>layer</b></code></td>
<td><code><a href="#ilayer">ILayer</a></code></td>
<td>The layer for the GeoJSON feature that is being added to the map.</td>
</tr>
<tr>
<td><code><b>properties</b></code></td>
<td><code>Object</code></td>
<td>GeoJSON properties of the feature.</td>
</tr>
<tr>
<td><code><b>geometryType</b></code></td>
<td><code>String</code></td>
<td>GeoJSON geometry type of the feature.</td>
</tr>
<tr>
<td><code><b>id</b></code></td>
<td><code>String</code></td>
<td>GeoJSON ID of the feature (if present).</td>
</tr>
</table>
<h3 id="popup-event">Popup event</h3>
<table data-id='popup-event'>
<tr>
<th class="width100">property</th>
<th class="width100">type</th>
<th>description</th>
</tr>
<tr>
<td><code><b>popup</b></code></td>
<td><code><a href="#popup">Popup</a></code></td>
<td>The popup that was opened or closed.</td>
</tr>
</table>
<h3 id="dragend-event">DragEndEvent</h3>
<table data-id='layer-event'>
<tr>
<th class="width100">property</th>
<th class="width100">type</th>
<th>description</th>
</tr>
<tr>
<td><code><b>distance</b></code></td>
<td><code>Number</code></td>
<td>The distance in pixels the draggable element was moved by.</td>
</tr>
</table>
<!-- <h3>TileEvent</h3> -->
<h2 id="class">Class</h2>
<p><code>L.Class</code> powers the OOP facilities of Leaflet and is used to create almost all of the Leaflet classes documented here.</p>
<p>In addition to implementing a simple classical inheritance model, it introduces several special properties for convenient code organization — <code>options</code>, <code>includes</code> and <code>statics</code>.</p>
<pre><code>var MyClass = L.Class.extend({
initialize: function (greeter) {
this.greeter = greeter;
// class constructor
},
greet: function (name) {
alert(this.greeter + ', ' + name)
}
});
// create instance of MyClass, passing "Hello" to the constructor
var a = new MyClass("Hello");
// call greet method, alerting "Hello, World"
a.greet("World");
</code></pre>
<p>The <code>initialize</code> method is your class's constructor function, meaning that it gets called when you do <code>new MyClass(...)</code>.</p>
<h3>Class Factories</h3>
<p>You may have noticed that Leaflet objects are created without using the <code>new</code> keyword. This is achieved by complementing each class with a lowercase factory method:</p>
<pre><code>new L.Map('map'); // becomes:
L.map('map');</code></pre>
<p>The factories are implemented very easily, and you can do this for your own classes:</p>
<pre><code>L.map = function (id, options) {
return new L.Map(id, options);
};</code></pre>
<h3>Inheritance</h3>
<p>You use <code>L.Class.extend</code> to define new classes, but you can use the same method on any class to inherit from it:</p>
<pre><code>var MyChildClass = MyClass.extend({
// ... new properties and methods
});</code></pre>
<p>This will create a class that inherits all methods and properties of the parent class (through a proper prototype chain), adding or overriding the ones you pass to <code>extend</code>. It will also properly react to <code>instanceof</code>:</p>
<pre><code>var a = new MyChildClass();
a instanceof MyChildClass; // true
a instanceof MyClass; // true
</code></pre>
<p>You can call parent methods (including constructor) from corresponding child ones (as you do with <code>super</code> calls in other languages) by accessing parent class prototype and using JavaScript's <code>call</code> or <code>apply</code>:</p>
<pre><code>var MyChildClass = MyClass.extend({
initialize: function () {
MyClass.prototype.initialize.call(this, "Yo");
},
greet: function (name) {
MyClass.prototype.greet.call(this, 'bro ' + name + '!');
}
});
var a = new MyChildClass();
a.greet('Jason'); // alerts "Yo, bro Jason!"</code></pre>
<h3 id="class-options">Options</h3>
<p><code>options</code> is a special property that unlike other objects that you pass to <code>extend</code> will be merged with the parent one instead of overriding it completely, which makes managing configuration of objects and default values convenient:</p>
<pre><code>var MyClass = L.Class.extend({
options: {
myOption1: 'foo',
myOption2: 'bar'
}
});
var MyChildClass = MyClass.extend({
options: {
myOption1: 'baz',
myOption3: 5
}
});
var a = new MyChildClass();
a.options.myOption1; // 'baz'
a.options.myOption2; // 'bar'
a.options.myOption3; // 5</code></pre>
<p>There's also <code>L.Util.setOptions</code>, a method for conveniently merging options passed to constructor with the defaults defined in the class:</p>
<pre><code>var MyClass = L.Class.extend({
options: {
foo: 'bar',
bla: 5
},
initialize: function (options) {
L.Util.setOptions(this, options);
...
}
});
var a = new MyClass({bla: 10});
a.options; // {foo: 'bar', bla: 10}</code></pre>
<h3>Includes</h3>
<p><code>includes</code> is a special class property that merges all specified objects into the class (such objects are called mixins). A good example of this is <code>L.Mixin.Events</code> that <a href="#events">event-related methods</a> like <code>on</code>, <code>off</code> and <code>fire</code> to the class.</p>
<pre><code> var MyMixin = {
foo: function () { ... },
bar: 5
};
var MyClass = L.Class.extend({
includes: MyMixin
});
var a = new MyClass();
a.foo();</code></pre>
<p>You can also do such includes in runtime with the <code>include</code> method:</p>
<pre><code><b>MyClass.include</b>(MyMixin);</code></pre>
<h3>Statics</h3>
<p><code>statics</code> is just a convenience property that injects specified object properties as the static properties of the class, useful for defining constants:</p>
<pre><code>var MyClass = L.Class.extend({
statics: {
FOO: 'bar',
BLA: 5
}
});
MyClass.FOO; // 'bar'</code></pre>
<h3>Constructor Hooks</h3>
<p>If you're a plugin developer, you often need to add additional initialization code to existing classes (e.g. editing hooks for <code>L.Polyline</code>). Leaflet comes with a way to do it easily using the <code>addInitHook</code> method:</p>
<pre><code>MyClass.addInitHook(function () {
// ... do something in constructor additionally
// e.g. add event listeners, set custom properties etc.
});</code></pre>
<p>You can also use the following shortcut when you just need to make one additional method call:</p>
<pre><code>MyClass.addInitHook('methodName', arg1, arg2, …);</code></pre>
<h2 id="browser">Browser</h2>
<p>A namespace with properties for browser/feature detection used by Leaflet internally.</p>
<pre><code>if (L.Browser.ie6) {
alert('Upgrade your browser, dude!');
}</code></pre>
<table data-id='browser'>
<tr>
<th class="width100">property</th>
<th class="width100">type</th>
<th>description</th>
</tr>
<tr>
<td><code><b>ie</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code> for all Internet Explorer versions.</td>
</tr>
<tr>
<td><code><b>ie6</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code> for Internet Explorer 6.</td>
</tr>
<tr>
<td><code><b>ie7</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code> for Internet Explorer 7.</td>
</tr>
<tr>
<td><code><b>ielt9</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code> for Internet Explorer versions less than 9.</td>
</tr>
<tr>
<td><code><b>webkit</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code> for webkit-based browsers like Chrome and Safari (including mobile versions).</td>
</tr>
<tr>
<td><code><b>webkit3d</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code> for webkit-based browsers that support CSS 3D transformations.</td>
</tr>
<!--<tr>
<td><code><b>gecko</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code> for Gecko-based browsers like Firefox and Mozilla.</td>
</tr>
<tr>
<td><code><b>opera</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code> for Opera.</td>
</tr>-->
<tr>
<td><code><b>android</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code> for Android mobile browser.</td>
</tr>
<tr>
<td><code><b>android23</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code> for old Android stock browsers (2 and 3).</td>
</tr>
<tr>
<td><code><b>mobile</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code> for modern mobile browsers (including iOS Safari and different Android browsers).</td>
</tr>
<tr>
<td><code><b>mobileWebkit</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code> for mobile webkit-based browsers.</td>
</tr>
<tr>
<td><code><b>mobileOpera</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code> for mobile Opera.</td>
</tr>
<tr>
<td><code><b>touch</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code> for all browsers on touch devices.</td>
</tr>
<tr>
<td><code><b>msTouch</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code> for browsers with Microsoft touch model (e.g. IE10).</td>
</tr>
<tr>
<td><code><b>retina</b></code></td>
<td><code>Boolean</code></td>
<td><code><span class="hljs-literal">true</span></code> for devices with Retina screens.</td>
</tr>
</table>
<h2 id="util">Util</h2>
<p>Various utility functions, used by Leaflet internally.</p>
<h3>Methods</h3>
<table data-id='util'>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>extend</b>(
<nobr><Object> <i>dest</i></nobr>,
<nobr><Object> <i>src?..</i> )</nobr>
</code></td>
<td><code>Object</code></td>
<td>Merges the properties of the <code>src</code> object (or multiple objects) into <code>dest</code> object and returns the latter. Has an <code>L.extend</code> shortcut.</td>
</tr>
<tr>
<td><code><b>bind</b>(
<nobr><Function> <i>fn</i></nobr>,
<nobr><Object> <i>obj</i> )</nobr>
</code></td>
<td><code>Function</code></td>
<td>Returns a function which executes function <code>fn</code> with the given scope <code>obj</code> (so that <code><span class="hljs-keyword">this</span></code> keyword refers to <code>obj</code> inside the function code). Has an <code>L.bind</code> shortcut. Not a polyfill for ES 5 <code>bind</code> (compare <code>L.bind</code> to the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/bind#Polyfill">MDN-recommended polyfill</a> for <code>Function.prototype.bind</code>).</td>
</tr>
<tr>
<td><code><b>stamp</b>( <Object> <i>obj</i></nobr> )<nobr></code></td>
<td><code>String</code></td>
<td>Applies a unique key to the object and returns that key. Has an <code>L.stamp</code> shortcut.</td>
</tr>
<tr>
<td><code><b>requestAnimFrame</b>(
<nobr><Function> <i>fn</i></nobr>,
<nobr><Object> <i>context?</i></nobr>,
<nobr><Boolean> <i>immediate?</i></nobr>,
<nobr><HTMLElement> <i>element?</i> )</nobr>
</code></td>
<td><code>Number</code></td>
<td>Schedules <code>fn</code> to be executed when the browser repaints. When <code>immediate</code> is set, <code>fn</code> is called immediately if the browser doesn't have native support for <code>requestAnimationFrame</code>, otherwise it's delayed. Returns an id that can be used to cancel the request.</td>
</tr>
<tr>
<td><code><b>cancelAnimFrame</b>(
<nobr><Number> <i>id</i> )</nobr>
</code></td>
<td>-</td>
<td>Cancels a previous request to <code>requestAnimFrame</code>.</td>
</tr>
<tr>
<td><code><b>limitExecByInterval</b>(
<nobr><Function> <i>fn</i></nobr>,
<nobr><Number> <i>time</i></nobr>,
<nobr><Object> <i>context?</i> )</nobr>
</code></td>
<td><code>Function</code></td>
<td>Returns a wrapper around the function <code>fn</code> that makes sure it's called not more often than a certain time interval <code>time</code>, but as fast as possible otherwise (for example, it is used for checking and requesting new tiles while dragging the map), optionally passing the scope (<code>context</code>) in which the function will be called.</td>
</tr>
<tr>
<td><code><b>falseFn</b>()</code></td>
<td><code>Function</code></td>
<td>Always returns <code><span class="hljs-literal">false</span></code>.</td>
</tr>
<tr>
<td><code><b>formatNum</b>(
<nobr><Number> <i>num</i></nobr>,
<nobr><Number> <i>digits</i> )</nobr>
</code></td>
<td><code>Number</code></td>
<td>Returns the number <code>num</code> rounded to <code>digits</code> decimals.</td>
</tr>
<tr>
<td><code><b>splitWords</b>(
<nobr><String> <i>str</i> )</nobr>
</code></td>
<td><code>String[]</code></td>
<td>Trims and splits the string on whitespace and returns the array of parts.</code></td>
</tr>
<tr>
<td><code><b>setOptions</b>(
<nobr><Object> <i>obj</i></nobr>,
<nobr><Object> <i>options</i> )</nobr>
</code></td>
<td><code>Object</code></td>
<td>Merges the given properties to the <code>options</code> of the <code>obj</code> object, returning the resulting options. See <a href="#class-options">Class options</a>. Has an <code>L.setOptions</code> shortcut.</td>
</tr>
<tr>
<td><code><b>getParamString</b>(
<nobr><Object> <i>obj</i> )</nobr>
</code></td>
<td><code>String</code></td>
<td>Converts an object into a parameter URL string, e.g. <nobr><code>{a: "foo", b: "bar"}</code></nobr> translates to <code><span class="hljs-string">'?a=foo&b=bar'</span></code>.</td>
</tr>
<tr id="util-template">
<td><code><b>template</b>(
<nobr><String> <i>str</i>, <Object> <i>data</i> )</nobr>
</code></td>
<td><code>String</code></td>
<td>Simple templating facility, accepts a template string of the form <code><span class="hljs-string">'Hello {a}, {b}'</span></code> and a data object like <code>{a: 'foo', b: 'bar'}</code>, returns evaluated string (<code><span class="hljs-string">'Hello foo, bar'</span></code>). You can also specify functions instead of strings for data values — they will be evaluated passing <code>data</code> as an argument.</td>
</tr>
<tr>
<td><code><b>isArray</b>(
<nobr><Object> <i>obj</i> )</nobr>
</code></td>
<td><code>Boolean</code></td>
<td>Returns <code><span class="hljs-literal">true</span></code> if the given object is an array.</td>
</tr>
<tr>
<td><code><b>trim</b>(
<nobr><String> <i>str</i> )</nobr>
</code></td>
<td><code>String</code></td>
<td>Trims the whitespace from both ends of the string and returns the result.</td>
</tr>
</table>
<h3>Properties</h3>
<table data-id='util'>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>emptyImageUrl</b></code></td>
<td><code>String</code></td>
<td>Data URI string containing a base64-encoded empty GIF image. Used as a hack to free memory from unused images on WebKit-powered mobile devices (by setting image <code>src</code> to this string).</td>
</tr>
</table>
<h2 id="transformation">Transformation</h2>
<p>Represents an affine transformation: a set of coefficients <code>a</code>, <code>b</code>, <code>c</code>, <code>d</code> for transforming a point of a form <code>(x, y)</code> into <code>(a*x + b, c*y + d)</code> and doing the reverse. Used by Leaflet in its projections code.</p>
<pre><code>var transformation = new L.Transformation(2, 5, -1, 10),
p = L.point(1, 2),
p2 = transformation.transform(p), // L.point(7, 8)
p3 = transformation.untransform(p2); // L.point(1, 2)
</code></pre>
<h3>Creation</h3>
<table data-id='transformation'>
<tr>
<th class="width250">Creation</th>
<th>Description</th>
</tr>
<tr>
<td><code><nobr><span class='keyword'>new</span> <b>L.Transformation</b>(</nobr>
<nobr><Number> <i>a</i></nobr>,
<nobr><Number> <i>b</i></nobr>,
<nobr><Number> <i>c</i></nobr>,
<nobr><Number> <i>d</i> )</nobr>
</code></td>
<td>Creates a transformation object with the given coefficients.</td>
</tr>
</table>
<h3>Methods</h3>
<table data-id='transformation'>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>transform</b>(
<nobr><<a href="#point">Point</a>> <i>point</i></nobr>,
<nobr><Number> <i>scale?</i> )</nobr>
</code></td>
<td><code><a href="#point">Point</a></code></td>
<td>Returns a transformed point, optionally multiplied by the given scale. Only accepts real <code>L.Point</code> instances, not arrays.</td>
</tr>
<tr>
<td><code><b>untransform</b>(
<nobr><<a href="#point">Point</a>> <i>point</i></nobr>,
<nobr><Number> <i>scale?</i> )</nobr>
</code></td>
<td><code><a href="#point">Point</a></code></td>
<td>Returns the reverse transformation of the given point, optionally divided by the given scale. Only accepts real <code>L.Point</code> instances, not arrays.</td>
</tr>
</table>
<h2 id="lineutil">LineUtil</h2>
<p>Various utility functions for polyline points processing, used by Leaflet internally to make polylines lightning-fast.</p>
<h3>Methods</h3>
<table data-id='lineutil'>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>simplify</b>(
<nobr><<a href="#point">Point</a>[]> <i>points</i></nobr>,
<nobr><Number> <i>tolerance</i> )</nobr>
</code></td>
<td><code><a href="#point">Point</a>[]</code></td>
<td>Dramatically reduces the number of points in a polyline while retaining its shape and returns a new array of simplified points. Used for a huge performance boost when processing/displaying Leaflet polylines for each zoom level and also reducing visual noise. <code>tolerance</code> affects the amount of simplification (lesser value means higher quality but slower and with more points). Also released as a separated micro-library <a href="http://mourner.github.com/simplify-js/">Simplify.js</a>.</td>
</tr>
<tr>
<td><code><b>pointToSegmentDistance</b>(
<nobr><<a href="#point">Point</a>> <i>p</i></nobr>,
<nobr><<a href="#point">Point</a>> <i>p1</i></nobr>,
<nobr><<a href="#point">Point</a>> <i>p2</i> )</nobr>
</code></td>
<td><code>Number</code></td>
<td>Returns the distance between point <code>p</code> and segment <code>p1</code> to <code>p2</code>.</td>
</tr>
<tr>
<td><code><b>closestPointOnSegment</b>(
<nobr><<a href="#point">Point</a>> <i>p</i></nobr>,
<nobr><<a href="#point">Point</a>> <i>p1</i></nobr>,
<nobr><<a href="#point">Point</a>> <i>p2</i> )</nobr>
</code></td>
<td><code><a href="#point">Point</a></code></td>
<td>Returns the closest point from a point <code>p</code> on a segment <code>p1</code> to <code>p2</code>.</td>
</tr>
<tr>
<td><code><b>clipSegment</b>(
<nobr><<a href="#point">Point</a>> <i>a</i></nobr>,
<nobr><<a href="#point">Point</a>> <i>b</i></nobr>,
<nobr><<a href="#bounds">Bounds</a>> <i>bounds</i> )</nobr>
</code></td>
<td><code><a href="#point">Point</a>[]</code></td>
<td>Clips the segment <code>a</code> to <code>b</code> by rectangular bounds. Returns either false or an array of clipped points. Used by Leaflet to only show polyline points that are on the screen or near, increasing performance.</td>
</tr>
</table>
<h2 id="polyutil">PolyUtil</h2>
<p>Various utility functions for polygon geometries.</p>
<h3>Methods</h3>
<table data-id='polylineutil'>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>clipPolygon</b>(
<nobr><<a href="#point">Point</a>[]> <i>points</i></nobr>,
<nobr><<a href="#bounds">Bounds</a>> <i>bounds</i> )</nobr>
</code></td>
<td><code><a href="#point">Point</a>[]</code></td>
<td>Clips the polygon geometry defined by the given points by rectangular bounds. Used by Leaflet to only show polygon points that are on the screen or near, increasing performance. Note that polygon points needs different algorithm for clipping than polyline, so there's a separate method for it.</td>
</tr>
</table>
<h2 id="domevent">DomEvent</h2>
<p>Utility functions to work with the DOM events, used by Leaflet internally.</p>
<h3>Methods</h3>
<table data-id='domevent'>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>addListener</b>(
<nobr><HTMLElement> <i>el</i></nobr>,
<nobr><String> <i>type</i></nobr>,
<nobr><Function> <i>fn</i></nobr>,
<nobr><Object> <i>context?</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Adds a listener <code>fn</code> to the element's DOM event of the specified type. <code><span class="hljs-keyword">this</span></code> keyword inside the listener will point to <code>context</code>, or to the element if not specified.</td>
</tr>
<tr>
<td><code><b>removeListener</b>(
<nobr><HTMLElement> <i>el</i></nobr>,
<nobr><String> <i>type</i></nobr>,
<nobr><Function> <i>fn</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Removes an event listener from the element.</td>
</tr>
<tr>
<td><code><b>stopPropagation</b>(
<nobr><DOMEvent> <i>e</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Stop the given event from propagation to parent elements. Used inside the listener functions:
<pre><code>L.DomEvent.addListener(div, 'click', function (e) {
L.DomEvent.stopPropagation(e);
});</code></pre>
</td>
</tr>
<tr>
<td><code><b>preventDefault</b>(
<nobr><DOMEvent> <i>e</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Prevents the default action of the event from happening (such as following a link in the <code>href</code> of the <code>a</code> element, or doing a <code>POST</code> request with page reload when <code>form</code> is submitted). Use it inside listener functions.</pre>
</td>
</tr>
<tr>
<td><code><b>stop</b>(
<nobr><DOMEvent> <i>e</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Does <code>stopPropagation</code> and <code>preventDefault</code> at the same time.</td>
</tr>
<tr>
<td><code><b>disableClickPropagation</b>(
<nobr><HTMLElement> <i>el</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Adds <code>stopPropagation</code> to the element's <code><span class="hljs-string">'click'</span></code>, <code><span class="hljs-string">'doubleclick'</span></code>, <code><span class="hljs-string">'mousedown'</span></code> and <code><span class="hljs-string">'touchstart'</span></code> events.</td>
</tr>
<tr>
<td><code><b>getMousePosition</b>(
<nobr><DOMEvent> <i>e</i></nobr>,
<nobr><HTMLElement> <i>container?</i> )</nobr>
</code></td>
<td><code><a href="#point">Point</a></code></td>
<td>Gets normalized mouse position from a DOM event relative to the container or to the whole page if not specified.</td>
</tr>
<tr>
<td><code><b>getWheelDelta</b>(
<nobr><DOMEvent> <i>e</i> )</nobr>
</code></td>
<td><code>Number</code></td>
<td>Gets normalized wheel delta from a <code>mousewheel</code> DOM event.</td>
</tr>
</table>
<h2 id="domutil">DomUtil</h2>
<p>Utility functions to work with the DOM tree, used by Leaflet internally.</p>
<h3>Methods</h3>
<table data-id='domutil'>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>get</b>(
<nobr><String or HTMLElement> <i>id</i> )</nobr>
</code></td>
<td><code>HTMLElement</code></td>
<td>Returns an element with the given id if a string was passed, or just returns the element if it was passed directly.</td>
</tr>
<tr>
<td><code><b>getStyle</b>(
<nobr><HTMLElement> <i>el</i></nobr>,
<nobr><String> <i>style</i> )</nobr>
</code></td>
<td><code>String</code></td>
<td>Returns the value for a certain style attribute on an element, including computed values or values set through CSS.</td>
</tr>
<tr>
<td><code><b>getViewportOffset</b>(
<nobr><HTMLElement> <i>el</i> )</nobr>
</code></td>
<td><a href="#point"><code>Point</code></a></td>
<td>Returns the offset to the viewport for the requested element.</td>
</tr>
<tr>
<td><code><b>create</b>(
<nobr><String> <i>tagName</i></nobr>,
<nobr><String> <i>className</i></nobr>,
<nobr><HTMLElement> <i>container?</i> )</nobr>
</code></td>
<td><code>HTMLElement</code></td>
<td>Creates an element with <code>tagName</code>, sets the <code>className</code>, and optionally appends it to <code>container</code> element.</td>
</tr>
<tr>
<td><code><b>disableTextSelection</b>()</code></td>
<td>-</td>
<td>Makes sure text cannot be selected, for example during dragging.</td>
</tr>
<tr>
<td><code><b>enableTextSelection</b>()</code></td>
<td>-</td>
<td>Makes text selection possible again.</td>
</tr>
<tr>
<td><code><b>hasClass</b>(
<nobr><HTMLElement> <i>el</i></nobr>,
<nobr><String> <i>name</i> )</nobr>
</code></td>
<td><code>Boolean</code></td>
<td>Returns <code><span class="hljs-literal">true</span></code> if the element class attribute contains <code>name</code>.</td>
</tr>
<tr>
<td><code><b>addClass</b>(
<nobr><HTMLElement> <i>el</i></nobr>,
<nobr><String> <i>name</i> )</nobr>
</code></td>
<td>-</td>
<td>Adds <code>name</code> to the element's class attribute.</td>
</tr>
<tr>
<td><code><b>removeClass</b>(
<nobr><HTMLElement> <i>el</i></nobr>,
<nobr><String> <i>name</i> )</nobr>
</code></td>
<td>-</td>
<td>Removes <code>name</code> from the element's class attribute.</td>
</tr>
<tr>
<td><code><b>setOpacity</b>(
<nobr><HTMLElement> <i>el</i></nobr>,
<nobr><Number> <i>value</i> )</nobr>
</code></td>
<td>-</td>
<td>Set the opacity of an element (including old IE support). Value must be from <code>0</code> to <code>1</code>.</td>
</tr>
<tr>
<td><code><b>testProp</b>(
<nobr><String[]> <i>props</i> )</nobr>
</code></td>
<td><code>String</code> or <code><span class="hljs-literal">false</span></code></td>
<td>Goes through the array of style names and returns the first name that is a valid style name for an element. If no such name is found, it returns <code><span class="hljs-literal">false</span></code>. Useful for vendor-prefixed styles like <code>transform</code>.</td>
</tr>
<tr>
<td><code><b>getTranslateString</b>(
<nobr><<a href="#point">Point</a>> <i>point</i> )</nobr>
</code></td>
<td><code>String</code></td>
<td>Returns a CSS transform string to move an element by the offset provided in the given point. Uses 3D translate on WebKit for hardware-accelerated transforms and 2D on other browsers.</td>
</tr>
<tr>
<td><code><b>getScaleString</b>(
<nobr><Number> <i>scale</i></nobr>,
<nobr><<a href="#point">Point</a>> <i>origin</i> )</nobr>
</code></td>
<td><code>String</code></td>
<td>Returns a CSS transform string to scale an element (with the given scale origin).</td>
</tr>
<tr>
<td><code><b>setPosition</b>(
<nobr><HTMLElement> <i>el</i></nobr>,
<nobr><<a href="#point">Point</a>> <i>point</i></nobr>,
<nobr><Boolean> <i>disable3D?</i> )</nobr>
</code></td>
<td>-</td>
<td>Sets the position of an element to coordinates specified by <code>point</code>, using CSS translate or top/left positioning depending on the browser (used by Leaflet internally to position its layers). Forces top/left positioning if <code>disable3D</code> is <code><span class="hljs-literal">true</span></code>.</td>
</tr>
<tr>
<td><code><b>getPosition</b>(
<nobr><HTMLElement> <i>el</i> )</nobr>
</code></td>
<td><a href="#point">Point</a></td>
<td>Returns the coordinates of an element previously positioned with <code>setPosition</code>.</td>
</tr>
</table>
<h3>Properties</h3>
<table data-id='domutil'>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>TRANSITION</b></nobr>
</code></td>
<td><code>String</code></td>
<td>Vendor-prefixed transition style name (e.g. <code><span class="hljs-string">'webkitTransition'</span></code> for WebKit).</td>
</tr>
<tr>
<td><code><b>TRANSFORM</b></nobr>
</code></td>
<td><code>String</code></td>
<td>Vendor-prefixed transform style name.</td>
</tr>
</table>
<h2 id="posanimation">PosAnimation</h2>
<p>Used internally for panning animations, utilizing CSS3 Transitions for modern browsers and a timer fallback for IE6-9.</p>
<pre><code class="javascript">var fx = new L.PosAnimation();
fx.run(el, [300, 500], 0.5);</code></pre>
<h3>Creation</h3>
<table data-id='posanimation'>
<tr>
<th class="width200">Creation</th>
<th>Description</th>
</tr>
<tr>
<td><code><span class='keyword'>new</span> <b>L.PosAnimation</b>()</code></td>
<td>Creates a PosAnimation object.</td>
</tr>
</table>
<h3>Methods</h3>
<table data-id='posanimation'>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>run</b>(
<nobr><HTMLElement> <i>element</i>,</nobr>
<nobr><<a href="#point">Point</a>> <i>newPos</i></nobr>,
<nobr><Number> <i>duration?</i></nobr>,
<nobr><Number> <i>easeLinearity?</i> )</nobr>
</code></td>
<td><code><span class="hljs-keyword">this</span></code></td>
<td>Runs an animation of a given element to a new position, optionally setting duration in seconds (<code><span class="hljs-number">0.25</span></code> by default) and easing linearity factor (3rd argument of the <a href="http://cubic-bezier.com/#0,0,.5,1">cubic bezier curve</a>, <code><span class="hljs-number">0.5</span></code> by default).</td>
</tr>
</table>
<h3>Events</h3>
<p>You can subscribe to the following events using <a href="#events">these methods</a>.</p>
<table data-id='posanimation'>
<tr>
<th class="width100">Event</th>
<th class="width100">Data</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>start</b></code></td>
<td><code><a href="#event">Event</a></code></td>
<td>Fired when the animation starts.</td>
</tr>
<tr>
<td><code><b>step</b></code></td>
<td><code><a href="#event">Event</a></code></td>
<td>Fired continuously during the animation.</td>
</tr>
<tr>
<td><code><b>end</b></code></td>
<td><code><a href="#event">Event</a></code></td>
<td>Fired when the animation ends.</td>
</tr>
</table>
<h2 id="draggable">Draggable</h2>
<p>A class for making DOM elements draggable (including touch support). Used internally for map and marker dragging. Only works for elements that were positioned with <a href="#domutil-setposition">DomUtil#setPosition</a>.</p>
<pre><code class="javascript">var draggable = new L.Draggable(elementToDrag);
draggable.enable();
</code></pre>
<h3>Creation</h3>
<table data-id='draggable'>
<tr>
<th class="width200">Creation</th>
<th>Description</th>
</tr>
<tr>
<td><code><b><span class='keyword'>new</span> L.Draggable</b>(
<nobr><HTMLElement> <i>element</i>,</nobr>
<nobr><HTMLElement> <i>dragHandle?</i> )</nobr>
</code></td>
<td>Creates a Draggable object for moving the given element when you start dragging the <code>dragHandle</code> element (equals the element itself by default).</td>
</tr>
</table>
<h3>Events</h3>
<p>You can subscribe to the following events using <a href="#events">these methods</a>.</p>
<table data-id='draggable'>
<tr>
<th class="width100">Event</th>
<th class="width100">Data</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>dragstart</b></code></td>
<td><code><a href="#event">Event</a></code></td>
<td>Fired when the dragging starts.</td>
</tr>
<tr>
<td><code><b>predrag</b></code></td>
<td><code><a href="#event">Event</a></code></td>
<td>Fired continuously during dragging <em>before</em> each corresponding update of the element position.</td>
</tr>
<tr>
<td><code><b>drag</b></code></td>
<td><code><a href="#event">Event</a></code></td>
<td>Fired continuously during dragging.</td>
</tr>
<tr>
<td><code><b>dragend</b></code></td>
<td><code><a href="#event">Event</a></code></td>
<td>Fired when the dragging ends.</td>
</tr>
</table>
<h3>Methods</h3>
<table data-id='draggable'>
<tr>
<th class="width100">Method</th>
<th class="width100">Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>enable</b>()</code></td>
<td><code>-</code></td>
<td>Enables the dragging ability.</td>
</tr>
<tr>
<td><code><b>disable</b>()</code></td>
<td><code>-</code></td>
<td>Disables the dragging ability.</td>
</tr>
</table>
<!--<h3>Static Properties</h3>
<table>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>START</b></code></td>
<td><code>String</code></td>
<td>Name of the DOM event that initiates dragging. <code><span class="hljs-string">'mousedown'</span></code> for desktop browsers, <code><span class="hljs-string">'touchstart'</span></code> for mobile devices.</td>
</tr>
<tr>
<td><code><b>MOVE</b></code></td>
<td><code>String</code></td>
<td>Name of the DOM event for drag moving. <code><span class="hljs-string">'mousemove'</span></code> for desktop browsers, <code><span class="hljs-string">'touchmove'</span></code> for mobile devices.</td>
</tr>
<tr>
<td><code><b>END</b></code></td>
<td><code>String</code></td>
<td>Name of the DOM event that ends dragging. <code><span class="hljs-string">'mouseup'</span></code> for desktop browsers, <code><span class="hljs-string">'touchend'</span></code> for mobile devices.</td>
</tr>
</table>-->
<h2 id="ihandler">IHandler</h2>
<p>An interface implemented by <a href="#map-interaction-handlers">interaction handlers</a>.</p>
<table data-id='ihandler'>
<tr>
<th class="width100">Method</th>
<th class="width100">Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>enable</b>()</code></td>
<td>-</td>
<td>Enables the handler.</td>
</tr>
<tr>
<td><code><b>disable</b>()</code></td>
<td>-</td>
<td>Disables the handler.</td>
</tr>
<tr>
<td><code><b>enabled</b>()</code></td>
<td><code>Boolean</code></td>
<td>Returns <code><span class="hljs-literal">true</span></code> if the handler is enabled.</td>
</tr>
</table>
<h2 id="ilayer">ILayer</h2>
<p>Represents an object attached to a particular location (or a set of locations) on a map. Implemented by <a href="#tilelayer">tile layers</a>, <a href="#marker">markers</a>, <a href="#popup">popups</a>, <a href="#imageoverlay">image overlays</a>, <a href="#path">vector layers</a> and <a href="#layergroup">layer groups</a>.</p>
<h3>Methods</h3>
<table data-id='ilayer'>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>onAdd</b>(
<nobr><<a href="#map-class">Map</a>> <i>map</i> )</nobr>
</code></td>
<td>-</td>
<td>Should contain code that creates DOM elements for the overlay, adds them to <a href="#map-panes">map panes</a> where they should belong and puts listeners on relevant map events. Called on <code>map.addLayer(layer)</code>.</td>
</tr>
<tr>
<td><code><b>onRemove</b>(
<nobr><<a href="#map-class">Map</a>> <i>map</i> )</nobr>
</code></td>
<td>-</td>
<td>Should contain all clean up code that removes the overlay's elements from the DOM and removes listeners previously added in <code>onAdd</code>. Called on <code>map.removeLayer(layer)</code>.</td>
</tr>
</table>
<h3>Implementing Custom Layers</h3>
<p>The most important things know about when implementing custom layers are Map <a href="#map-viewreset">viewreset</a> event and <a href="#map-latlngtolayerpoint">latLngToLayerPoint</a> method. <code>viewreset</code> is fired when the map needs to reposition its layers (e.g. on zoom), and <code>latLngToLayerPoint</code> is used to get coordinates for the layer's new position.</p>
<p>Another event often used in layer implementations is <a href="#map-moveend">moveend</a> which fires after any movement of the map (panning, zooming, etc.).</p>
<p>Another thing to note is that you'll usually need to add <code>leaflet-zoom-hide</code> class to the DOM elements you create for the layer so that it hides during zoom animation. Implementing zoom animation for custom layers is a complex topic and will be documented separately in future, but meanwhile you can take a look at how it's done for Leaflet layers (e.g. <code>ImageOverlay</code>) in the source.</p>
<h3>Custom Layer Example</h3>
<p>Here's how a custom layer implementation usually looks:</p>
<pre><code>var MyCustomLayer = L.Class.extend({
initialize: function (latlng) {
// save position of the layer or any options from the constructor
this._latlng = latlng;
},
onAdd: function (map) {
this._map = map;
// create a DOM element and put it into one of the map panes
this._el = L.DomUtil.create('div', 'my-custom-layer leaflet-zoom-hide');
map.getPanes().overlayPane.appendChild(this._el);
// add a viewreset event listener for updating layer's position, do the latter
map.on('viewreset', this._reset, this);
this._reset();
},
onRemove: function (map) {
// remove layer's DOM elements and listeners
map.getPanes().overlayPane.removeChild(this._el);
map.off('viewreset', this._reset, this);
},
_reset: function () {
// update layer's position
var pos = this._map.latLngToLayerPoint(this._latlng);
L.DomUtil.setPosition(this._el, pos);
}
});
map.addLayer(new MyCustomLayer(latlng));
</code></pre>
<h2 id="icontrol">IControl</h2>
<p>Represents a UI element in one of the corners of the map. Implemented by <a href="#control-zoom">zoom</a>, <a href="#control-attribution">attribution</a>, <a href="#control-scale">scale</a> and <a href="#control-layers">layers</a> controls.</p>
<h3>Methods</h3>
<p>Every control in Leaflet should extend from <a href="#control">Control</a> class and additionally have the following methods:</p>
<table data-id='icontrol'>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>onAdd</b>(
<nobr><<a href="#map-class">Map</a>> <i>map</i> )</nobr>
</code></td>
<td><code>HTMLElement</code></td>
<td>Should contain code that creates all the necessary DOM elements for the control, adds listeners on relevant map events, and returns the element containing the control. Called on <code>map.addControl(control)</code> or <code>control.addTo(map)</code>.</td>
</tr>
<tr>
<td><code><b>onRemove</b>(
<nobr><<a href="#map-class">Map</a>> <i>map</i> )</nobr>
</code></td>
<td>-</td>
<td>Optional, should contain all clean up code (e.g. removes control's event listeners). Called on <code>map.removeControl(control)</code> or <code>control.removeFrom(map)</code>. The control's DOM container is removed automatically.</td>
</tr>
</table>
<h3>Custom Control Example</h3>
<pre><code>var MyControl = L.Control.extend({
options: {
position: 'topright'
},
onAdd: function (map) {
// create the control container with a particular class name
var container = L.DomUtil.create('div', 'my-custom-control');
// ... initialize other DOM elements, add listeners, etc.
return container;
}
});
map.addControl(new MyControl());
</code></pre>
<p>If specify your own constructor for the control, you'll also probably want to process options properly:</p>
<pre><code>var MyControl = L.Control.extend({
initialize: function (foo, options) {
// ...
L.Util.setOptions(this, options);
},
// ...
});</code></pre>
<p>This will allow you to pass options like <code>position</code> when creating the control instances:</p>
<pre><code>map.addControl(new MyControl('bar', {position: 'bottomleft'}));</code></pre>
<h2 id="iprojection">IProjection</h2>
<p>An object with methods for projecting geographical coordinates of the world onto a flat surface (and back). See <a href="http://en.wikipedia.org/wiki/Map_projection">Map projection</a>.</p>
<h3>Methods</h3>
<table data-id='iprojection'>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>project</b>(
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i> )</nobr>
</code></td>
<td><code><a href="#point">Point</a></code></td>
<td>Projects geographical coordinates into a 2D point.</td>
</tr>
<tr>
<td><code><b>unproject</b>(
<nobr><<a href="#point">Point</a>> <i>point</i> )</nobr>
</code></td>
<td><code><a href="#latlng">LatLng</a></code></td>
<td>The inverse of <code>project</code>. Projects a 2D point into geographical location.</td>
</tr>
</table>
<h3>Defined Projections</h3>
<p>Leaflet comes with a set of already defined projections out of the box:</p>
<table data-id='projections'>
<tr>
<th>Projection</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>L.Projection.SphericalMercator</b></code></td>
<td>Spherical Mercator projection — the most common projection for online maps, used by almost all free and commercial tile providers. Assumes that Earth is a sphere. Used by the <code>EPSG:3857</code> CRS.</td>
</tr>
<tr>
<td><code><b>L.Projection.Mercator</b></code></td>
<td>Elliptical Mercator projection — more complex than Spherical Mercator. Takes into account that Earth is a geoid, not a perfect sphere. Used by the <code>EPSG:3395</code> CRS.</td>
</tr>
<tr>
<td><code><b>L.Projection.LonLat</b></code></td>
<td>Equirectangular, or Plate Carree projection — the most simple projection, mostly used by GIS enthusiasts. Directly maps <code>x</code> as longitude, and <code>y</code> as latitude. Also suitable for flat worlds, e.g. game maps. Used by the <code>EPSG:3395</code> and <code>Simple</code> CRS.</td>
</tr>
</table>
<h2 id="icrs">ICRS</h2>
<p>Defines coordinate reference systems for projecting geographical points into pixel (screen) coordinates and back (and to coordinates in other units for WMS services). See <a href="http://en.wikipedia.org/wiki/Coordinate_reference_system">Spatial reference system</a>.</p>
<h3>Methods</h3>
<table data-id='icrs'>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>latLngToPoint</b>(
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i></nobr>,
<nobr><Number> <i>zoom</i> )</nobr>
</code></td>
<td><code><a href="#point">Point</a></code></td>
<td>Projects geographical coordinates on a given zoom into pixel coordinates.</td>
</tr>
<tr>
<td><code><b>pointToLatLng</b>(
<nobr><<a href="#point">Point</a>> <i>point</i></nobr>,
<nobr><Number> <i>zoom</i> )</nobr>
</code></td>
<td><code><a href="#latlng">LatLng</a></code></td>
<td>The inverse of <code>latLngToPoint</code>. Projects pixel coordinates on a given zoom into geographical coordinates.</td>
</tr>
<tr>
<td><code><b>project</b>(
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i> )</nobr>
</code></td>
<td><code><a href="#point">Point</a></code></td>
<td>Projects geographical coordinates into coordinates in units accepted for this CRS (e.g. meters for <code>EPSG:3857</code>, for passing it to WMS services).</td>
</tr>
<tr>
<td><code><b>scale</b>(
<nobr><Number> <i>zoom</i> )</nobr>
</code></td>
<td><code>Number</code></td>
<td>Returns the scale used when transforming projected coordinates into pixel coordinates for a particular zoom. For example, it returns <code>256 * 2^zoom</code> for Mercator-based CRS.</td>
</tr>
<tr>
<td><code><b>getSize</b>(
<nobr><Number> <i>zoom</i> )</nobr>
</code></td>
<td><code><a href="#point">Point</a></code></td>
<td>Returns the size of the world in pixels for a particular zoom.</td>
</tr>
</table>
<h3>Properties</h3>
<table data-id='icrs'>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>projection</b></code></td>
<td><code><a href="#iprojection">IProjection</a></code></td>
<td>Projection that this CRS uses.</td>
</tr>
<tr>
<td><code><b>transformation</b></code></td>
<td><code><a href="#transformation">Transformation</a></code></td>
<td>Transformation that this CRS uses to turn projected coordinates into screen coordinates for a particular tile service.</td>
</tr>
<tr>
<td><code><b>code</b></code></td>
<td><code>String</code></td>
<td>Standard code name of the CRS passed into WMS services (e.g. <code><span class="hljs-string">'EPSG:3857'</span></code>).</td>
</tr>
</table>
<h3>Defined CRS</h3>
<p>Leaflet comes with a set of already defined CRS to use out of the box:</p>
<table data-id='defined-crs'>
<tr>
<th>Projection</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>L.CRS.EPSG3857</b></code></td>
<td>The most common CRS for online maps, used by almost all free and commercial tile providers. Uses Spherical Mercator projection. Set in by default in Map's <code>crs</code> option.</td>
</tr>
<tr>
<td><code><b>L.CRS.EPSG4326</b></code></td>
<td>A common CRS among GIS enthusiasts. Uses simple Equirectangular projection.</td>
</tr>
<tr>
<td><code><b>L.CRS.EPSG3395</b></code></td>
<td>Rarely used by some commercial tile providers. Uses Elliptical Mercator projection.</td>
</tr>
<tr>
<td><code><b>L.CRS.Simple</b></code></td>
<td>A simple CRS that maps longitude and latitude into <code>x</code> and <code>y</code> directly. May be used for maps of flat surfaces (e.g. game maps). Note that the <code>y</code> axis should still be inverted (going from bottom to top).</td>
</tr>
</table>
<p>If you want to use some obscure CRS not listed here, take a look at the <a href="https://github.com/kartena/Proj4Leaflet">Proj4Leaflet</a> plugin.</p>
<h2 id="global">Global Switches</h2>
<p>Global switches are created for rare cases and generally make Leaflet to not detect a particular browser feature even if it's there. You need to set the switch as a global variable to <code><span class="hljs-literal">true</span></code> <em>before</em> including Leaflet on the page, like this:</p>
<pre><code><script>L_PREFER_CANVAS = true;</script>
<script src="leaflet.js"></script></code></pre>
<table data-id='global'>
<tr>
<th>Switch</th>
<th>Description</th>
</tr>
<tr>
<td><code><b>L_PREFER_CANVAS</b></code></td>
<td>Forces Leaflet to use the Canvas back-end (if available) for vector layers instead of SVG. This can increase performance considerably in some cases (e.g. many thousands of circle markers on the map).</td>
</tr>
<tr>
<td><code><b>L_NO_TOUCH</b></code></td>
<td>Forces Leaflet to not use touch events even if it detects them.</td>
</tr>
<tr>
<td><code><b>L_DISABLE_3D</b></code></td>
<td>Forces Leaflet to not use hardware-accelerated CSS 3D transforms for positioning (which may cause glitches in some rare environments) even if they're supported.</td>
</tr>
</table>
<h2 id="noconflict">noConflict</h2>
<p>This method restores the L global variable to the original value it had before Leaflet inclusion, and returns the real Leaflet namespace so you can put it elsewhere, like this:<p>
<pre><code>// L points to some other library
...
// you include Leaflet, it replaces the L variable to Leaflet namespace
var Leaflet = L.noConflict();
// now L points to that other library again, and you can use Leaflet.Map etc.</code></pre>
<h2 id="version">version</h2>
<p>A constant that represents the Leaflet version in use.<p>
<pre><code>L.version // contains "0.5" (or whatever version is currently in use)</code></pre>
<script>
var tables = document.getElementsByTagName('table');
for (var i = 0, len = tables.length; i < len; i++) {
var id = tables[i].getAttribute('data-id'),
tds = tables[i].getElementsByTagName('td');
for (var j = 0, tdLen = tds.length; j < tdLen; j++) {
if (tds[j].cellIndex === 0) {
tds[j].parentNode.id = id + '-' + (tds[j].textContent || tds[j].innerText).split('(')[0].toLowerCase();
tds[j].parentNode.onclick = function(e) {
if (e.offsetX < 0) {
window.location.hash = '#' + this.id;
}
};
}
}
}
</script>
|