File size: 425,460 Bytes
0ab8308 | 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 | {
"metadata": {
"repo_name": "Chart.js",
"repo_url": "https://github.com/chartjs/Chart.js",
"commit_id": "6372280085625b43ef34d7b70f3e86b063d22a10"
},
"docs_tree": {
"title": "Chart.js",
"description": "Documentation for Chart.js",
"subpages": [
{
"title": "Chart.js",
"path": "[\"subpages\", 0]",
"content": {
"Why Chart.js": {
"Features": "<detail_content>",
"Defaults": "<detail_content>",
"Integrations": "<detail_content>",
"Developer experience": "<detail_content>",
"Canvas rendering": "<detail_content>",
"Performance": "<detail_content>",
"Community": "<detail_content>"
}
}
},
{
"title": "Axes",
"description": "Documentation section: axes",
"path": "[\"subpages\", 1]",
"subpages": [
{
"title": " Common",
"path": "[\"subpages\", 1, \"subpages\", 0]",
"content": {
"Common options to all axes": "<detail_content>"
}
},
{
"title": " Common Ticks",
"path": "[\"subpages\", 1, \"subpages\", 1]",
"content": {
"Common tick options to all axes": "<detail_content>"
}
},
{
"title": "Axes",
"path": "[\"subpages\", 1, \"subpages\", 2]",
"content": {
"Default scales": "<detail_content>",
"Common Configuration": "<detail_content>",
"Tick Configuration": "<detail_content>",
"Axis Range Settings": "<detail_content>",
"Stacking": "<detail_content>",
"Callbacks": {
"Updating Axis Defaults": "<detail_content>"
},
"Creating New Axes": "<detail_content>"
}
},
{
"title": "Labeling Axes",
"path": "[\"subpages\", 1, \"subpages\", 3]",
"content": {
"Scale Title Configuration": "<detail_content>",
"Creating Custom Tick Formats": "<detail_content>"
}
},
{
"title": "Styling",
"path": "[\"subpages\", 1, \"subpages\", 4]",
"content": {
"Grid Line Configuration": "<detail_content>",
"Tick Configuration": "<detail_content>",
"Major Tick Configuration": "<detail_content>",
"Border Configuration": "<detail_content>"
}
},
{
"title": "Cartesian",
"description": "Documentation section: cartesian",
"path": "[\"subpages\", 1, \"subpages\", 5]",
"subpages": [
{
"title": " Common",
"path": "[\"subpages\", 1, \"subpages\", 5, \"subpages\", 0]",
"content": {
"Common options to all cartesian axes": "<detail_content>"
}
},
{
"title": " Common Ticks",
"path": "[\"subpages\", 1, \"subpages\", 5, \"subpages\", 1]",
"content": {
"Common tick options to all cartesian axes": "<detail_content>"
}
},
{
"title": "Category Axis",
"path": "[\"subpages\", 1, \"subpages\", 5, \"subpages\", 2]",
"content": {
"Category Axis Definition": "<detail_content>",
"Configuration Options": {
"Category Axis specific options": "<detail_content>"
},
"Tick Configuration": "<detail_content>",
"Min Max Configuration": "<detail_content>",
"Internal data format": "<detail_content>"
}
},
{
"title": "Cartesian Axes",
"path": "[\"subpages\", 1, \"subpages\", 5, \"subpages\", 3]",
"content": {
"Visual Components": {
"Border": "<detail_content>",
"Grid lines": "<detail_content>",
"Ticks and Tick Marks": "<detail_content>",
"Title": "<detail_content>"
},
"Common Configuration": {
"Axis Position": "<detail_content>",
"Scale Bounds": "<detail_content>",
"Tick Configuration": "<detail_content>",
"Tick Alignment": "<detail_content>",
"Axis ID": "<detail_content>"
},
"Creating Multiple Axes": "<detail_content>"
}
},
{
"title": "Linear Axis",
"path": "[\"subpages\", 1, \"subpages\", 5, \"subpages\", 4]",
"content": {
"Configuration Options": {
"Linear Axis specific options": "<detail_content>"
},
"Tick Configuration": {
"Linear Axis specific tick options": "<detail_content>"
},
"Step Size": "<detail_content>",
"Grace": "<detail_content>",
"Internal data format": "<detail_content>"
}
},
{
"title": "Logarithmic Axis",
"path": "[\"subpages\", 1, \"subpages\", 5, \"subpages\", 5]",
"content": {
"Configuration Options": "<detail_content>",
"Tick Configuration": {
"Logarithmic Axis specific options": "<detail_content>"
},
"Internal data format": "<detail_content>"
}
},
{
"title": "Time Cartesian Axis",
"path": "[\"subpages\", 1, \"subpages\", 5, \"subpages\", 6]",
"content": {
"Date Adapters": "<detail_content>",
"Data Sets": {
"Input Data": "<detail_content>",
"Date Formats": "<detail_content>"
},
"Configuration Options": {
"Time Axis specific options": {
"Time Units": "<detail_content>",
"Display Formats": "<detail_content>",
"Ticks Source": "<detail_content>",
"Parser": "<detail_content>"
}
},
"Min Max Configuration": "<detail_content>",
"Changing the scale type from Time scale to Logarithmic/Linear scale.": "<detail_content>",
"Internal data format": "<detail_content>"
}
},
{
"title": "Time Series Axis",
"path": "[\"subpages\", 1, \"subpages\", 5, \"subpages\", 7]",
"content": {
"Example": "<detail_content>",
"More details": "<detail_content>"
}
}
]
},
{
"title": "Radial",
"description": "Documentation section: radial",
"path": "[\"subpages\", 1, \"subpages\", 6]",
"subpages": [
{
"title": "Radial Axes",
"path": "[\"subpages\", 1, \"subpages\", 6, \"subpages\", 0]",
"content": {
"Visual Components": {
"Angle Lines": "<detail_content>",
"Grid Lines": "<detail_content>",
"Point Labels": "<detail_content>",
"Ticks": "<detail_content>"
}
}
},
{
"title": "Linear Radial Axis",
"path": "[\"subpages\", 1, \"subpages\", 6, \"subpages\", 1]",
"content": {
"Configuration Options": {
"Linear Radial Axis specific options": "<detail_content>",
"Common options for all axes": "<detail_content>"
},
"Tick Configuration": {
"Linear Radial Axis specific tick options": "<detail_content>"
},
"Grid Line Configuration": "<detail_content>",
"Axis Range Settings": "<detail_content>",
"Step Size": "<detail_content>",
"Angle Line Options": "<detail_content>",
"Point Label Options": "<detail_content>",
"Internal data format": "<detail_content>"
}
}
]
}
]
},
{
"title": "Charts",
"description": "Documentation section: charts",
"path": "[\"subpages\", 2]",
"subpages": [
{
"title": "Area Chart",
"path": "[\"subpages\", 2, \"subpages\", 0]",
"content": {
"Filling modes": {
"Example": "<detail_content>",
"Example with multiple colors": "<detail_content>"
},
"Configuration": {
"propagate": {
"Example using propagate": "<detail_content>"
}
}
}
},
{
"title": "Bar Chart",
"path": "[\"subpages\", 2, \"subpages\", 1]",
"content": {
"Dataset Properties": {
"Example dataset configuration": "<detail_content>",
"General": "<detail_content>",
"Styling": {
"borderSkipped": "<detail_content>",
"borderWidth": "<detail_content>",
"borderRadius": "<detail_content>",
"inflateAmount": "<detail_content>"
},
"Interactions": "<detail_content>",
"barPercentage": "<detail_content>",
"categoryPercentage": "<detail_content>",
"barThickness": "<detail_content>",
"maxBarThickness": "<detail_content>"
},
"Scale Configuration": {
"Example scale configuration": "<detail_content>",
"Offset Grid Lines": "<detail_content>"
},
"Default Options": "<detail_content>",
"barPercentage vs categoryPercentage": "<detail_content>",
"Data Structure": "<detail_content>",
"Stacked Bar Chart": "<detail_content>",
"Horizontal Bar Chart": {
"Horizontal Bar Chart config Options": "<detail_content>"
},
"Internal data format": "<detail_content>"
}
},
{
"title": "Bubble Chart",
"path": "[\"subpages\", 2, \"subpages\", 2]",
"content": {
"Dataset Properties": {
"General": "<detail_content>",
"Styling": "<detail_content>",
"Interactions": "<detail_content>"
},
"Default Options": "<detail_content>",
"Data Structure": "<detail_content>",
"Internal data format": "<detail_content>"
}
},
{
"title": "Doughnut and Pie Charts",
"path": "[\"subpages\", 2, \"subpages\", 3]",
"content": {
"Dataset Properties": {
"General": "<detail_content>",
"Styling": "<detail_content>",
"Border Alignment": "<detail_content>",
"Border Radius": "<detail_content>",
"Interactions": "<detail_content>"
},
"Config Options": "<detail_content>",
"Default Options": "<detail_content>",
"Data Structure": "<detail_content>"
}
},
{
"title": "Line Chart",
"path": "[\"subpages\", 2, \"subpages\", 4]",
"content": {
"Dataset Properties": {
"General": "<detail_content>",
"Point Styling": "<detail_content>",
"Line Styling": "<detail_content>",
"Interactions": "<detail_content>",
"cubicInterpolationMode": "<detail_content>",
"Segment": "<detail_content>",
"Stepped": "<detail_content>"
},
"Default Options": "<detail_content>",
"Data Structure": "<detail_content>",
"Stacked Area Chart": "<detail_content>",
"Vertical Line Chart": {
"Config Options": "<detail_content>"
},
"Internal data format": "<detail_content>"
}
},
{
"title": "Mixed Chart Types",
"path": "[\"subpages\", 2, \"subpages\", 5]",
"content": {
"Drawing order": "<detail_content>"
}
},
{
"title": "Polar Area Chart",
"path": "[\"subpages\", 2, \"subpages\", 6]",
"content": {
"Dataset Properties": {
"General": "<detail_content>",
"Styling": "<detail_content>",
"Border Alignment": "<detail_content>",
"Interactions": "<detail_content>"
},
"Config Options": "<detail_content>",
"Default Options": "<detail_content>",
"Data Structure": "<detail_content>"
}
},
{
"title": "Radar Chart",
"path": "[\"subpages\", 2, \"subpages\", 7]",
"content": {
"Dataset Properties": {
"General": "<detail_content>",
"Point Styling": "<detail_content>",
"Line Styling": "<detail_content>",
"Interactions": "<detail_content>"
},
"Scale Options": "<detail_content>",
"Default Options": "<detail_content>",
"Data Structure": "<detail_content>",
"Internal data format": "<detail_content>"
}
},
{
"title": "Scatter Chart",
"path": "[\"subpages\", 2, \"subpages\", 8]",
"content": {
"Dataset Properties": "<detail_content>",
"Data Structure": "<detail_content>",
"Internal data format": "<detail_content>"
}
}
]
},
{
"title": "Configuration",
"description": "Documentation section: configuration",
"path": "[\"subpages\", 3]",
"subpages": [
{
"title": "Animations",
"path": "[\"subpages\", 3, \"subpages\", 0]",
"content": {
"Animation configuration": "<detail_content>",
"animation": "<detail_content>",
"animations": {
"Default animations": "<detail_content>"
},
"transitions": {
"Default transitions": "<detail_content>"
},
"Disabling animation": "<detail_content>",
"Easing": "<detail_content>",
"Animation Callbacks": "<detail_content>"
}
},
{
"title": "Canvas Background",
"path": "[\"subpages\", 3, \"subpages\", 1]",
"content": {
"Canvas background": "<detail_content>"
}
},
{
"title": "Data Decimation",
"path": "[\"subpages\", 3, \"subpages\", 2]",
"content": {
"Configuration Options": "<detail_content>",
"Decimation Algorithms": {
"Largest Triangle Three Bucket (LTTB) Decimation": "<detail_content>",
"Min/Max Decimation": "<detail_content>"
},
"Requirements": "<detail_content>",
"Related Samples": "<detail_content>"
}
},
{
"title": "Device Pixel Ratio",
"path": "[\"subpages\", 3, \"subpages\", 3]",
"content": {
"Configuration Options": "<detail_content>"
}
},
{
"title": "Elements",
"path": "[\"subpages\", 3, \"subpages\", 4]",
"content": {
"Global Configuration": "<detail_content>",
"Point Configuration": {
"Point Styles": {
"Types": "<detail_content>",
"Info": "<detail_content>"
}
},
"Line Configuration": "<detail_content>",
"Bar Configuration": "<detail_content>",
"Arc Configuration": "<detail_content>"
}
},
{
"title": "Configuration",
"path": "[\"subpages\", 3, \"subpages\", 5]",
"content": {
"Configuration object structure": {
"type": "<detail_content>",
"data": "<detail_content>",
"options": "<detail_content>",
"plugins": "<detail_content>"
},
"Global Configuration": "<detail_content>",
"Dataset Configuration": "<detail_content>"
}
},
{
"title": "Interactions",
"path": "[\"subpages\", 3, \"subpages\", 6]",
"content": {
"Events": {
"Event Option": "<detail_content>",
"Converting Events to Data Values": "<detail_content>"
},
"Modes": {
"point": "<detail_content>",
"nearest": "<detail_content>",
"index": "<detail_content>",
"dataset": "<detail_content>",
"x": "<detail_content>",
"y": "<detail_content>"
},
"Custom Interaction Modes": "<detail_content>"
}
},
{
"title": "Layout",
"path": "[\"subpages\", 3, \"subpages\", 7]",
"content": {
"Layout": "<detail_content>"
}
},
{
"title": "Legend",
"path": "[\"subpages\", 3, \"subpages\", 8]",
"content": {
"Configuration options": "<detail_content>",
"Position": "<detail_content>",
"Align": "<detail_content>",
"Legend Label Configuration": "<detail_content>",
"Legend Title Configuration": "<detail_content>",
"Legend Item Interface": "<detail_content>",
"Example": "<detail_content>",
"Custom On Click Actions": "<detail_content>"
}
},
{
"title": "Locale",
"path": "[\"subpages\", 3, \"subpages\", 9]",
"content": {
"Configuration Options": "<detail_content>"
}
},
{
"title": "Responsive Charts",
"path": "[\"subpages\", 3, \"subpages\", 10]",
"content": {
"Configuration Options": "<detail_content>",
"Important Note": "<detail_content>",
"Printing Resizable Charts": "<detail_content>"
}
},
{
"title": "Subtitle",
"path": "[\"subpages\", 3, \"subpages\", 11]",
"content": {
"Subtitle Configuration": "<detail_content>",
"Example Usage": "<detail_content>"
}
},
{
"title": "Title",
"path": "[\"subpages\", 3, \"subpages\", 12]",
"content": {
"Title Configuration": {
"Position": "<detail_content>"
},
"Align": "<detail_content>",
"Example Usage": "<detail_content>"
}
},
{
"title": "Tooltip",
"path": "[\"subpages\", 3, \"subpages\", 13]",
"content": {
"Tooltip Configuration": {
"Position Modes": "<detail_content>",
"Tooltip Alignment": "<detail_content>",
"Text Alignment": "<detail_content>",
"Sort Callback": "<detail_content>",
"Filter Callback": "<detail_content>"
},
"Tooltip Callbacks": {
"Label Callback": "<detail_content>",
"Label Color Callback": "<detail_content>",
"Label Point Style Callback": "<detail_content>",
"Tooltip Item Context": "<detail_content>"
},
"External (Custom) Tooltips": "<detail_content>",
"Tooltip Model": "<detail_content>",
"Custom Position Modes": "<detail_content>",
"Default font overrides": "<detail_content>"
}
}
]
},
{
"title": "Developers",
"description": "Documentation section: developers",
"path": "[\"subpages\", 4]",
"subpages": [
{
"title": "API",
"path": "[\"subpages\", 4, \"subpages\", 0]",
"content": {
".destroy()": "<detail_content>",
".update(mode?)": "<detail_content>",
".reset()": "<detail_content>",
".render()": "<detail_content>",
".stop()": "<detail_content>",
".resize(width?, height?)": "<detail_content>",
".clear()": "<detail_content>",
".toBase64Image(type?, quality?)": "<detail_content>",
".getElementsAtEventForMode(e, mode, options, useFinalPosition)": "<detail_content>",
".getSortedVisibleDatasetMetas()": "<detail_content>",
".getDatasetMeta(index)": "<detail_content>",
"getVisibleDatasetCount": "<detail_content>",
"isDatasetVisible(datasetIndex)": "<detail_content>",
"setDatasetVisibility(datasetIndex, visibility)": "<detail_content>",
"toggleDataVisibility(index)": "<detail_content>",
"getDataVisibility(index)": "<detail_content>",
"hide(datasetIndex, dataIndex?)": "<detail_content>",
"show(datasetIndex, dataIndex?)": "<detail_content>",
"setActiveElements(activeElements)": "<detail_content>",
"isPluginEnabled(pluginId)": "<detail_content>",
"Static: getChart(key)": "<detail_content>",
"Static: register(chartComponentLike)": "<detail_content>",
"Static: unregister(chartComponentLike)": "<detail_content>"
}
},
{
"title": "New Axes",
"path": "[\"subpages\", 4, \"subpages\", 1]",
"content": {
"Scale Properties": "<detail_content>",
"Scale Interface": "<detail_content>"
}
},
{
"title": "New Charts",
"path": "[\"subpages\", 4, \"subpages\", 2]",
"content": {
"Dataset Controller Interface": "<detail_content>",
"Extending Existing Chart Types": "<detail_content>",
"TypeScript Typings": "<detail_content>"
}
},
{
"title": "Contributing",
"path": "[\"subpages\", 4, \"subpages\", 3]",
"content": {
"Joining the project": "<detail_content>",
"Building and Testing": {
"Documentation": "<detail_content>",
"Image-Based Tests": "<detail_content>"
},
"Bugs and Issues": "<detail_content>"
}
},
{
"title": "Developers",
"path": "[\"subpages\", 4, \"subpages\", 4]",
"content": {
"Latest resources": "<detail_content>",
"Development releases": "<detail_content>",
"Browser support": "<detail_content>",
"Previous versions": "<detail_content>"
}
},
{
"title": "Plugins",
"path": "[\"subpages\", 4, \"subpages\", 5]",
"content": {
"Using plugins": "<detail_content>",
"Global plugins": "<detail_content>",
"Configuration": {
"Plugin ID": "<detail_content>",
"Plugin options": {
"Disable plugins": "<detail_content>",
"Plugin defaults": "<detail_content>"
}
},
"Plugin Core API": {
"Chart Initialization": "<detail_content>",
"Chart Update": "<detail_content>",
"Scale Update": "<detail_content>",
"Rendering": "<detail_content>",
"Event Handling": "<detail_content>",
"Chart destroy": "<detail_content>"
},
"TypeScript Typings": "<detail_content>"
}
},
{
"title": "Publishing an extension",
"path": "[\"subpages\", 4, \"subpages\", 6]",
"content": {
"Awesome": "<detail_content>",
"ESM": {
"Rollup": "<detail_content>"
}
}
},
{
"title": "Updating Charts",
"path": "[\"subpages\", 4, \"subpages\", 7]",
"content": {
"Adding or Removing Data": "<detail_content>",
"Updating Options": "<detail_content>",
"Preventing Animations": "<detail_content>"
}
}
]
},
{
"title": "General",
"description": "Documentation section: general",
"path": "[\"subpages\", 5]",
"subpages": [
{
"title": "Accessibility",
"path": "[\"subpages\", 5, \"subpages\", 0]",
"content": {
"Examples": "<detail_content>"
}
},
{
"title": "Colors",
"path": "[\"subpages\", 5, \"subpages\", 1]",
"content": {
"Default colors": {
"Per-dataset color settings": "<detail_content>",
"Default color palette": "<detail_content>",
"Dynamic datasets at runtime": "<detail_content>",
"Advanced color palettes": "<detail_content>"
},
"Color formats": "<detail_content>",
"Patterns and Gradients": "<detail_content>"
}
},
{
"title": "Data structures",
"path": "[\"subpages\", 5, \"subpages\", 2]",
"content": {
"Primitive[]": "<detail_content>",
"Array[]": "<detail_content>",
"Object[]": "<detail_content>",
"Object[] using custom properties": "<detail_content>",
"Object": "<detail_content>",
"Dataset Configuration": {
"parsing": "<detail_content>"
},
"TypeScript": "<detail_content>"
}
},
{
"title": "Fonts",
"path": "[\"subpages\", 5, \"subpages\", 3]",
"content": {
"Missing Fonts": "<detail_content>",
"Loading Fonts": "<detail_content>"
}
},
{
"title": "Options",
"path": "[\"subpages\", 5, \"subpages\", 4]",
"content": {
"Option resolution": {
"Chart level options": "<detail_content>",
"Dataset level options": "<detail_content>",
"Dataset animation options": "<detail_content>",
"Dataset element level options": "<detail_content>",
"Scale options": "<detail_content>",
"Plugin options": "<detail_content>"
},
"Scriptable Options": "<detail_content>",
"Indexable Options": "<detail_content>",
"Option Context": {
"chart": "<detail_content>",
"dataset": "<detail_content>",
"data": "<detail_content>",
"scale": "<detail_content>",
"tick": "<detail_content>",
"pointLabel": "<detail_content>",
"tooltip": "<detail_content>"
}
}
},
{
"title": "Padding",
"path": "[\"subpages\", 5, \"subpages\", 5]",
"content": {
"Number": "<detail_content>",
"{top, left, bottom, right} object": "<detail_content>",
"{x, y} object": "<detail_content>"
}
},
{
"title": "Performance",
"path": "[\"subpages\", 5, \"subpages\", 6]",
"content": {
"Data structure and format": {
"Parsing": "<detail_content>",
"Data normalization": "<detail_content>",
"Decimation": "<detail_content>"
},
"Tick Calculation": {
"Rotation": "<detail_content>",
"Sampling": "<detail_content>"
},
"Disable Animations": "<detail_content>",
"Specify `min` and `max` for scales": "<detail_content>",
"Parallel rendering with web workers": "<detail_content>",
"Line Charts": {
"Leave B\u00e9zier curves disabled": "<detail_content>",
"Automatic data decimation during draw": "<detail_content>",
"Enable spanGaps": "<detail_content>",
"Disable Line Drawing": "<detail_content>",
"Disable Point Drawing": "<detail_content>"
},
"When transpiling with Babel, consider using `loose` mode": "<detail_content>"
}
}
]
},
{
"title": "Getting Started",
"description": "Documentation section: getting-started",
"path": "[\"subpages\", 6]",
"subpages": [
{
"title": "Getting Started",
"path": "[\"subpages\", 6, \"subpages\", 0]",
"content": {
"Create a Chart": "<detail_content>"
}
},
{
"title": "Installation",
"path": "[\"subpages\", 6, \"subpages\", 1]",
"content": {
"npm": "<detail_content>",
"CDN": {
"CDNJS": "<detail_content>",
"jsDelivr": "<detail_content>"
},
"GitHub": "<detail_content>"
}
},
{
"title": "Integration",
"path": "[\"subpages\", 6, \"subpages\", 2]",
"content": {
"Script Tag": "<detail_content>",
"Bundlers (Webpack, Rollup, etc.)": {
"Quick start": "<detail_content>",
"Bundle optimization": "<detail_content>",
"Helper functions": "<detail_content>"
},
"CommonJS": "<detail_content>",
"RequireJS": "<detail_content>"
}
},
{
"title": "Step-by-step guide",
"path": "[\"subpages\", 6, \"subpages\", 3]",
"content": {
"Build a new application with Chart.js": {
"Simple customizations": "<detail_content>",
"Real-world data": "<detail_content>",
"Further customizations": "<detail_content>",
"Multiple datasets": "<detail_content>",
"Plugins": "<detail_content>",
"Tree-shaking": "<detail_content>"
},
"Next steps": "<detail_content>"
}
},
{
"title": "Using From Node Js",
"path": "[\"subpages\", 6, \"subpages\", 4]",
"content": {
"Using from Node.js": "<detail_content>"
}
}
]
},
{
"title": "Migration",
"description": "Documentation section: migration",
"path": "[\"subpages\", 7]",
"subpages": [
{
"title": "3.x Migration Guide",
"path": "[\"subpages\", 7, \"subpages\", 0]",
"content": {
"End user migration": {
"Setup and installation": "<detail_content>",
"Chart types": "<detail_content>",
"Options": {
"Generic changes": "<detail_content>",
"Specific changes": "<detail_content>",
"Defaults": "<detail_content>",
"Scales": "<detail_content>",
"Animations": "<detail_content>",
"Customizability": "<detail_content>",
"Interactions": "<detail_content>",
"Ticks": "<detail_content>",
"Tooltip": "<detail_content>"
}
},
"Developer migration": {
"Removed": {
"Removed from Chart": "<detail_content>",
"Removed from Dataset Controllers": "<detail_content>",
"Removed from Elements": "<detail_content>",
"Removed from Helpers": "<detail_content>",
"Removed from Layout": "<detail_content>",
"Removed from Scales": "<detail_content>",
"Removed from Plugins (Legend, Title, and Tooltip)": "<detail_content>",
"Removal of Public APIs": "<detail_content>",
"Removal of private APIs": "<detail_content>"
},
"Renamed": {
"Renamed private APIs": "<detail_content>"
},
"Changed": {
"Changed in Scales": {
"Changed in Ticks": "<detail_content>",
"Changed in Time Scale": "<detail_content>"
},
"Changed in Controllers": {
"Core Controller": "<detail_content>",
"Dataset Controllers": "<detail_content>"
},
"Changed in Interactions": "<detail_content>",
"Changed in Layout": "<detail_content>",
"Changed in Helpers": {
"Canvas Helper": "<detail_content>"
},
"Changed in Platform": "<detail_content>",
"Changed in IPlugin interface": "<detail_content>"
}
}
}
},
{
"title": "4.x Migration Guide",
"path": "[\"subpages\", 7, \"subpages\", 1]",
"content": {
"End user migration": {
"Charts": "<detail_content>",
"Options": {
"Specific changes": "<detail_content>",
"Type changes": "<detail_content>"
},
"General": "<detail_content>"
}
}
}
]
},
{
"title": "Samples",
"description": "Documentation section: samples",
"path": "[\"subpages\", 8]",
"subpages": [
{
"title": "Chart.js Samples",
"path": "[\"subpages\", 8, \"subpages\", 0]",
"content": {
"Out of the box working samples": "<detail_content>",
"Autogenerated data": "<detail_content>",
"Actions block": "<detail_content>"
}
},
{
"title": "Utils",
"path": "[\"subpages\", 8, \"subpages\", 1]",
"content": {
"Disclaimer": "<detail_content>",
"Functions": "<detail_content>",
"Components": "<detail_content>"
}
},
{
"title": "Advanced",
"description": "Documentation section: advanced",
"path": "[\"subpages\", 8, \"subpages\", 2]",
"subpages": [
{
"title": "Data Decimation",
"path": "[\"subpages\", 8, \"subpages\", 2, \"subpages\", 0]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Derived Axis Type",
"path": "[\"subpages\", 8, \"subpages\", 2, \"subpages\", 1]",
"content": {
"Log2 axis implementation": "<detail_content>",
"Docs": "<detail_content>"
}
},
{
"title": "Derived Chart Type",
"path": "[\"subpages\", 8, \"subpages\", 2, \"subpages\", 2]",
"content": {
"DerivedBubble Implementation": "<detail_content>",
"Docs": "<detail_content>"
}
},
{
"title": "Linear Gradient",
"path": "[\"subpages\", 8, \"subpages\", 2, \"subpages\", 3]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Programmatic Event Triggers",
"path": "[\"subpages\", 8, \"subpages\", 2, \"subpages\", 4]",
"content": {
"API": "<detail_content>",
"Docs": "<detail_content>"
}
},
{
"title": "Animation Progress Bar",
"path": "[\"subpages\", 8, \"subpages\", 2, \"subpages\", 5]",
"content": {
"Initial animation": "<detail_content>",
"Other animations": "<detail_content>",
"Docs": "<detail_content>"
}
},
{
"title": "Radial Gradient",
"path": "[\"subpages\", 8, \"subpages\", 2, \"subpages\", 6]",
"content": {
"Docs": "<detail_content>"
}
}
]
},
{
"title": "Animations",
"description": "Documentation section: animations",
"path": "[\"subpages\", 8, \"subpages\", 3]",
"subpages": [
{
"title": "Delay",
"path": "[\"subpages\", 8, \"subpages\", 3, \"subpages\", 0]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Drop",
"path": "[\"subpages\", 8, \"subpages\", 3, \"subpages\", 1]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Loop",
"path": "[\"subpages\", 8, \"subpages\", 3, \"subpages\", 2]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Progressive Line With Easing",
"path": "[\"subpages\", 8, \"subpages\", 3, \"subpages\", 3]",
"content": {
"Api ": "<detail_content>",
"Docs": "<detail_content>"
}
},
{
"title": "Progressive Line",
"path": "[\"subpages\", 8, \"subpages\", 3, \"subpages\", 4]",
"content": {
"Api ": "<detail_content>",
"Docs": "<detail_content>"
}
}
]
},
{
"title": "Area",
"description": "Documentation section: area",
"path": "[\"subpages\", 8, \"subpages\", 4]",
"subpages": [
{
"title": "Line Chart Boundaries",
"path": "[\"subpages\", 8, \"subpages\", 4, \"subpages\", 0]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Line Chart Datasets",
"path": "[\"subpages\", 8, \"subpages\", 4, \"subpages\", 1]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Line Chart drawTime",
"path": "[\"subpages\", 8, \"subpages\", 4, \"subpages\", 2]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Line Chart Stacked",
"path": "[\"subpages\", 8, \"subpages\", 4, \"subpages\", 3]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Radar Chart Stacked",
"path": "[\"subpages\", 8, \"subpages\", 4, \"subpages\", 4]",
"content": {
"Docs": "<detail_content>"
}
}
]
},
{
"title": "Bar",
"description": "Documentation section: bar",
"path": "[\"subpages\", 8, \"subpages\", 5]",
"subpages": [
{
"title": "Bar Chart Border Radius",
"path": "[\"subpages\", 8, \"subpages\", 5, \"subpages\", 0]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Floating Bars",
"path": "[\"subpages\", 8, \"subpages\", 5, \"subpages\", 1]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Horizontal Bar Chart",
"path": "[\"subpages\", 8, \"subpages\", 5, \"subpages\", 2]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Stacked Bar Chart with Groups",
"path": "[\"subpages\", 8, \"subpages\", 5, \"subpages\", 3]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Stacked Bar Chart",
"path": "[\"subpages\", 8, \"subpages\", 5, \"subpages\", 4]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Vertical Bar Chart",
"path": "[\"subpages\", 8, \"subpages\", 5, \"subpages\", 5]",
"content": {
"Docs": "<detail_content>"
}
}
]
},
{
"title": "Legend",
"description": "Documentation section: legend",
"path": "[\"subpages\", 8, \"subpages\", 6]",
"subpages": [
{
"title": "Events",
"path": "[\"subpages\", 8, \"subpages\", 6, \"subpages\", 0]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "HTML Legend",
"path": "[\"subpages\", 8, \"subpages\", 6, \"subpages\", 1]",
"content": {
"Docs ": "<detail_content>"
}
},
{
"title": "Point Style",
"path": "[\"subpages\", 8, \"subpages\", 6, \"subpages\", 2]",
"content": {
"Docs ": "<detail_content>"
}
},
{
"title": "Position",
"path": "[\"subpages\", 8, \"subpages\", 6, \"subpages\", 3]",
"content": {
"Docs ": "<detail_content>"
}
},
{
"title": "Alignment and Title Position",
"path": "[\"subpages\", 8, \"subpages\", 6, \"subpages\", 4]",
"content": {
"Docs ": "<detail_content>"
}
}
]
},
{
"title": "Line",
"description": "Documentation section: line",
"path": "[\"subpages\", 8, \"subpages\", 7]",
"subpages": [
{
"title": "Interpolation Modes",
"path": "[\"subpages\", 8, \"subpages\", 7, \"subpages\", 0]",
"content": {
"Docs ": "<detail_content>"
}
},
{
"title": "Line Chart",
"path": "[\"subpages\", 8, \"subpages\", 7, \"subpages\", 1]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Multi Axis Line Chart",
"path": "[\"subpages\", 8, \"subpages\", 7, \"subpages\", 2]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Point Styling",
"path": "[\"subpages\", 8, \"subpages\", 7, \"subpages\", 3]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Line Segment Styling",
"path": "[\"subpages\", 8, \"subpages\", 7, \"subpages\", 4]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Stepped Line Charts",
"path": "[\"subpages\", 8, \"subpages\", 7, \"subpages\", 5]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Line Styling",
"path": "[\"subpages\", 8, \"subpages\", 7, \"subpages\", 6]",
"content": {
"Docs": "<detail_content>"
}
}
]
},
{
"title": "Other Charts",
"description": "Documentation section: other-charts",
"path": "[\"subpages\", 8, \"subpages\", 8]",
"subpages": [
{
"title": "Bubble",
"path": "[\"subpages\", 8, \"subpages\", 8, \"subpages\", 0]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Combo bar/line",
"path": "[\"subpages\", 8, \"subpages\", 8, \"subpages\", 1]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Doughnut",
"path": "[\"subpages\", 8, \"subpages\", 8, \"subpages\", 2]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Multi Series Pie",
"path": "[\"subpages\", 8, \"subpages\", 8, \"subpages\", 3]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Pie",
"path": "[\"subpages\", 8, \"subpages\", 8, \"subpages\", 4]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Polar area centered point labels",
"path": "[\"subpages\", 8, \"subpages\", 8, \"subpages\", 5]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Polar area",
"path": "[\"subpages\", 8, \"subpages\", 8, \"subpages\", 6]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Radar skip points",
"path": "[\"subpages\", 8, \"subpages\", 8, \"subpages\", 7]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Radar",
"path": "[\"subpages\", 8, \"subpages\", 8, \"subpages\", 8]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Scatter - Multi axis",
"path": "[\"subpages\", 8, \"subpages\", 8, \"subpages\", 9]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Scatter",
"path": "[\"subpages\", 8, \"subpages\", 8, \"subpages\", 10]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Stacked bar/line",
"path": "[\"subpages\", 8, \"subpages\", 8, \"subpages\", 11]",
"content": {
"Docs": "<detail_content>"
}
}
]
},
{
"title": "Plugins",
"description": "Documentation section: plugins",
"path": "[\"subpages\", 8, \"subpages\", 9]",
"subpages": [
{
"title": "Chart Area Border",
"path": "[\"subpages\", 8, \"subpages\", 9, \"subpages\", 0]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Doughnut Empty State",
"path": "[\"subpages\", 8, \"subpages\", 9, \"subpages\", 1]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Quadrants",
"path": "[\"subpages\", 8, \"subpages\", 9, \"subpages\", 2]",
"content": {
"Docs": "<detail_content>"
}
}
]
},
{
"title": "Scale Options",
"description": "Documentation section: scale-options",
"path": "[\"subpages\", 8, \"subpages\", 10]",
"subpages": [
{
"title": "Center Positioning",
"path": "[\"subpages\", 8, \"subpages\", 10, \"subpages\", 0]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Grid Configuration",
"path": "[\"subpages\", 8, \"subpages\", 10, \"subpages\", 1]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Tick Configuration",
"path": "[\"subpages\", 8, \"subpages\", 10, \"subpages\", 2]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Title Configuration",
"path": "[\"subpages\", 8, \"subpages\", 10, \"subpages\", 3]",
"content": {
"Docs": "<detail_content>"
}
}
]
},
{
"title": "Scales",
"description": "Documentation section: scales",
"path": "[\"subpages\", 8, \"subpages\", 11]",
"subpages": [
{
"title": "Linear Scale - Suggested Min-Max",
"path": "[\"subpages\", 8, \"subpages\", 11, \"subpages\", 0]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Linear Scale - Min-Max",
"path": "[\"subpages\", 8, \"subpages\", 11, \"subpages\", 1]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Linear Scale - Step Size",
"path": "[\"subpages\", 8, \"subpages\", 11, \"subpages\", 2]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Log Scale",
"path": "[\"subpages\", 8, \"subpages\", 11, \"subpages\", 3]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Stacked Linear / Category",
"path": "[\"subpages\", 8, \"subpages\", 11, \"subpages\", 4]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Time Scale - Combo Chart",
"path": "[\"subpages\", 8, \"subpages\", 11, \"subpages\", 5]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Time Scale",
"path": "[\"subpages\", 8, \"subpages\", 11, \"subpages\", 6]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Time Scale - Max Span",
"path": "[\"subpages\", 8, \"subpages\", 11, \"subpages\", 7]",
"content": {
"Docs": "<detail_content>"
}
}
]
},
{
"title": "Scriptable",
"description": "Documentation section: scriptable",
"path": "[\"subpages\", 8, \"subpages\", 12]",
"subpages": [
{
"title": "Bar Chart",
"path": "[\"subpages\", 8, \"subpages\", 12, \"subpages\", 0]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Bubble Chart",
"path": "[\"subpages\", 8, \"subpages\", 12, \"subpages\", 1]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Line Chart",
"path": "[\"subpages\", 8, \"subpages\", 12, \"subpages\", 2]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Pie Chart",
"path": "[\"subpages\", 8, \"subpages\", 12, \"subpages\", 3]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Polar Area Chart",
"path": "[\"subpages\", 8, \"subpages\", 12, \"subpages\", 4]",
"content": {
"Docs": "<detail_content>"
}
},
{
"title": "Radar Chart",
"path": "[\"subpages\", 8, \"subpages\", 12, \"subpages\", 5]",
"content": {
"Docs": "<detail_content>"
}
}
]
},
{
"title": "Subtitle",
"description": "Documentation section: subtitle",
"path": "[\"subpages\", 8, \"subpages\", 13]",
"subpages": [
{
"title": "Basic",
"path": "[\"subpages\", 8, \"subpages\", 13, \"subpages\", 0]",
"content": {
"Docs ": "<detail_content>"
}
}
]
},
{
"title": "Title",
"description": "Documentation section: title",
"path": "[\"subpages\", 8, \"subpages\", 14]",
"subpages": [
{
"title": "Alignment",
"path": "[\"subpages\", 8, \"subpages\", 14, \"subpages\", 0]",
"content": {
"Docs ": "<detail_content>"
}
}
]
},
{
"title": "Tooltip",
"description": "Documentation section: tooltip",
"path": "[\"subpages\", 8, \"subpages\", 15]",
"subpages": [
{
"title": "Custom Tooltip Content",
"path": "[\"subpages\", 8, \"subpages\", 15, \"subpages\", 0]",
"content": {
"Docs ": "<detail_content>"
}
},
{
"title": "External HTML Tooltip",
"path": "[\"subpages\", 8, \"subpages\", 15, \"subpages\", 1]",
"content": {
"Docs ": "<detail_content>"
}
},
{
"title": "Interaction Modes",
"path": "[\"subpages\", 8, \"subpages\", 15, \"subpages\", 2]",
"content": {
"Docs ": "<detail_content>"
}
},
{
"title": "Point Style",
"path": "[\"subpages\", 8, \"subpages\", 15, \"subpages\", 3]",
"content": {
"Docs ": "<detail_content>"
}
},
{
"title": "Position",
"path": "[\"subpages\", 8, \"subpages\", 15, \"subpages\", 4]",
"content": {
"Docs ": "<detail_content>"
}
}
]
}
]
}
]
},
"structured_docs": {
"title": "Chart.js",
"description": "Documentation for Chart.js",
"content": {},
"metadata": {
"type": "root",
"path": "/home/anhnh/CodeWikiBench/data/Chart.js/original/docs"
},
"subpages": [
{
"title": "Chart.js",
"description": null,
"content": {
"Why Chart.js": {
"Features": "Chart.js provides a set of frequently used chart types, plugins, and customization options. In addition to a reasonable set of [built-in chart types](./charts/area.md), you can use additional community-maintained [chart types](https://github.com/chartjs/awesome#charts). On top of that, it\u2019s possible to combine several chart types into a [mixed chart](./charts/mixed.md) (essentially, blending multiple chart types into one on the same canvas).\n\nChart.js is highly customizable with [custom plugins](https://github.com/chartjs/awesome#plugins) to create annotations, zoom, or drag-and-drop functionalities to name a few things.",
"Defaults": "Chart.js comes with a sound default configuration, making it very easy to start with and get an app that is ready for production. Chances are you will get a very appealing chart even if you don\u2019t specify any options at all. For instance, Chart.js has animations turned on by default, so you can instantly bring attention to the story you\u2019re telling with the data.",
"Integrations": "Chart.js comes with built-in TypeScript typings and is compatible with all popular [JavaScript frameworks](https://github.com/chartjs/awesome#javascript) including [React](https://github.com/reactchartjs/react-chartjs-2), [Vue](https://github.com/apertureless/vue-chartjs/), [Svelte](https://github.com/SauravKanchan/svelte-chartjs), and [Angular](https://github.com/valor-software/ng2-charts). You can use Chart.js directly or leverage well-maintained wrapper packages that allow for a more native integration with your frameworks of choice.",
"Developer experience": "Chart.js has very thorough\u00a0documentation (yes, you're reading it),\u00a0[API reference](./api/), and\u00a0[examples](./samples/information.md). Maintainers and community members eagerly engage in conversations on [Discord](https://discord.gg/HxEguTK6av), [GitHub Discussions](https://github.com/chartjs/Chart.js/discussions), and [Stack Overflow](https://stackoverflow.com/questions/tagged/chart.js) where more than 11,000 questions are tagged with `chart.js`.",
"Canvas rendering": "Chart.js renders chart elements on an HTML5 canvas unlike several others, mostly D3.js-based, charting libraries that render as SVG. Canvas rendering makes Chart.js very performant, especially for large datasets and complex visualizations that would otherwise require thousands of SVG nodes in the DOM tree. At the same time, canvas rendering disallows CSS styling, so you will have to use built-in options for that, or create a custom plugin or chart type to render everything to your liking.",
"Performance": "Chart.js is very well suited for large datasets. Such datasets can be efficiently ingested using the internal format, so you can skip data [parsing](./general/performance.md#parsing) and [normalization](./general/performance.md#data-normalization). Alternatively, [data decimation](./configuration/decimation.md) can be configured to sample the dataset and reduce its size before rendering.\n\nIn the end, the canvas rendering that Chart.js uses reduces the toll on your DOM tree in comparison to SVG rendering. Also, tree-shaking support allows you to include minimal parts of Chart.js code in your bundle, reducing bundle size and page load time.",
"Community": "Chart.js is [actively developed](https://github.com/chartjs/Chart.js/pulls?q=is%3Apr+is%3Aclosed) and maintained by the community. With minor [releases](https://github.com/chartjs/Chart.js/releases) on an approximately bi-monthly basis and major releases with breaking changes every couple of years, Chart.js keeps the balance between adding new features and making it a hassle to keep up with them."
}
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 0]"
},
{
"title": "Axes",
"description": "Documentation section: axes",
"content": {},
"metadata": {
"type": "directory",
"path": "/home/anhnh/CodeWikiBench/data/Chart.js/original/docs/axes"
},
"subpages": [
{
"title": " Common",
"description": null,
"content": {
"Common options to all axes": "Namespace: `options.scales[scaleId]`\n\n| Name | Type | Default | Description\n| ---- | ---- | ------- | -----------\n| `type` | `string` | | Type of scale being employed. Custom scales can be created and registered with a string key. This allows changing the type of an axis for a chart.\n| `alignToPixels` | `boolean` | `false` | Align pixel values to device pixels.\n| `backgroundColor` | [`Color`](/general/colors.md) | | Background color of the scale area.\n| `border` | `object` | | Border configuration. [more...](/axes/styling.md#border-configuration)\n| `display` | `boolean`\\|`string` | `true` | Controls the axis global visibility (visible when `true`, hidden when `false`). When `display: 'auto'`, the axis is visible only if at least one associated dataset is visible.\n| `grid` | `object` | | Grid line configuration. [more...](/axes/styling.md#grid-line-configuration)\n| `min` | `number` | | User defined minimum number for the scale, overrides minimum value from data. [more...](/axes/index.md#axis-range-settings)\n| `max` | `number` | | User defined maximum number for the scale, overrides maximum value from data. [more...](/axes/index.md#axis-range-settings)\n| `reverse` | `boolean` | `false` | Reverse the scale.\n| `stacked` | `boolean`\\|`string` | `false` | Should the data be stacked. [more...](/axes/index.md#stacking)\n| `suggestedMax` | `number` | | Adjustment used when calculating the maximum data value. [more...](/axes/index.md#axis-range-settings)\n| `suggestedMin` | `number` | | Adjustment used when calculating the minimum data value. [more...](/axes/index.md#axis-range-settings)\n| `ticks` | `object` | | Tick configuration. [more...](/axes/index.md#tick-configuration)\n| `weight` | `number` | `0` | The weight used to sort the axis. Higher weights are further away from the chart area."
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 1, \"subpages\", 0]"
},
{
"title": " Common Ticks",
"description": null,
"content": {
"Common tick options to all axes": "Namespace: `options.scales[scaleId].ticks`\n\n| Name | Type | Scriptable | Default | Description\n| ---- | ---- | :-------------------------------: | ------- | -----------\n| `backdropColor` | [`Color`](../../general/colors.md) | Yes | `'rgba(255, 255, 255, 0.75)'` | Color of label backdrops.\n| `backdropPadding` | [`Padding`](../../general/padding.md) | | `2` | Padding of label backdrop.\n| `callback` | `function` | | | Returns the string representation of the tick value as it should be displayed on the chart. See [callback](/axes/labelling.md#creating-custom-tick-formats).\n| `display` | `boolean` | | `true` | If true, show tick labels.\n| `color` | [`Color`](/general/colors.md) | Yes | `Chart.defaults.color` | Color of ticks.\n| `font` | `Font` | Yes | `Chart.defaults.font` | See [Fonts](/general/fonts.md)\n| `major` | `object` | | `{}` | [Major ticks configuration](/axes/styling.md#major-tick-configuration).\n| `padding` | `number` | | `3` | Sets the offset of the tick labels from the axis\n| `showLabelBackdrop` | `boolean` | Yes | `true` for radial scale, `false` otherwise | If true, draw a background behind the tick labels.\n| `textStrokeColor` | [`Color`](/general/colors.md) | Yes | `` | The color of the stroke around the text.\n| `textStrokeWidth` | `number` | Yes | `0` | Stroke width around the text.\n| `z` | `number` | | `0` | z-index of tick layer. Useful when ticks are drawn on chart area. Values <= 0 are drawn under datasets, > 0 on top."
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 1, \"subpages\", 1]"
},
{
"title": "Axes",
"description": null,
"content": {
"Default scales": "The default `scaleId`'s for cartesian charts are `'x'` and `'y'`. For radial charts: `'r'`.\nEach dataset is mapped to a scale for each axis (x, y or r) it requires. The scaleId's that a dataset is mapped to is determined by the `xAxisID`, `yAxisID` or `rAxisID`.\nIf the ID for an axis is not specified, the first scale for that axis is used. If no scale for an axis is found, a new scale is created.\n\nSome examples:\n\nThe following chart will have `'x'` and `'y'` scales:\n\n```\nlet chart = new Chart(ctx, {\n type: 'line'\n});\n```\n\nThe following chart will have scales `'x'` and `'myScale'`:\n\n```\nlet chart = new Chart(ctx, {\n type: 'bar',\n data: {\n datasets: [{\n data: [1, 2, 3]\n }]\n },\n options: {\n scales: {\n myScale: {\n type: 'logarithmic',\n position: 'right', // `axis` is determined by the position as `'y'`\n }\n }\n }\n});\n```\n\nThe following chart will have scales `'xAxis'` and `'yAxis'`:\n\n```\nlet chart = new Chart(ctx, {\n type: 'bar',\n data: {\n datasets: [{\n yAxisID: 'yAxis'\n }]\n },\n options: {\n scales: {\n xAxis: {\n // The axis for this scale is determined from the first letter of the id as `'x'`\n // It is recommended to specify `position` and / or `axis` explicitly.\n type: 'time',\n }\n }\n }\n});\n```\n\nThe following chart will have `'r'` scale:\n\n```\nlet chart = new Chart(ctx, {\n type: 'radar'\n});\n```\n\nThe following chart will have `'myScale'` scale:\n\n```\nlet chart = new Chart(ctx, {\n type: 'radar',\n scales: {\n myScale: {\n axis: 'r'\n }\n }\n});\n```",
"Common Configuration": ":::tip Note\nThese are only the common options supported by all axes. Please see specific axis documentation for all the available options for that axis.\n:::\n\n!!!include(axes/_common.md)!!!",
"Tick Configuration": ":::tip Note\nThese are only the common tick options supported by all axes. Please see specific axis documentation for all the available tick options for that axis.\n:::\n\n!!!include(axes/_common_ticks.md)!!!",
"Axis Range Settings": "Given the number of axis range settings, it is important to understand how they all interact with each other.\n\nThe `suggestedMax` and `suggestedMin` settings only change the data values that are used to scale the axis. These are useful for extending the range of the axis while maintaining the auto-fit behaviour.\n\n```\nlet minDataValue = Math.min(mostNegativeValue, options.suggestedMin);\nlet maxDataValue = Math.max(mostPositiveValue, options.suggestedMax);\n```\n\nIn this example, the largest positive value is 50, but the data maximum is expanded out to 100. However, because the lowest data value is below the `suggestedMin` setting, it is ignored.\n\n```\nlet chart = new Chart(ctx, {\n type: 'line',\n data: {\n datasets: [{\n label: 'First dataset',\n data: [0, 20, 40, 50]\n }],\n labels: ['January', 'February', 'March', 'April']\n },\n options: {\n scales: {\n y: {\n suggestedMin: 50,\n suggestedMax: 100\n }\n }\n }\n});\n```\n\nIn contrast to the `suggested*` settings, the `min` and `max` settings set explicit ends to the axes. When these are set, some data points may not be visible.",
"Stacking": "By default, data is not stacked. If the `stacked` option of the value scale (y-axis on horizontal chart) is `true`, positive and negative values are stacked separately. Additionally, a `stack` option can be defined per dataset to further divide into stack groups [more...](../general/data-structures/#dataset-configuration).\nFor some charts, you might want to stack positive and negative values together. That can be achieved by specifying `stacked: 'single'`.",
"Callbacks": {
"Updating Axis Defaults": "The default configuration for a scale can be easily changed. All you need to do is set the new options to `Chart.defaults.scales[type]`.\n\nFor example, to set the minimum value of 0 for all linear scales, you would do the following. Any linear scales created after this time would now have a minimum of 0.\n\n```\nChart.defaults.scales.linear.min = 0;\n```"
},
"Creating New Axes": "To create a new axis, see the [developer docs](../developers/axes.md)."
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 1, \"subpages\", 2]"
},
{
"title": "Labeling Axes",
"description": null,
"content": {
"Scale Title Configuration": "Namespace: `options.scales[scaleId].title`, it defines options for the scale title. Note that this only applies to cartesian axes.\n\n| Name | Type | Default | Description\n| ---- | ---- | ------- | -----------\n| `display` | `boolean` | `false` | If true, display the axis title.\n| `align` | `string` | `'center'` | Alignment of the axis title. Possible options are `'start'`, `'center'` and `'end'`\n| `text` | `string`\\|`string[]` | `''` | The text for the title. (i.e. \"# of People\" or \"Response Choices\").\n| `color` | [`Color`](../general/colors.md) | `Chart.defaults.color` | Color of label.\n| `font` | `Font` | `Chart.defaults.font` | See [Fonts](../general/fonts.md)\n| `padding` | [`Padding`](../general/padding.md) | `4` | Padding to apply around scale labels. Only `top`, `bottom` and `y` are implemented.",
"Creating Custom Tick Formats": "It is also common to want to change the tick marks to include information about the data type. For example, adding a dollar sign ('$').\nTo do this, you need to override the `ticks.callback` method in the axis configuration.\n\nThe method receives 3 arguments:\n\n['`value` - the tick value in the **internal data format** of the associated scale. For time scale, it is a timestamp.', '`index` - the tick index in the ticks array.', '`ticks` - the array containing all of the [tick objects](../api/interfaces/Tick).']\n\nThe call to the method is scoped to the scale. `this` inside the method is the scale object.\n\nIf the callback returns `null` or `undefined` the associated grid line will be hidden.\n\n:::tip\nThe [category axis](../axes/cartesian/category), which is the default x-axis for line and bar charts, uses the `index` as internal data format. For accessing the label, use `this.getLabelForValue(value)`. [API: getLabelForValue](../api/classes/Scale.md#getlabelforvalue)\n:::\n\nIn the following example, every label of the Y-axis would be displayed with a dollar sign at the front.\n\n```\nconst chart = new Chart(ctx, {\n type: 'line',\n data: data,\n options: {\n scales: {\n y: {\n ticks: {\n // Include a dollar sign in the ticks\n callback: function(value, index, ticks) {\n return '$' + value;\n }\n }\n }\n }\n }\n});\n```\n\nKeep in mind that overriding `ticks.callback` means that you are responsible for all formatting of the label. Depending on your use case, you may want to call the default formatter and then modify its output. In the example above, that would look like:\n\n```\n // call the default formatter, forwarding `this`\n return '$' + Chart.Ticks.formatters.numeric.apply(this, [value, index, ticks]);\n```\n\nRelated samples:\n\n['[Tick configuration sample](../samples/scale-options/ticks)']"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 1, \"subpages\", 3]"
},
{
"title": "Styling",
"description": null,
"content": {
"Grid Line Configuration": "Namespace: `options.scales[scaleId].grid`, it defines options for the grid lines that run perpendicular to the axis.\n\n| Name | Type | Scriptable | Indexable | Default | Description\n| ---- | ---- | :-------------------------------: | :-----------------------------: | ------- | -----------\n| `circular` | `boolean` | | | `false` | If true, gridlines are circular (on radar and polar area charts only).\n| `color` | [`Color`](../general/colors.md) | Yes | Yes | `Chart.defaults.borderColor` | The color of the grid lines. If specified as an array, the first color applies to the first grid line, the second to the second grid line, and so on.\n| `display` | `boolean` | | | `true` | If false, do not display grid lines for this axis.\n| `drawOnChartArea` | `boolean` | | | `true` | If true, draw lines on the chart area inside the axis lines. This is useful when there are multiple axes and you need to control which grid lines are drawn.\n| `drawTicks` | `boolean` | | | `true` | If true, draw lines beside the ticks in the axis area beside the chart.\n| `lineWidth` | `number` | Yes | Yes | `1` | Stroke width of grid lines.\n| `offset` | `boolean` | | | `false` | If true, grid lines will be shifted to be between labels. This is set to `true` for a bar chart by default.\n| `tickBorderDash` | `number[]` | Yes | Yes | `[]` | Length and spacing of the tick mark line. If not set, defaults to the grid line `borderDash` value.\n| `tickBorderDashOffset` | `number` | Yes | Yes | | Offset for the line dash of the tick mark. If unset, defaults to the grid line `borderDashOffset` value\n| `tickColor` | [`Color`](../general/colors.md) | Yes | Yes | | Color of the tick line. If unset, defaults to the grid line color.\n| `tickLength` | `number` | | | `8` | Length in pixels that the grid lines will draw into the axis area.\n| `tickWidth` | `number` | Yes | Yes | | Width of the tick mark in pixels. If unset, defaults to the grid line width.\n| `z` | `number` | | | `-1` | z-index of the gridline layer. Values <= 0 are drawn under datasets, > 0 on top.\n\nThe scriptable context is described in [Options](../general/options.md#tick) section.",
"Tick Configuration": "!!!include(axes/_common_ticks.md)!!!\n\nThe scriptable context is described in [Options](../general/options.md#tick) section.",
"Major Tick Configuration": "Namespace: `options.scales[scaleId].ticks.major`, it defines options for the major tick marks that are generated by the axis.\n\n| Name | Type | Default | Description\n| ---- | ---- | ------- | -----------\n| `enabled` | `boolean` | `false` | If true, major ticks are generated. A major tick will affect autoskipping and `major` will be defined on ticks in the scriptable options context.",
"Border Configuration": "Namespace: `options.scales[scaleId].border`, it defines options for the border that run perpendicular to the axis.\n\n| Name | Type | Scriptable | Indexable | Default | Description\n| ---- | ---- | :-------------------------------: | :-----------------------------: | ------- | -----------\n| `display` | `boolean` | | | `true` | If true, draw a border at the edge between the axis and the chart area.\n| `color` | [`Color`](../general/colors.md) | | | `Chart.defaults.borderColor` | The color of the border line.\n| `width` | `number` | | | `1` | The width of the border line.\n| `dash` | `number[]` | Yes | | `[]` | Length and spacing of dashes on grid lines. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash).\n| `dashOffset` | `number` | Yes | | `0.0` | Offset for line dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset).\n| `z` | `number` | | | `0` | z-index of the border layer. Values <= 0 are drawn under datasets, > 0 on top."
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 1, \"subpages\", 4]"
},
{
"title": "Cartesian",
"description": "Documentation section: cartesian",
"content": {},
"metadata": {
"type": "directory",
"path": "/home/anhnh/CodeWikiBench/data/Chart.js/original/docs/axes/cartesian"
},
"subpages": [
{
"title": " Common",
"description": null,
"content": {
"Common options to all cartesian axes": "Namespace: `options.scales[scaleId]`\n\n| Name | Type | Default | Description\n| ---- | ---- | ------- | -----------\n| `bounds` | `string` | `'ticks'` | Determines the scale bounds. [more...](./index.md#scale-bounds)\n| `clip` | `boolean` | `true` | If true, clip the dataset drawing against the size of the scale instead of chart area\n| `position` | `string` \\| `object` | | Position of the axis. [more...](./index.md#axis-position)\n| `stack` | `string` | | Stack group. Axes at the same `position` with same `stack` are stacked.\n| `stackWeight` | `number` | 1 | Weight of the scale in stack group. Used to determine the amount of allocated space for the scale within the group.\n| `axis` | `string` | | Which type of axis this is. Possible values are: `'x'`, `'y'`. If not set, this is inferred from the first character of the ID which should be `'x'` or `'y'`.\n| `offset` | `boolean` | `false` | If true, extra space is added to the both edges and the axis is scaled to fit into the chart area. This is set to `true` for a bar chart by default.\n| `title` | `object` | | Scale title configuration. [more...](../labelling.md#scale-title-configuration)"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 1, \"subpages\", 5, \"subpages\", 0]"
},
{
"title": " Common Ticks",
"description": null,
"content": {
"Common tick options to all cartesian axes": "Namespace: `options.scales[scaleId].ticks`\n\n| Name | Type | Default | Description\n| ---- | ---- | ------- | -----------\n| `align` | `string` | `'center'` | The tick alignment along the axis. Can be `'start'`, `'center'`, `'end'`, or `'inner'`. `inner` alignment means align `start` for first tick and `end` for the last tick of horizontal axis\n| `crossAlign` | `string` | `'near'` | The tick alignment perpendicular to the axis. Can be `'near'`, `'center'`, or `'far'`. See [Tick Alignment](/axes/cartesian/#tick-alignment)\n| `sampleSize` | `number` | `ticks.length` | The number of ticks to examine when deciding how many labels will fit. Setting a smaller value will be faster, but may be less accurate when there is large variability in label length.\n| `autoSkip` | `boolean` | `true` | If true, automatically calculates how many labels can be shown and hides labels accordingly. Labels will be rotated up to `maxRotation` before skipping any. Turn `autoSkip` off to show all labels no matter what.\n| `autoSkipPadding` | `number` | `3` | Padding between the ticks on the horizontal axis when `autoSkip` is enabled.\n| `includeBounds` | `boolean` | `true` | Should the defined `min` and `max` values be presented as ticks even if they are not \"nice\".\n| `labelOffset` | `number` | `0` | Distance in pixels to offset the label from the centre point of the tick (in the x-direction for the x-axis, and the y-direction for the y-axis). *Note: this can cause labels at the edges to be cropped by the edge of the canvas*\n| `maxRotation` | `number` | `50` | Maximum rotation for tick labels when rotating to condense labels. Note: Rotation doesn't occur until necessary. *Note: Only applicable to horizontal scales.*\n| `minRotation` | `number` | `0` | Minimum rotation for tick labels. *Note: Only applicable to horizontal scales.*\n| `mirror` | `boolean` | `false` | Flips tick labels around axis, displaying the labels inside the chart instead of outside. *Note: Only applicable to vertical scales.*\n| `padding` | `number` | `0` | Padding between the tick label and the axis. When set on a vertical axis, this applies in the horizontal (X) direction. When set on a horizontal axis, this applies in the vertical (Y) direction.\n| `maxTicksLimit` | `number` | `11` | Maximum number of ticks and gridlines to show."
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 1, \"subpages\", 5, \"subpages\", 1]"
},
{
"title": "Category Axis",
"description": null,
"content": {
"Category Axis Definition": "Globally:\n\n```\nlet chart = new Chart(ctx, {\n type: ...\n data: {\n labels: ['January', 'February', 'March', 'April', 'May', 'June'],\n datasets: ...\n }\n});\n```\n\nAs part of axis definition:\n\n```\nlet chart = new Chart(ctx, {\n type: ...\n data: ...\n options: {\n scales: {\n x: {\n type: 'category',\n labels: ['January', 'February', 'March', 'April', 'May', 'June']\n }\n }\n }\n});\n```",
"Configuration Options": {
"Category Axis specific options": "Namespace: `options.scales[scaleId]`\n\n| Name | Type | Description\n| ---- | ---- | -----------\n| `min` | `string`\\|`number` | The minimum item to display. [more...](#min-max-configuration)\n| `max` | `string`\\|`number` | The maximum item to display. [more...](#min-max-configuration)\n| `labels` | `string[]`\\|`string[][]` | An array of labels to display. When an individual label is an array of strings, each item is rendered on a new line.\n\n!!!include(axes/cartesian/_common.md)!!!\n\n!!!include(axes/_common.md)!!!"
},
"Tick Configuration": "!!!include(axes/cartesian/_common_ticks.md)!!!\n\n!!!include(axes/_common_ticks.md)!!!",
"Min Max Configuration": "For both the `min` and `max` properties, the value must be `string` in the `labels` array or `numeric` value as an index of a label in that array. In the example below, the x axis would only display \"March\" through \"June\".\n\n```\nlet chart = new Chart(ctx, {\n type: 'line',\n data: {\n datasets: [{\n data: [10, 20, 30, 40, 50, 60]\n }],\n labels: ['January', 'February', 'March', 'April', 'May', 'June']\n },\n options: {\n scales: {\n x: {\n min: 'March'\n }\n }\n }\n});\n```",
"Internal data format": "Internally category scale uses label indices"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 1, \"subpages\", 5, \"subpages\", 2]"
},
{
"title": "Cartesian Axes",
"description": null,
"content": {
"Visual Components": {
"Border": "The axis border is drawn at the edge of the axis, beside the chart area. In the image below, it is drawn in red.\n\n```\n// <block:setup:1>\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [{\n label: 'My First dataset',\n backgroundColor: 'rgba(54, 162, 235, 0.5)',\n borderColor: 'rgb(54, 162, 235)',\n borderWidth: 1,\n data: [10, 20, 30, 40, 50, 0, 5],\n }]\n};\n// </block:setup>\n\n// <block:config:0>\nconst config = {\n type: 'line',\n data,\n options: {\n scales: {\n x: {\n border: {\n color: 'red'\n }\n }\n }\n }\n};\n// </block:config>\n\nmodule.exports = {\n actions: [],\n config: config,\n};\n```",
"Grid lines": "The grid lines for an axis are drawn on the chart area. In the image below, they are red.\n\n```\n// <block:setup:1>\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [{\n label: 'My First dataset',\n backgroundColor: 'rgba(54, 162, 235, 0.5)',\n borderColor: 'rgb(54, 162, 235)',\n borderWidth: 1,\n data: [10, 20, 30, 40, 50, 0, 5],\n }]\n};\n// </block:setup>\n\n// <block:config:0>\nconst config = {\n type: 'line',\n data,\n options: {\n scales: {\n x: {\n grid: {\n color: 'red',\n borderColor: 'grey',\n tickColor: 'grey'\n }\n }\n }\n }\n};\n// </block:config>\n\nmodule.exports = {\n actions: [],\n config: config,\n};\n```",
"Ticks and Tick Marks": "Ticks represent data values on the axis that appear as labels. The tick mark is the extension of the grid line from the axis border to the label.\nIn this example, the tick mark is drawn in red while the tick label is drawn in blue.\n\n```\n// <block:setup:1>\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [{\n label: 'My First dataset',\n backgroundColor: 'rgba(54, 162, 235, 0.5)',\n borderColor: 'rgb(54, 162, 235)',\n borderWidth: 1,\n data: [10, 20, 30, 40, 50, 0, 5],\n }]\n};\n// </block:setup>\n\n// <block:config:0>\nconst config = {\n type: 'line',\n data,\n options: {\n scales: {\n x: {\n grid: {\n tickColor: 'red'\n },\n ticks: {\n color: 'blue',\n }\n }\n }\n }\n};\n// </block:config>\n\nmodule.exports = {\n actions: [],\n config: config,\n};\n```",
"Title": "The title component of the axis is used to label the data. In the example below, it is shown in red.\n\n```\n// <block:setup:1>\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [{\n label: 'My First dataset',\n backgroundColor: 'rgba(54, 162, 235, 0.5)',\n borderColor: 'rgb(54, 162, 235)',\n borderWidth: 1,\n data: [10, 20, 30, 40, 50, 0, 5],\n }]\n};\n// </block:setup>\n\n// <block:config:0>\nconst config = {\n type: 'line',\n data,\n options: {\n scales: {\n x: {\n title: {\n color: 'red',\n display: true,\n text: 'Month'\n }\n }\n }\n }\n};\n// </block:config>\n\nmodule.exports = {\n actions: [],\n config: config,\n};\n```"
},
"Common Configuration": {
"Axis Position": "An axis can either be positioned at the edge of the chart, at the center of the chart area, or dynamically with respect to a data value.\n\nTo position the axis at the edge of the chart, set the `position` option to one of: `'top'`, `'left'`, `'bottom'`, `'right'`.\nTo position the axis at the center of the chart area, set the `position` option to `'center'`. In this mode, either the `axis` option must be specified or the axis ID has to start with the letter 'x' or 'y'. This is so chart.js knows what kind of axis (horizontal or vertical) it is.\nTo position the axis with respect to a data value, set the `position` option to an object such as:\n\n```\n{\n x: -20\n}\n```\n\nThis will position the axis at a value of -20 on the axis with ID \"x\". For cartesian axes, only 1 axis may be specified.",
"Scale Bounds": "The `bounds` property controls the scale boundary strategy (bypassed by `min`/`max` options).\n\n[\"`'data'`: makes sure data are fully visible, labels outside are removed\", \"`'ticks'`: makes sure ticks are fully visible, data outside are truncated\"]",
"Tick Configuration": ":::tip Note\nThese are only the common tick options supported by all cartesian axes. Please see specific axis documentation for all of the available options for that axis.\n:::\n\n!!!include(axes/cartesian/_common_ticks.md)!!!\n\n!!!include(axes/_common_ticks.md)!!!",
"Tick Alignment": "The alignment of ticks is primarily controlled using two settings on the tick configuration object: `align` and `crossAlign`. The `align` setting configures how labels align with the tick mark along the axis direction (i.e. horizontal for a horizontal axis and vertical for a vertical axis). The `crossAlign` setting configures how labels align with the tick mark in the perpendicular direction (i.e. vertical for a horizontal axis and horizontal for a vertical axis). In the example below, the `crossAlign` setting is used to left align the labels on the Y axis.\n\n```\n// <block:setup:1>\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [{\n label: 'My First dataset',\n backgroundColor: [\n 'rgba(255, 99, 132, 0.2)',\n 'rgba(255, 159, 64, 0.2)',\n 'rgba(255, 205, 86, 0.2)',\n 'rgba(75, 192, 192, 0.2)',\n 'rgba(54, 162, 235, 0.2)',\n 'rgba(153, 102, 255, 0.2)',\n 'rgba(201, 203, 207, 0.2)'\n ],\n borderColor: [\n 'rgb(255, 99, 132)',\n 'rgb(255, 159, 64)',\n 'rgb(255, 205, 86)',\n 'rgb(75, 192, 192)',\n 'rgb(54, 162, 235)',\n 'rgb(153, 102, 255)',\n 'rgb(201, 203, 207)'\n ],\n borderWidth: 1,\n data: [65, 59, 80, 81, 56, 55, 40],\n }]\n};\n// </block:setup>\n\n// <block:config:0>\nconst config = {\n type: 'bar',\n data,\n options: {\n indexAxis: 'y',\n scales: {\n y: {\n ticks: {\n crossAlign: 'far',\n }\n }\n }\n }\n};\n// </block:config>\n\nmodule.exports = {\n actions: [],\n config: config,\n};\n```\n\n:::tip Note\nThe `crossAlign` setting is only effective when these preconditions are met:\n\n['tick rotation is `0`', \"axis position is `'top'`, '`left'`, `'bottom'` or `'right'`\\n:::\"]",
"Axis ID": "The properties `dataset.xAxisID` or `dataset.yAxisID` have to match to `scales` property. This is especially needed if multi-axes charts are used.\n\n```\nconst myChart = new Chart(ctx, {\n type: 'line',\n data: {\n datasets: [{\n // This dataset appears on the first axis\n yAxisID: 'first-y-axis'\n }, {\n // This dataset appears on the second axis\n yAxisID: 'second-y-axis'\n }]\n },\n options: {\n scales: {\n 'first-y-axis': {\n type: 'linear'\n },\n 'second-y-axis': {\n type: 'linear'\n }\n }\n }\n});\n```"
},
"Creating Multiple Axes": "With cartesian axes, it is possible to create multiple X and Y axes. To do so, you can add multiple configuration objects to the `xAxes` and `yAxes` properties. When adding new axes, it is important to ensure that you specify the type of the new axes as default types are **not** used in this case.\n\nIn the example below, we are creating two Y axes. We then use the `yAxisID` property to map the datasets to their correct axes.\n\n```\nconst myChart = new Chart(ctx, {\n type: 'line',\n data: {\n datasets: [{\n data: [20, 50, 100, 75, 25, 0],\n label: 'Left dataset',\n\n // This binds the dataset to the left y axis\n yAxisID: 'left-y-axis'\n }, {\n data: [0.1, 0.5, 1.0, 2.0, 1.5, 0],\n label: 'Right dataset',\n\n // This binds the dataset to the right y axis\n yAxisID: 'right-y-axis'\n }],\n labels: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun']\n },\n options: {\n scales: {\n 'left-y-axis': {\n type: 'linear',\n position: 'left'\n },\n 'right-y-axis': {\n type: 'linear',\n position: 'right'\n }\n }\n }\n});\n```"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 1, \"subpages\", 5, \"subpages\", 3]"
},
{
"title": "Linear Axis",
"description": null,
"content": {
"Configuration Options": {
"Linear Axis specific options": "Namespace: `options.scales[scaleId]`\n\n| Name | Type | Description\n| ---- | ---- | -----------\n| `beginAtZero` | `boolean` | if true, scale will include 0 if it is not already included.\n| `grace` | `number`\\|`string` | Percentage (string ending with `%`) or amount (number) for added room in the scale range above and below data. [more...](#grace)\n\n!!!include(axes/cartesian/_common.md)!!!\n\n!!!include(axes/_common.md)!!!"
},
"Tick Configuration": {
"Linear Axis specific tick options": "Namespace: `options.scales[scaleId].ticks`\n\n| Name | Type | Scriptable | Default | Description\n| ---- | ---- | ------- | ------- | -----------\n| `count` | `number` | Yes | `undefined` | The number of ticks to generate. If specified, this overrides the automatic generation.\n| `format` | `object` | Yes | | The [`Intl.NumberFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat) options used by the default label formatter\n| `precision` | `number` | Yes | | if defined and `stepSize` is not specified, the step size will be rounded to this many decimal places.\n| `stepSize` | `number` | Yes | | User-defined fixed step size for the scale. [more...](#step-size)\n\n!!!include(axes/cartesian/_common_ticks.md)!!!\n\n!!!include(axes/_common_ticks.md)!!!"
},
"Step Size": "If set, the scale ticks will be enumerated by multiple of `stepSize`, having one tick per increment. If not set, the ticks are labeled automatically using the nice numbers algorithm.\n\nThis example sets up a chart with a y-axis that creates ticks at `0, 0.5, 1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5, 5`.\n\n```\nlet options = {\n scales: {\n y: {\n max: 5,\n min: 0,\n ticks: {\n stepSize: 0.5\n }\n }\n }\n};\n```",
"Grace": "If the value is a string ending with `%`, it's treated as a percentage. If a number, it's treated as a value.\nThe value is added to the maximum data value and subtracted from the minimum data. This extends the scale range as if the data values were that much greater.\n\n```\n// <block:setup:1>\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: ['Positive', 'Negative'],\n datasets: [{\n data: [100, -50],\n backgroundColor: 'rgb(255, 99, 132)'\n }],\n};\n// </block:setup>\n\n// <block:config:0>\nconst config = {\n type: 'bar',\n data,\n options: {\n scales: {\n y: {\n type: 'linear',\n grace: '5%'\n }\n },\n plugins: {\n legend: false\n }\n }\n};\n// </block:config>\n\nmodule.exports = {\n actions: [],\n config: config,\n};\n```",
"Internal data format": "Internally, the linear scale uses numeric data."
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 1, \"subpages\", 5, \"subpages\", 4]"
},
{
"title": "Logarithmic Axis",
"description": null,
"content": {
"Configuration Options": "!!!include(axes/cartesian/_common.md)!!!\n\n!!!include(axes/_common.md)!!!",
"Tick Configuration": {
"Logarithmic Axis specific options": "Namespace: `options.scales[scaleId].ticks`\n\n| Name | Type | Default | Description\n| ---- | ---- | ------- | -----------\n| `format` | `object` | | The [`Intl.NumberFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat) options used by the default label formatter\n\n!!!include(axes/cartesian/_common_ticks.md)!!!\n\n!!!include(axes/_common_ticks.md)!!!"
},
"Internal data format": "Internally, the logarithmic scale uses numeric data."
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 1, \"subpages\", 5, \"subpages\", 5]"
},
{
"title": "Time Cartesian Axis",
"description": null,
"content": {
"Date Adapters": "The time scale **requires** both a date library and a corresponding adapter to be present. Please choose from the [available adapters](https://github.com/chartjs/awesome#adapters).",
"Data Sets": {
"Input Data": "See [data structures](../../general/data-structures.md).",
"Date Formats": "When providing data for the time scale, Chart.js uses timestamps defined as milliseconds since the epoch (midnight January 1, 1970, UTC) internally. However, Chart.js also supports all of the formats that your chosen date adapter accepts. You should use timestamps if you'd like to set `parsing: false` for better performance."
},
"Configuration Options": {
"Time Axis specific options": {
"Time Units": "The following time measurements are supported. The names can be passed as strings to the `time.unit` config option to force a certain unit.\n\n[\"`'millisecond'`\", \"`'second'`\", \"`'minute'`\", \"`'hour'`\", \"`'day'`\", \"`'week'`\", \"`'month'`\", \"`'quarter'`\", \"`'year'`\"]\n\nFor example, to create a chart with a time scale that always displayed units per month, the following config could be used.\n\n```\nconst chart = new Chart(ctx, {\n type: 'line',\n data: data,\n options: {\n scales: {\n x: {\n type: 'time',\n time: {\n unit: 'month'\n }\n }\n }\n }\n});\n```",
"Display Formats": "You may specify a map of display formats with a key for each unit:\n\n['`millisecond`', '`second`', '`minute`', '`hour`', '`day`', '`week`', '`month`', '`quarter`', '`year`']\n\nThe format string used as a value depends on the date adapter you chose to use.\n\nFor example, to set the display format for the `quarter` unit to show the month and year, the following config might be passed to the chart constructor.\n\n```\nconst chart = new Chart(ctx, {\n type: 'line',\n data: data,\n options: {\n scales: {\n x: {\n type: 'time',\n time: {\n displayFormats: {\n quarter: 'MMM YYYY'\n }\n }\n }\n }\n }\n});\n```",
"Ticks Source": "The `ticks.source` property controls the ticks generation.\n\n['`\\'auto\\'`: generates \"optimal\" ticks based on scale size and time options', \"`'data'`: generates ticks from data (including labels from data `{x|y}` objects)\", \"`'labels'`: generates ticks from user given `labels` ONLY\"]",
"Parser": "If this property is defined as a string, it is interpreted as a custom format to be used by the date adapter to parse the date.\n\nIf this is a function, it must return a type that can be handled by your date adapter's `parse` method."
}
},
"Min Max Configuration": "For both the `min` and `max` properties, the value must be `string` that is parsable by your date adapter or a number with the amount of milliseconds that have elapsed since UNIX epoch.\nIn the example below the x axis will start at 7 November 2021.\n\n```\nlet chart = new Chart(ctx, {\n type: 'line',\n data: {\n datasets: [{\n data: [{\n x: '2021-11-06 23:39:30',\n y: 50\n }, {\n x: '2021-11-07 01:00:28',\n y: 60\n }, {\n x: '2021-11-07 09:00:28',\n y: 20\n }]\n }],\n },\n options: {\n scales: {\n x: {\n min: '2021-11-07 00:00:00',\n }\n }\n }\n});\n```",
"Changing the scale type from Time scale to Logarithmic/Linear scale.": "When changing the scale type from Time scale to Logarithmic/Linear scale, you need to add `bounds: 'ticks'` to the scale options. Changing the `bounds` parameter is necessary because its default value is the `'data'` for the Time scale.\n\nInitial config:\n\n```\nconst chart = new Chart(ctx, {\n type: 'line',\n data: data,\n options: {\n scales: {\n x: {\n type: 'time',\n }\n }\n }\n});\n```\n\nScale update:\n\n```\nchart.options.scales.x = {\n type: 'logarithmic',\n bounds: 'ticks'\n};\n```",
"Internal data format": "Internally time scale uses milliseconds since epoch"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 1, \"subpages\", 5, \"subpages\", 6]"
},
{
"title": "Time Series Axis",
"description": null,
"content": {
"Example": "```\nconst chart = new Chart(ctx, {\n type: 'line',\n data: data,\n options: {\n scales: {\n x: {\n type: 'timeseries',\n }\n }\n }\n});\n```",
"More details": "Please see [the time scale documentation](./time.md) for all other details."
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 1, \"subpages\", 5, \"subpages\", 7]"
}
],
"path": "[\"subpages\", 1, \"subpages\", 5]"
},
{
"title": "Radial",
"description": "Documentation section: radial",
"content": {},
"metadata": {
"type": "directory",
"path": "/home/anhnh/CodeWikiBench/data/Chart.js/original/docs/axes/radial"
},
"subpages": [
{
"title": "Radial Axes",
"description": null,
"content": {
"Visual Components": {
"Angle Lines": "The grid lines for an axis are drawn on the chart area. They stretch out from the center towards the edge of the canvas. In the example below, they are red.\n\n```\n// <block:setup:1>\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [{\n label: 'My First dataset',\n backgroundColor: 'rgba(54, 162, 235, 0.5)',\n borderColor: 'rgb(54, 162, 235)',\n borderWidth: 1,\n data: [10, 20, 30, 40, 50, 0, 5],\n }]\n};\n// </block:setup>\n\n// <block:config:0>\nconst config = {\n type: 'radar',\n data,\n options: {\n scales: {\n r: {\n angleLines: {\n color: 'red'\n }\n }\n }\n }\n};\n// </block:config>\n\nmodule.exports = {\n actions: [],\n config: config,\n};\n```",
"Grid Lines": "The grid lines for an axis are drawn on the chart area. In the example below, they are red.\n\n```\n// <block:setup:1>\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [{\n label: 'My First dataset',\n backgroundColor: 'rgba(54, 162, 235, 0.5)',\n borderColor: 'rgb(54, 162, 235)',\n borderWidth: 1,\n data: [10, 20, 30, 40, 50, 0, 5],\n }]\n};\n// </block:setup>\n\n// <block:config:0>\nconst config = {\n type: 'radar',\n data,\n options: {\n scales: {\n r: {\n grid: {\n color: 'red'\n }\n }\n }\n }\n};\n// </block:config>\n\nmodule.exports = {\n actions: [],\n config: config,\n};\n```",
"Point Labels": "The point labels indicate the value for each angle line. In the example below, they are red.\n\n```\n// <block:setup:1>\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [{\n label: 'My First dataset',\n backgroundColor: 'rgba(54, 162, 235, 0.5)',\n borderColor: 'rgb(54, 162, 235)',\n borderWidth: 1,\n data: [10, 20, 30, 40, 50, 0, 5],\n }]\n};\n// </block:setup>\n\n// <block:config:0>\nconst config = {\n type: 'radar',\n data,\n options: {\n scales: {\n r: {\n pointLabels: {\n color: 'red'\n }\n }\n }\n }\n};\n// </block:config>\n\nmodule.exports = {\n actions: [],\n config: config,\n};\n```",
"Ticks": "The ticks are used to label values based on how far they are from the center of the axis. In the example below, they are red.\n\n```\n// <block:setup:1>\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [{\n label: 'My First dataset',\n backgroundColor: 'rgba(54, 162, 235, 0.5)',\n borderColor: 'rgb(54, 162, 235)',\n borderWidth: 1,\n data: [10, 20, 30, 40, 50, 0, 5],\n }]\n};\n// </block:setup>\n\n// <block:config:0>\nconst config = {\n type: 'radar',\n data,\n options: {\n scales: {\n r: {\n ticks: {\n color: 'red'\n }\n }\n }\n }\n};\n// </block:config>\n\nmodule.exports = {\n actions: [],\n config: config,\n};\n```"
}
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 1, \"subpages\", 6, \"subpages\", 0]"
},
{
"title": "Linear Radial Axis",
"description": null,
"content": {
"Configuration Options": {
"Linear Radial Axis specific options": "Namespace: `options.scales[scaleId]`\n\n| Name | Type | Default | Description\n| ---- | ---- | ------- | -----------\n| `animate` | `boolean` | `true` | Whether to animate scaling the chart from the centre\n| `angleLines` | `object` | | Angle line configuration. [more...](#angle-line-options)\n| `beginAtZero` | `boolean` | `false` | If true, scale will include 0 if it is not already included.\n| `pointLabels` | `object` | | Point label configuration. [more...](#point-label-options)\n| `startAngle` | `number` | `0` | Starting angle of the scale. In degrees, 0 is at top.",
"Common options for all axes": "Namespace: `options.scales[scaleId]`\n\n| Name | Type | Default | Description\n| ---- | ---- | ------- | -----------\n| `type` | `string` | | Type of scale being employed. Custom scales can be created and registered with a string key. This allows changing the type of an axis for a chart.\n| `alignToPixels` | `boolean` | `false` | Align pixel values to device pixels.\n| `backgroundColor` | [`Color`](/general/colors.md) | | Background color of the scale area.\n| `display` | `boolean`\\|`string` | `true` | Controls the axis global visibility (visible when `true`, hidden when `false`). When `display: 'auto'`, the axis is visible only if at least one associated dataset is visible.\n| `grid` | `object` | | Grid line configuration. [more...](#grid-line-configuration)\n| `min` | `number` | | User defined minimum number for the scale, overrides minimum value from data. [more...](/axes/index.md#axis-range-settings)\n| `max` | `number` | | User defined maximum number for the scale, overrides maximum value from data. [more...](/axes/index.md#axis-range-settings)\n| `reverse` | `boolean` | `false` | Reverse the scale.\n| `stacked` | `boolean`\\|`string` | `false` | Should the data be stacked. [more...](/axes/index.md#stacking)\n| `suggestedMax` | `number` | | Adjustment used when calculating the maximum data value. [more...](/axes/index.md#axis-range-settings)\n| `suggestedMin` | `number` | | Adjustment used when calculating the minimum data value. [more...](/axes/index.md#axis-range-settings)\n| `ticks` | `object` | | Tick configuration. [more...](/axes/index.md#tick-configuration)\n| `weight` | `number` | `0` | The weight used to sort the axis. Higher weights are further away from the chart area."
},
"Tick Configuration": {
"Linear Radial Axis specific tick options": "Namespace: `options.scales[scaleId].ticks`\n\n| Name | Type | Scriptable | Default | Description\n| ---- | ---- | ------- | ------- | -----------\n| `count` | `number` | Yes | `undefined` | The number of ticks to generate. If specified, this overrides the automatic generation.\n| `format` | `object` | Yes | | The [`Intl.NumberFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat) options used by the default label formatter\n| `maxTicksLimit` | `number` | Yes | `11` | Maximum number of ticks and gridlines to show.\n| `precision` | `number` | Yes | | If defined and `stepSize` is not specified, the step size will be rounded to this many decimal places.\n| `stepSize` | `number` | Yes | | User defined fixed step size for the scale. [more...](#step-size)\n\n!!!include(axes/_common_ticks.md)!!!\n\nThe scriptable context is described in [Options](../../general/options.md#tick) section."
},
"Grid Line Configuration": "Namespace: `options.scales[scaleId].grid`, it defines options for the grid lines of the axis.\n\n| Name | Type | Scriptable | Indexable | Default | Description\n| ---- | ---- | :-------------------------------: | :-----------------------------: | ------- | -----------\n| `borderDash` | `number[]` | | | `[]` | Length and spacing of dashes on grid lines. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash).\n| `borderDashOffset` | `number` | Yes | | `0.0` | Offset for line dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset).\n| `circular` | `boolean` | | | `false` | If true, gridlines are circular (on radar and polar area charts only).\n| `color` | [`Color`](../general/colors.md) | Yes | Yes | `Chart.defaults.borderColor` | The color of the grid lines. If specified as an array, the first color applies to the first grid line, the second to the second grid line, and so on.\n| `display` | `boolean` | | | `true` | If false, do not display grid lines for this axis.\n| `lineWidth` | `number` | Yes | Yes | `1` | Stroke width of grid lines.\n\nThe scriptable context is described in [Options](../general/options.md#tick) section.",
"Axis Range Settings": "Given the number of axis range settings, it is important to understand how they all interact with each other.\n\nThe `suggestedMax` and `suggestedMin` settings only change the data values that are used to scale the axis. These are useful for extending the range of the axis while maintaining the auto-fit behaviour.\n\n```\nlet minDataValue = Math.min(mostNegativeValue, options.ticks.suggestedMin);\nlet maxDataValue = Math.max(mostPositiveValue, options.ticks.suggestedMax);\n```\n\nIn this example, the largest positive value is 50, but the data maximum is expanded out to 100. However, because the lowest data value is below the `suggestedMin` setting, it is ignored.\n\n```\nlet chart = new Chart(ctx, {\n type: 'radar',\n data: {\n datasets: [{\n label: 'First dataset',\n data: [0, 20, 40, 50]\n }],\n labels: ['January', 'February', 'March', 'April']\n },\n options: {\n scales: {\n r: {\n suggestedMin: 50,\n suggestedMax: 100\n }\n }\n }\n});\n```\n\nIn contrast to the `suggested*` settings, the `min` and `max` settings set explicit ends to the axes. When these are set, some data points may not be visible.",
"Step Size": "If set, the scale ticks will be enumerated by multiple of `stepSize`, having one tick per increment. If not set, the ticks are labeled automatically using the nice numbers algorithm.\n\nThis example sets up a chart with a y axis that creates ticks at `0, 0.5, 1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5, 5`.\n\n```\nlet options = {\n scales: {\n r: {\n max: 5,\n min: 0,\n ticks: {\n stepSize: 0.5\n }\n }\n }\n};\n```",
"Angle Line Options": "The following options are used to configure angled lines that radiate from the center of the chart to the point labels.\nNamespace: `options.scales[scaleId].angleLines`\n\n| Name | Type | Scriptable | Default | Description\n| ---- | ---- | ------- | ------- | -----------\n| `display` | `boolean` | | `true` | If true, angle lines are shown.\n| `color` | [`Color`](../../general/colors.md) | Yes | `Chart.defaults.borderColor` | Color of angled lines.\n| `lineWidth` | `number` | Yes | `1` | Width of angled lines.\n| `borderDash` | `number[]` | Yes<sup>1</sup> | `[]` | Length and spacing of dashes on angled lines. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash).\n| `borderDashOffset` | `number` | Yes | `0.0` | Offset for line dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset).\n\n['the `borderDash` setting only accepts a static value or a function. Passing an array of arrays is not supported.']\n\nThe scriptable context is described in [Options](../../general/options.md#pointLabel) section.",
"Point Label Options": "The following options are used to configure the point labels that are shown on the perimeter of the scale.\nNamespace: `options.scales[scaleId].pointLabels`\n\n| Name | Type | Scriptable | Default | Description\n| ---- | ---- | ------- | ------- | -----------\n| `backdropColor` | [`Color`](../../general/colors.md) | `true` | `undefined` | Background color of the point label.\n| `backdropPadding` | [`Padding`](../../general/padding.md) | | `2` | Padding of label backdrop.\n| `borderRadius` | `number`\\|`object` | `true` | `0` | Border radius of the point label\n| `display` | `boolean`\\|`string` | | `true` | If true, point labels are shown. When `display: 'auto'`, the label is hidden if it overlaps with another label.\n| `callback` | `function` | | | Callback function to transform data labels to point labels. The default implementation simply returns the current string.\n| `color` | [`Color`](../../general/colors.md) | Yes | `Chart.defaults.color` | Color of label.\n| `font` | `Font` | Yes | `Chart.defaults.font` | See [Fonts](../../general/fonts.md)\n| `padding` | `number` | Yes | 5 | Padding between chart and point labels.\n| [`centerPointLabels`](../../samples/other-charts/polar-area-center-labels.md) | `boolean` | | `false` | If true, point labels are centered.\n\nThe scriptable context is described in [Options](../../general/options.md#pointLabel) section.",
"Internal data format": "Internally, the linear radial scale uses numeric data"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 1, \"subpages\", 6, \"subpages\", 1]"
}
],
"path": "[\"subpages\", 1, \"subpages\", 6]"
}
],
"path": "[\"subpages\", 1]"
},
{
"title": "Charts",
"description": "Documentation section: charts",
"content": {},
"metadata": {
"type": "directory",
"path": "/home/anhnh/CodeWikiBench/data/Chart.js/original/docs/charts"
},
"subpages": [
{
"title": "Area Chart",
"description": null,
"content": {
"Filling modes": {
"Example": "```\nnew Chart(ctx, {\n data: {\n datasets: [\n {fill: 'origin'}, // 0: fill to 'origin'\n {fill: '+2'}, // 1: fill to dataset 3\n {fill: 1}, // 2: fill to dataset 1\n {fill: false}, // 3: no fill\n {fill: '-2'}, // 4: fill to dataset 2\n {fill: {value: 25}} // 5: fill to axis value 25\n ]\n }\n});\n```\n\nIf you need to support multiple colors when filling from one dataset to another, you may specify an object with the following option :\n\n| Param | Type | Description |\n| :--- | :--- | :--- |\n| `target` | `number`, `string`, `boolean`, `object` | The accepted values are the same as the filling mode values, so you may use absolute and relative dataset indexes and/or boundaries. |\n| `above` | `Color` | If no color is set, the default color will be the background color of the chart. |\n| `below` | `Color` | Same as the above. |",
"Example with multiple colors": "```\nnew Chart(ctx, {\n data: {\n datasets: [\n {\n fill: {\n target: 'origin',\n above: 'rgb(255, 0, 0)', // Area will be red above the origin\n below: 'rgb(0, 0, 255)' // And blue below the origin\n }\n }\n ]\n }\n});\n```"
},
"Configuration": {
"propagate": {
"Example using propagate": "```\nnew Chart(ctx, {\n data: {\n datasets: [\n {fill: 'origin'}, // 0: fill to 'origin'\n {fill: '-1'}, // 1: fill to dataset 0\n {fill: 1}, // 2: fill to dataset 1\n {fill: false}, // 3: no fill\n {fill: '-2'} // 4: fill to dataset 2\n ]\n },\n options: {\n plugins: {\n filler: {\n propagate: true\n }\n }\n }\n});\n```\n\n`propagate: true`:\n-if dataset 2 is hidden, dataset 4 will fill to dataset 1\n-if dataset 2 and 1 are hidden, dataset 4 will fill to `'origin'`\n\n`propagate: false`:\n-if dataset 2 and/or 4 are hidden, dataset 4 will not be filled"
}
}
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 2, \"subpages\", 0]"
},
{
"title": "Bar Chart",
"description": null,
"content": {
"Dataset Properties": {
"Example dataset configuration": "```\ndata: {\n datasets: [{\n barPercentage: 0.5,\n barThickness: 6,\n maxBarThickness: 8,\n minBarLength: 2,\n data: [10, 20, 30, 40, 50, 60, 70]\n }]\n};\n```",
"General": "| Name | Description\n| ---- | ----\n| `base` | Base value for the bar in data units along the value axis. If not set, defaults to the value axis base value.\n| `clip` | How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. `0` = clip at chartArea. Clipping can also be configured per side: `clip: {left: 5, top: false, right: -2, bottom: 0}`\n| `grouped` | Should the bars be grouped on index axis. When `true`, all the datasets at same index value will be placed next to each other centering on that index value. When `false`, each bar is placed on its actual index-axis value.\n| `indexAxis` | The base axis of the dataset. `'x'` for vertical bars and `'y'` for horizontal bars.\n| `label` | The label for the dataset which appears in the legend and tooltips.\n| `order` | The drawing order of dataset. Also affects order for stacking, tooltip and legend. [more](mixed.md#drawing-order)\n| `skipNull` | If `true`, null or undefined values will not be used for spacing calculations when determining bar size.\n| `stack` | The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack). [more](#stacked-bar-chart)\n| `xAxisID` | The ID of the x-axis to plot this dataset on.\n| `yAxisID` | The ID of the y-axis to plot this dataset on.",
"Styling": {
"borderSkipped": "This setting is used to avoid drawing the bar stroke at the base of the fill, or disable the border radius.\nIn general, this does not need to be changed except when creating chart types\nthat derive from a bar chart.\n\n:::tip Note\nFor negative bars in a vertical chart, `top` and `bottom` are flipped. Same goes for `left` and `right` in a horizontal chart.\n:::\n\nOptions are:\n\n[\"`'start'`\", \"`'end'`\", \"`'middle'` (only valid on stacked bars: the borders between bars are skipped)\", \"`'bottom'`\", \"`'left'`\", \"`'top'`\", \"`'right'`\", \"`false` (don't skip any borders)\", '`true` (skip all borders)']",
"borderWidth": "If this value is a number, it is applied to all sides of the rectangle (left, top, right, bottom), except [`borderSkipped`](#borderskipped). If this value is an object, the `left` property defines the left border width. Similarly, the `right`, `top`, and `bottom` properties can also be specified. Omitted borders and [`borderSkipped`](#borderskipped) are skipped.",
"borderRadius": "If this value is a number, it is applied to all corners of the rectangle (topLeft, topRight, bottomLeft, bottomRight), except corners touching the [`borderSkipped`](#borderskipped). If this value is an object, the `topLeft` property defines the top-left corners border radius. Similarly, the `topRight`, `bottomLeft`, and `bottomRight` properties can also be specified. Omitted corners and those touching the [`borderSkipped`](#borderskipped) are skipped. For example if the `top` border is skipped, the border radius for the corners `topLeft` and `topRight` will be skipped as well.\n\n:::tip Stacked Charts\nWhen the border radius is supplied as a number and the chart is stacked, the radius will only be applied to the bars that are at the edges of the stack or where the bar is floating. The object syntax can be used to override this behavior.\n:::",
"inflateAmount": "This option can be used to inflate the rects that are used to draw the bars. This can be used to hide artifacts between bars when [`barPercentage`](#barpercentage) * [`categoryPercentage`](#categorypercentage) is 1. The default value `'auto'` should work in most cases."
},
"Interactions": "The interaction with each bar can be controlled with the following properties:\n\n| Name | Description\n| ---- | -----------\n| `hoverBackgroundColor` | The bar background color when hovered.\n| `hoverBorderColor` | The bar border color when hovered.\n| `hoverBorderWidth` | The bar border width when hovered (in pixels).\n| `hoverBorderRadius` | The bar border radius when hovered (in pixels).\n\nAll these values, if `undefined`, fallback to the associated [`elements.bar.*`](../configuration/elements.md#bar-configuration) options.",
"barPercentage": "Percent (0-1) of the available width each bar should be within the category width. 1.0 will take the whole category width and put the bars right next to each other. [more...](#barpercentage-vs-categorypercentage)",
"categoryPercentage": "Percent (0-1) of the available width each category should be within the sample width. [more...](#barpercentage-vs-categorypercentage)",
"barThickness": "If this value is a number, it is applied to the width of each bar, in pixels. When this is enforced, `barPercentage` and `categoryPercentage` are ignored.\n\nIf set to `'flex'`, the base sample widths are calculated automatically based on the previous and following samples so that they take the full available widths without overlap. Then, bars are sized using `barPercentage` and `categoryPercentage`. There is no gap when the percentage options are 1. This mode generates bars with different widths when data are not evenly spaced.\n\nIf not set (default), the base sample widths are calculated using the smallest interval that prevents bar overlapping, and bars are sized using `barPercentage` and `categoryPercentage`. This mode always generates bars equally sized.",
"maxBarThickness": "Set this to ensure that bars are not sized thicker than this."
},
"Scale Configuration": {
"Example scale configuration": "```\noptions = {\n scales: {\n x: {\n grid: {\n offset: true\n }\n }\n }\n};\n```",
"Offset Grid Lines": "If true, the bars for a particular data point fall between the grid lines. The grid line will move to the left by one half of the tick interval, which is the space between the grid lines. If false, the grid line will go right down the middle of the bars. This is set to true for a category scale in a bar chart while false for other scales or chart types by default."
},
"Default Options": "It is common to want to apply a configuration setting to all created bar charts. The global bar chart settings are stored in `Chart.overrides.bar`. Changing the global options only affects charts created after the change. Existing charts are not changed.",
"barPercentage vs categoryPercentage": "The following shows the relationship between the bar percentage option and the category percentage option.\n\n```\n// categoryPercentage: 1.0\n// barPercentage: 1.0\nBar: | 1.0 | 1.0 |\nCategory: | 1.0 |\nSample: |===========|\n\n// categoryPercentage: 1.0\n// barPercentage: 0.5\nBar: |.5| |.5|\nCategory: | 1.0 |\nSample: |==============|\n\n// categoryPercentage: 0.5\n// barPercentage: 1.0\nBar: |1.0||1.0|\nCategory: | .5 |\nSample: |==================|\n```",
"Data Structure": "All the supported [data structures](../general/data-structures.md) can be used with bar charts.",
"Stacked Bar Chart": "Bar charts can be configured into stacked bar charts by changing the settings on the X and Y axes to enable stacking. Stacked bar charts can be used to show how one data series is made up of a number of smaller pieces.\n\n```\nconst stackedBar = new Chart(ctx, {\n type: 'bar',\n data: data,\n options: {\n scales: {\n x: {\n stacked: true\n },\n y: {\n stacked: true\n }\n }\n }\n});\n```",
"Horizontal Bar Chart": {
"Horizontal Bar Chart config Options": "The configuration options for the horizontal bar chart are the same as for the [bar chart](#scale-configuration). However, any options specified on the x-axis in a bar chart, are applied to the y-axis in a horizontal bar chart."
},
"Internal data format": "`{x, y, _custom}` where `_custom` is an optional object defining stacked bar properties: `{start, end, barStart, barEnd, min, max}`. `start` and `end` are the input values. Those two are repeated in `barStart` (closer to origin), `barEnd` (further from origin), `min` and `max`."
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 2, \"subpages\", 1]"
},
{
"title": "Bubble Chart",
"description": null,
"content": {
"Dataset Properties": {
"General": "| Name | Description\n| ---- | ----\n| `clip` | How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. `0` = clip at chartArea. Clipping can also be configured per side: `clip: {left: 5, top: false, right: -2, bottom: 0}`\n| `drawActiveElementsOnTop` | Draw the active bubbles of a dataset over the other bubbles of the dataset\n| `label` | The label for the dataset which appears in the legend and tooltips.\n| `order` | The drawing order of dataset. Also affects order for tooltip and legend. [more](mixed.md#drawing-order)",
"Styling": "The style of each bubble can be controlled with the following properties:\n\n| Name | Description\n| ---- | ----\n| `backgroundColor` | bubble background color.\n| `borderColor` | bubble border color.\n| `borderWidth` | bubble border width (in pixels).\n| `pointStyle` | bubble [shape style](../configuration/elements.md#point-styles).\n| `rotation` | bubble rotation (in degrees).\n| `radius` | bubble radius (in pixels).\n\nAll these values, if `undefined`, fallback to the associated [`elements.point.*`](../configuration/elements.md#point-configuration) options.",
"Interactions": "The interaction with each bubble can be controlled with the following properties:\n\n| Name | Description\n| ---- | -----------\n| `hitRadius` | bubble **additional** radius for hit detection (in pixels).\n| `hoverBackgroundColor` | bubble background color when hovered.\n| `hoverBorderColor` | bubble border color when hovered.\n| `hoverBorderWidth` | bubble border width when hovered (in pixels).\n| `hoverRadius` | bubble **additional** radius when hovered (in pixels).\n\nAll these values, if `undefined`, fallback to the associated [`elements.point.*`](../configuration/elements.md#point-configuration) options."
},
"Default Options": "We can also change the default values for the Bubble chart type. Doing so will give all bubble charts created after this point the new defaults. The default configuration for the bubble chart can be accessed at `Chart.overrides.bubble`.",
"Data Structure": "Bubble chart datasets need to contain a `data` array of points, each point represented by an object containing the following properties:\n\n```\n{\n // X Value\n x: number,\n\n // Y Value\n y: number,\n\n // Bubble radius in pixels (not scaled).\n r: number\n}\n```\n\n**Important:** the radius property, `r` is **not** scaled by the chart, it is the raw radius in pixels of the bubble that is drawn on the canvas.",
"Internal data format": "`{x, y, _custom}` where `_custom` is the radius."
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 2, \"subpages\", 2]"
},
{
"title": "Doughnut and Pie Charts",
"description": null,
"content": {
"Dataset Properties": {
"General": "| Name | Description\n| ---- | ----\n| `circumference` | Per-dataset override for the sweep that the arcs cover\n| `clip` | How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. `0` = clip at chartArea. Clipping can also be configured per side: `clip: {left: 5, top: false, right: -2, bottom: 0}`\n| `rotation` | Per-dataset override for the starting angle to draw arcs from",
"Styling": "The style of each arc can be controlled with the following properties:\n\n| Name | Description\n| ---- | ----\n| `backgroundColor` | arc background color.\n| `borderColor` | arc border color.\n| `borderDash` | arc border length and spacing of dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash).\n| `borderDashOffset` | arc border offset for line dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset).\n| `borderJoinStyle` | arc border join style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin).\n| `borderWidth` | arc border width (in pixels).\n| `offset` | arc offset (in pixels).\n| `spacing` | Fixed arc offset (in pixels). Similar to `offset` but applies to all arcs.\n| `weight` | The relative thickness of the dataset. Providing a value for weight will cause the pie or doughnut dataset to be drawn with a thickness relative to the sum of all the dataset weight values.\n\nAll these values, if `undefined`, fallback to the associated [`elements.arc.*`](../configuration/elements.md#arc-configuration) options.",
"Border Alignment": "The following values are supported for `borderAlign`.\n\n[\"`'center'` (default)\", \"`'inner'`\"]\n\nWhen `'center'` is set, the borders of arcs next to each other will overlap. When `'inner'` is set, it is guaranteed that all borders will not overlap.",
"Border Radius": "If this value is a number, it is applied to all corners of the arc (outerStart, outerEnd, innerStart, innerRight). If this value is an object, the `outerStart` property defines the outer-start corner's border radius. Similarly, the `outerEnd`, `innerStart`, and `innerEnd` properties can also be specified.",
"Interactions": "The interaction with each arc can be controlled with the following properties:\n\n| Name | Description\n| ---- | -----------\n| `hoverBackgroundColor` | arc background color when hovered.\n| `hoverBorderColor` | arc border color when hovered.\n| `hoverBorderDash` | arc border length and spacing of dashes when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash).\n| `hoverBorderDashOffset` | arc border offset for line dashes when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset).\n| `hoverBorderJoinStyle` | arc border join style when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin).\n| `hoverBorderWidth` | arc border width when hovered (in pixels).\n| `hoverOffset` | arc offset when hovered (in pixels).\n\nAll these values, if `undefined`, fallback to the associated [`elements.arc.*`](../configuration/elements.md#arc-configuration) options."
},
"Config Options": "These are the customisation options specific to Pie & Doughnut charts. These options are looked up on access, and form together with the global chart configuration the options of the chart.\n\n| Name | Type | Default | Description\n| ---- | ---- | ------- | -----------\n| `cutout` | `number`\\|`string` | `50%` - for doughnut, `0` - for pie | The portion of the chart that is cut out of the middle. If `string` and ending with '%', percentage of the chart radius. `number` is considered to be pixels.\n| `radius` | `number`\\|`string` | `100%` | The outer radius of the chart. If `string` and ending with '%', percentage of the maximum radius. `number` is considered to be pixels.\n| `rotation` | `number` | 0 | Starting angle to draw arcs from.\n| `circumference` | `number` | 360 | Sweep to allow arcs to cover.\n| `animation.animateRotate` | `boolean` | `true` | If true, the chart will animate in with a rotation animation. This property is in the `options.animation` object.\n| `animation.animateScale` | `boolean` | `false` | If true, will animate scaling the chart from the center outwards.",
"Default Options": "We can also change these default values for each Doughnut type that is created, this object is available at `Chart.overrides.doughnut`. Pie charts also have a clone of these defaults available to change at `Chart.overrides.pie`, with the only difference being `cutout` being set to 0.",
"Data Structure": "For a pie chart, datasets need to contain an array of data points. The data points should be a number, Chart.js will total all the numbers and calculate the relative proportion of each.\n\nYou also need to specify an array of labels so that tooltips appear correctly.\n\n```\ndata = {\n datasets: [{\n data: [10, 20, 30]\n }],\n\n // These labels appear in the legend and in the tooltips when hovering different arcs\n labels: [\n 'Red',\n 'Yellow',\n 'Blue'\n ]\n};\n```"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 2, \"subpages\", 3]"
},
{
"title": "Line Chart",
"description": null,
"content": {
"Dataset Properties": {
"General": "| Name | Description\n| ---- | ----\n| `clip` | How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. `0` = clip at chartArea. Clipping can also be configured per side: `clip: {left: 5, top: false, right: -2, bottom: 0}`\n| `drawActiveElementsOnTop` | Draw the active points of a dataset over the other points of the dataset\n| `indexAxis` | The base axis of the dataset. `'x'` for horizontal lines and `'y'` for vertical lines.\n| `label` | The label for the dataset which appears in the legend and tooltips.\n| `order` | The drawing order of dataset. Also affects order for stacking, tooltip and legend. [more](mixed.md#drawing-order)\n| `stack` | The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack). [more](#stacked-area-chart)\n| `xAxisID` | The ID of the x-axis to plot this dataset on.\n| `yAxisID` | The ID of the y-axis to plot this dataset on.",
"Point Styling": "The style of each point can be controlled with the following properties:\n\n| Name | Description\n| ---- | ----\n| `pointBackgroundColor` | The fill color for points.\n| `pointBorderColor` | The border color for points.\n| `pointBorderWidth` | The width of the point border in pixels.\n| `pointHitRadius` | The pixel size of the non-displayed point that reacts to mouse events.\n| `pointRadius` | The radius of the point shape. If set to 0, the point is not rendered.\n| `pointRotation` | The rotation of the point in degrees.\n| `pointStyle` | Style of the point. [more...](../configuration/elements.md#point-styles)\n\nAll these values, if `undefined`, fallback first to the dataset options then to the associated [`elements.point.*`](../configuration/elements.md#point-configuration) options.",
"Line Styling": "The style of the line can be controlled with the following properties:\n\n| Name | Description\n| ---- | ----\n| `backgroundColor` | The line fill color.\n| `borderCapStyle` | Cap style of the line. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap).\n| `borderColor` | The line color.\n| `borderDash` | Length and spacing of dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash).\n| `borderDashOffset` | Offset for line dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset).\n| `borderJoinStyle` | Line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin).\n| `borderWidth` | The line width (in pixels).\n| `fill` | How to fill the area under the line. See [area charts](area.md).\n| `tension` | Bezier curve tension of the line. Set to 0 to draw straightlines. This option is ignored if monotone cubic interpolation is used.\n| `showLine` | If false, the line is not drawn for this dataset.\n| `spanGaps` | If true, lines will be drawn between points with no or null data. If false, points with `null` data will create a break in the line. Can also be a number specifying the maximum gap length to span. The unit of the value depends on the scale used.\n\nIf the value is `undefined`, the values fallback to the associated [`elements.line.*`](../configuration/elements.md#line-configuration) options.",
"Interactions": "The interaction with each point can be controlled with the following properties:\n\n| Name | Description\n| ---- | -----------\n| `pointHoverBackgroundColor` | Point background color when hovered.\n| `pointHoverBorderColor` | Point border color when hovered.\n| `pointHoverBorderWidth` | Border width of point when hovered.\n| `pointHoverRadius` | The radius of the point when hovered.",
"cubicInterpolationMode": "The following interpolation modes are supported.\n\n[\"`'default'`\", \"`'monotone'`\"]\n\nThe `'default'` algorithm uses a custom weighted cubic interpolation, which produces pleasant curves for all types of datasets.\n\nThe `'monotone'` algorithm is more suited to `y = f(x)` datasets: it preserves monotonicity (or piecewise monotonicity) of the dataset being interpolated, and ensures local extremums (if any) stay at input data points.\n\nIf left untouched (`undefined`), the global `options.elements.line.cubicInterpolationMode` property is used.",
"Segment": "Line segment styles can be overridden by scriptable options in the `segment` object. Currently, all of the `border*` and `backgroundColor` options are supported. The segment styles are resolved for each section of the line between each point. `undefined` fallbacks to main line styles.\n\n:::tip\nTo be able to style gaps, you need the [`spanGaps`](#line-styling) option enabled.\n:::\n\nContext for the scriptable segment contains the following properties:\n\n[\"`type`: `'segment'`\", '`p0`: first point element', '`p1`: second point element', '`p0DataIndex`: index of first point in the data array', '`p1DataIndex`: index of second point in the data array', '`datasetIndex`: dataset index']\n\n[Example usage](../samples/line/segments.md)",
"Stepped": "The following values are supported for `stepped`.\n\n['`false`: No Step Interpolation (default)', \"`true`: Step-before Interpolation (eq. `'before'`)\", \"`'before'`: Step-before Interpolation\", \"`'after'`: Step-after Interpolation\", \"`'middle'`: Step-middle Interpolation\"]\n\nIf the `stepped` value is set to anything other than false, `tension` will be ignored."
},
"Default Options": "It is common to want to apply a configuration setting to all created line charts. The global line chart settings are stored in `Chart.overrides.line`. Changing the global options only affects charts created after the change. Existing charts are not changed.\n\nFor example, to configure all line charts with `spanGaps = true` you would do:\n\n```\nChart.overrides.line.spanGaps = true;\n```",
"Data Structure": "All the supported [data structures](../general/data-structures.md) can be used with line charts.",
"Stacked Area Chart": "Line charts can be configured into stacked area charts by changing the settings on the y-axis to enable stacking. Stacked area charts can be used to show how one data trend is made up of a number of smaller pieces.\n\n```\nconst stackedLine = new Chart(ctx, {\n type: 'line',\n data: data,\n options: {\n scales: {\n y: {\n stacked: true\n }\n }\n }\n});\n```",
"Vertical Line Chart": {
"Config Options": "The configuration options for the vertical line chart are the same as for the [line chart](#configuration-options). However, any options specified on the x-axis in a line chart, are applied to the y-axis in a vertical line chart."
},
"Internal data format": "`{x, y}`"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 2, \"subpages\", 4]"
},
{
"title": "Mixed Chart Types",
"description": null,
"content": {
"Drawing order": "By default, datasets are drawn such that the first one is top-most. This can be altered by specifying `order` option to datasets. `order` defaults to `0`. Note that this also affects stacking, legend, and tooltip. So it's essentially the same as reordering the datasets.\n\nThe `order` property behaves like a weight instead of a specific order, so the higher the number, the sooner that dataset is drawn on the canvas and thus other datasets with a lower order number will get drawn over it.\n\n```\nconst mixedChart = new Chart(ctx, {\n type: 'bar',\n data: {\n datasets: [{\n label: 'Bar Dataset',\n data: [10, 20, 30, 40],\n // this dataset is drawn below\n order: 2\n }, {\n label: 'Line Dataset',\n data: [10, 10, 10, 10],\n type: 'line',\n // this dataset is drawn on top\n order: 1\n }],\n labels: ['January', 'February', 'March', 'April']\n },\n options: options\n});\n```"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 2, \"subpages\", 5]"
},
{
"title": "Polar Area Chart",
"description": null,
"content": {
"Dataset Properties": {
"General": "| Name | Description\n| ---- | ----\n| `clip` | How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. `0` = clip at chartArea. Clipping can also be configured per side: `clip: {left: 5, top: false, right: -2, bottom: 0}`",
"Styling": "The style of each arc can be controlled with the following properties:\n\n| Name | Description\n| ---- | ----\n| `backgroundColor` | arc background color.\n| `borderColor` | arc border color.\n| `borderDash` | arc border length and spacing of dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash).\n| `borderDashOffset` | arc border offset for line dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset).\n| `borderJoinStyle` | arc border join style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin).\n| `borderWidth` | arc border width (in pixels).\n| `circular` | By default the Arc is curved. If `circular: false` the Arc will be flat.\n\nAll these values, if `undefined`, fallback to the associated [`elements.arc.*`](../configuration/elements.md#arc-configuration) options.",
"Border Alignment": "The following values are supported for `borderAlign`.\n\n[\"`'center'` (default)\", \"`'inner'`\"]\n\nWhen `'center'` is set, the borders of arcs next to each other will overlap. When `'inner'` is set, it is guaranteed that all the borders do not overlap.",
"Interactions": "The interaction with each arc can be controlled with the following properties:\n\n| Name | Description\n| ---- | -----------\n| `hoverBackgroundColor` | arc background color when hovered.\n| `hoverBorderColor` | arc border color when hovered.\n| `hoverBorderDash` | arc border length and spacing of dashes when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash).\n| `hoverBorderDashOffset` | arc border offset for line dashes when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset).\n| `hoverBorderJoinStyle` | arc border join style when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin).\n| `hoverBorderWidth` | arc border width when hovered (in pixels).\n\nAll these values, if `undefined`, fallback to the associated [`elements.arc.*`](../configuration/elements.md#arc-configuration) options."
},
"Config Options": "These are the customisation options specific to Polar Area charts. These options are looked up on access, and form together with the [global chart default options](#default-options) the options of the chart.\n\n| Name | Type | Default | Description\n| ---- | ---- | ------- | -----------\n| `animation.animateRotate` | `boolean` | `true` | If true, the chart will animate in with a rotation animation. This property is in the `options.animation` object.\n| `animation.animateScale` | `boolean` | `true` | If true, will animate scaling the chart from the center outwards.\n\nThe polar area chart uses the [radialLinear](../axes/radial/linear.md) scale. Additional configuration is provided via the scale.",
"Default Options": "We can also change these default values for each PolarArea type that is created, this object is available at `Chart.overrides.polarArea`. Changing the global options only affects charts created after the change. Existing charts are not changed.\n\nFor example, to configure all new polar area charts with `animateScale = false` you would do:\n\n```\nChart.overrides.polarArea.animation.animateScale = false;\n```",
"Data Structure": "For a polar area chart, datasets need to contain an array of data points. The data points should be a number, Chart.js will total all of the numbers and calculate the relative proportion of each.\n\nYou also need to specify an array of labels so that tooltips appear correctly for each slice.\n\n```\ndata = {\n datasets: [{\n data: [10, 20, 30]\n }],\n\n // These labels appear in the legend and in the tooltips when hovering different arcs\n labels: [\n 'Red',\n 'Yellow',\n 'Blue'\n ]\n};\n```"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 2, \"subpages\", 6]"
},
{
"title": "Radar Chart",
"description": null,
"content": {
"Dataset Properties": {
"General": "| Name | Description\n| ---- | ----\n| `clip` | How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. `0` = clip at chartArea. Clipping can also be configured per side: `clip: {left: 5, top: false, right: -2, bottom: 0}`\n| `label` | The label for the dataset which appears in the legend and tooltips.\n| `order` | The drawing order of dataset. Also affects order for tooltip and legend. [more](mixed.md#drawing-order)",
"Point Styling": "The style of each point can be controlled with the following properties:\n\n| Name | Description\n| ---- | ----\n| `pointBackgroundColor` | The fill color for points.\n| `pointBorderColor` | The border color for points.\n| `pointBorderWidth` | The width of the point border in pixels.\n| `pointHitRadius` | The pixel size of the non-displayed point that reacts to mouse events.\n| `pointRadius` | The radius of the point shape. If set to 0, the point is not rendered.\n| `pointRotation` | The rotation of the point in degrees.\n| `pointStyle` | Style of the point. [more...](../configuration/elements#point-styles)\n\nAll these values, if `undefined`, fallback first to the dataset options then to the associated [`elements.point.*`](../configuration/elements.md#point-configuration) options.",
"Line Styling": "The style of the line can be controlled with the following properties:\n\n| Name | Description\n| ---- | ----\n| `backgroundColor` | The line fill color.\n| `borderCapStyle` | Cap style of the line. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap).\n| `borderColor` | The line color.\n| `borderDash` | Length and spacing of dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash).\n| `borderDashOffset` | Offset for line dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset).\n| `borderJoinStyle` | Line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin).\n| `borderWidth` | The line width (in pixels).\n| `fill` | How to fill the area under the line. See [area charts](area.md).\n| `tension` | Bezier curve tension of the line. Set to 0 to draw straight lines.\n| `spanGaps` | If true, lines will be drawn between points with no or null data. If false, points with `null` data will create a break in the line.\n\nIf the value is `undefined`, the values fallback to the associated [`elements.line.*`](../configuration/elements.md#line-configuration) options.",
"Interactions": "The interaction with each point can be controlled with the following properties:\n\n| Name | Description\n| ---- | -----------\n| `pointHoverBackgroundColor` | Point background color when hovered.\n| `pointHoverBorderColor` | Point border color when hovered.\n| `pointHoverBorderWidth` | Border width of point when hovered.\n| `pointHoverRadius` | The radius of the point when hovered."
},
"Scale Options": "The radar chart supports only a single scale. The options for this scale are defined in the `scales.r` property, which can be referenced from the [Linear Radial Axis page](../axes/radial/linear).\n\n```\noptions = {\n scales: {\n r: {\n angleLines: {\n display: false\n },\n suggestedMin: 50,\n suggestedMax: 100\n }\n }\n};\n```",
"Default Options": "It is common to want to apply a configuration setting to all created radar charts. The global radar chart settings are stored in `Chart.overrides.radar`. Changing the global options only affects charts created after the change. Existing charts are not changed.",
"Data Structure": "The `data` property of a dataset for a radar chart is specified as an array of numbers. Each point in the data array corresponds to the label at the same index.\n\n```\ndata: [20, 10]\n```\n\nFor a radar chart, to provide context of what each point means, we include an array of strings that show around each point in the chart.\n\n```\ndata: {\n labels: ['Running', 'Swimming', 'Eating', 'Cycling'],\n datasets: [{\n data: [20, 10, 4, 2]\n }]\n}\n```",
"Internal data format": "`{x, y}`"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 2, \"subpages\", 7]"
},
{
"title": "Scatter Chart",
"description": null,
"content": {
"Dataset Properties": "Namespaces:\n\n['`data.datasets[index]` - options for this dataset only', '`options.datasets.scatter` - options for all scatter datasets', '`options.elements.line` - options for all [line elements](../configuration/elements.md#line-configuration)', '`options.elements.point` - options for all [point elements](../configuration/elements.md#point-configuration)', '`options` - options for the whole chart']\n\nThe scatter chart supports all the same properties as the [line chart](./line.md#dataset-properties).\nBy default, the scatter chart will override the showLine property of the line chart to `false`.\n\nThe index scale is of the type `linear`. This means, if you are using the labels array, the values have to be numbers or parsable to numbers, the same applies to the object format for the keys.",
"Data Structure": "Unlike the line chart where data can be supplied in two different formats, the scatter chart only accepts data in a point format.\n\n```\ndata: [{\n x: 10,\n y: 20\n }, {\n x: 15,\n y: 10\n }]\n```",
"Internal data format": "`{x, y}`"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 2, \"subpages\", 8]"
}
],
"path": "[\"subpages\", 2]"
},
{
"title": "Configuration",
"description": "Documentation section: configuration",
"content": {},
"metadata": {
"type": "directory",
"path": "/home/anhnh/CodeWikiBench/data/Chart.js/original/docs/configuration"
},
"subpages": [
{
"title": "Animations",
"description": null,
"content": {
"Animation configuration": "Animation configuration consists of 3 keys.\n\n| Name | Type | Details\n| ---- | ---- | -------\n| animation | `object` | [animation](#animation)\n| animations | `object` | [animations](#animations)\n| transitions | `object` | [transitions](#transitions)\n\nThese keys can be configured in following paths:\n\n['`` - chart options', '`datasets[type]` - dataset type options', '`overrides[type]` - chart type options']\n\nThese paths are valid under `defaults` for global configuration and `options` for instance configuration.",
"animation": "The default configuration is defined here: <a href=\"https://github.com/chartjs/Chart.js/blob/master/src/core/core.animations.defaults.js\" target=\"_blank\">core.animations.defaults.js</a>\n\nNamespace: `options.animation`\n\n| Name | Type | Default | Description\n| ---- | ---- | ------- | -----------\n| `duration` | `number` | `1000` | The number of milliseconds an animation takes.\n| `easing` | `string` | `'easeOutQuart'` | Easing function to use. [more...](#easing)\n| `delay` | `number` | `undefined` | Delay before starting the animations.\n| `loop` | `boolean` | `undefined` | If set to `true`, the animations loop endlessly.\n\nThese defaults can be overridden in `options.animation` or `dataset.animation` and `tooltip.animation`. These keys are also [Scriptable](../general/options.md#scriptable-options).",
"animations": {
"Default animations": "| Name | Option | Value\n| ---- | ------ | -----\n| `numbers` | `properties` | `['x', 'y', 'borderWidth', 'radius', 'tension']`\n| `numbers` | `type` | `'number'`\n| `colors` | `properties` | `['color', 'borderColor', 'backgroundColor']`\n| `colors` | `type` | `'color'`\n\n:::tip Note\nThese default animations are overridden by most of the dataset controllers.\n:::"
},
"transitions": {
"Default transitions": "Namespace: `options.transitions[mode]`\n\n| Mode | Option | Value | Description\n| -----| ------ | ----- | -----\n| `'active'` | animation.duration | 400 | Override default duration to 400ms for hover animations\n| `'resize'` | animation.duration | 0 | Override default duration to 0ms (= no animation) for resize\n| `'show'` | animations.colors | `{ type: 'color', properties: ['borderColor', 'backgroundColor'], from: 'transparent' }` | Colors are faded in from transparent when dataset is shown using legend / [api](../developers/api.md#showdatasetIndex).\n| `'show'` | animations.visible | `{ type: 'boolean', duration: 0 }` | Dataset visibility is immediately changed to true so the color transition from transparent is visible.\n| `'hide'` | animations.colors | `{ type: 'color', properties: ['borderColor', 'backgroundColor'], to: 'transparent' }` | Colors are faded to transparent when dataset id hidden using legend / [api](../developers/api.md#hidedatasetIndex).\n| `'hide'` | animations.visible | `{ type: 'boolean', easing: 'easeInExpo' }` | Visibility is changed to false at a very late phase of animation"
},
"Disabling animation": "To disable an animation configuration, the animation node must be set to `false`, with the exception for animation modes which can be disabled by setting the `duration` to `0`.\n\n```\nchart.options.animation = false; // disables all animations\nchart.options.animations.colors = false; // disables animation defined by the collection of 'colors' properties\nchart.options.animations.x = false; // disables animation defined by the 'x' property\nchart.options.transitions.active.animation.duration = 0; // disables the animation for 'active' mode\n```",
"Easing": "Available options are:\n\n[\"`'linear'`\", \"`'easeInQuad'`\", \"`'easeOutQuad'`\", \"`'easeInOutQuad'`\", \"`'easeInCubic'`\", \"`'easeOutCubic'`\", \"`'easeInOutCubic'`\", \"`'easeInQuart'`\", \"`'easeOutQuart'`\", \"`'easeInOutQuart'`\", \"`'easeInQuint'`\", \"`'easeOutQuint'`\", \"`'easeInOutQuint'`\", \"`'easeInSine'`\", \"`'easeOutSine'`\", \"`'easeInOutSine'`\", \"`'easeInExpo'`\", \"`'easeOutExpo'`\", \"`'easeInOutExpo'`\", \"`'easeInCirc'`\", \"`'easeOutCirc'`\", \"`'easeInOutCirc'`\", \"`'easeInElastic'`\", \"`'easeOutElastic'`\", \"`'easeInOutElastic'`\", \"`'easeInBack'`\", \"`'easeOutBack'`\", \"`'easeInOutBack'`\", \"`'easeInBounce'`\", \"`'easeOutBounce'`\", \"`'easeInOutBounce'`\"]\n\nSee [Robert Penner's easing equations](http://robertpenner.com/easing/).",
"Animation Callbacks": "The animation configuration provides callbacks which are useful for synchronizing an external draw to the chart animation.\nThe callbacks can be set only at main [animation configuration](#animation-configuration).\n\nNamespace: `options.animation`\n\n| Name | Type | Default | Description\n| ---- | ---- | ------- | -----------\n| `onProgress` | `function` | `null` | Callback called on each step of an animation.\n| `onComplete` | `function` | `null` | Callback called when all animations are completed.\n\nThe callback is passed the following object:\n\n```\n{\n // Chart object\n chart: Chart,\n\n // Number of animations still in progress\n currentStep: number,\n\n // `true` for the initial animation of the chart\n initial: boolean,\n\n // Total number of animations at the start of current animation\n numSteps: number,\n}\n```\n\nThe following example fills a progress bar during the chart animation.\n\n```\nconst chart = new Chart(ctx, {\n type: 'line',\n data: data,\n options: {\n animation: {\n onProgress: function(animation) {\n progress.value = animation.currentStep / animation.numSteps;\n }\n }\n }\n});\n```\n\nAnother example usage of these callbacks can be found [in this progress bar sample,](../samples/advanced/progress-bar.md) which displays a progress bar showing how far along the animation is."
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 3, \"subpages\", 0]"
},
{
"title": "Canvas Background",
"description": null,
"content": {
"Canvas background": "In some use cases you would want a background image or color over the whole canvas. There is no built-in support for this, the way you can achieve this is by writing a custom plugin.\n\nIn the two example plugins underneath here you can see how you can draw a color or image to the canvas as background. This way of giving the chart a background is only necessary if you want to export the chart with that specific background.\nFor normal use you can set the background more easily with [CSS](https://www.w3schools.com/cssref/css3_pr_background.asp).\n\n:::: tabs\n\n::: tab Color\n\n```\n// <block:setup:1>\nconst data = {\n labels: [\n 'Red',\n 'Blue',\n 'Yellow'\n ],\n datasets: [{\n label: 'My First Dataset',\n data: [300, 50, 100],\n backgroundColor: [\n 'rgb(255, 99, 132)',\n 'rgb(54, 162, 235)',\n 'rgb(255, 205, 86)'\n ],\n hoverOffset: 4\n }]\n};\n// </block:setup>\n\n// <block:plugin:2>\n// Note: changes to the plugin code is not reflected to the chart, because the plugin is loaded at chart construction time and editor changes only trigger an chart.update().\nconst plugin = {\n id: 'customCanvasBackgroundColor',\n beforeDraw: (chart, args, options) => {\n const {ctx} = chart;\n ctx.save();\n ctx.globalCompositeOperation = 'destination-over';\n ctx.fillStyle = options.color || '#99ffff';\n ctx.fillRect(0, 0, chart.width, chart.height);\n ctx.restore();\n }\n};\n// </block:plugin>\n\n// <block:config:0>\nconst config = {\n type: 'doughnut',\n data: data,\n options: {\n plugins: {\n customCanvasBackgroundColor: {\n color: 'lightGreen',\n }\n }\n },\n plugins: [plugin],\n};\n// </block:config>\n\nmodule.exports = {\n actions: [],\n config: config,\n};\n```\n\n:::\n\n::: tab Image\n\n```\n// <block:setup:1>\nconst data = {\n labels: [\n 'Red',\n 'Blue',\n 'Yellow'\n ],\n datasets: [{\n label: 'My First Dataset',\n data: [300, 50, 100],\n backgroundColor: [\n 'rgb(255, 99, 132)',\n 'rgb(54, 162, 235)',\n 'rgb(255, 205, 86)'\n ],\n hoverOffset: 4\n }]\n};\n// </block:setup>\n\n// <block:plugin:2>\n// Note: changes to the plugin code is not reflected to the chart, because the plugin is loaded at chart construction time and editor changes only trigger an chart.update().\nconst image = new Image();\nimage.src = 'https://www.chartjs.org/img/chartjs-logo.svg';\n\nconst plugin = {\n id: 'customCanvasBackgroundImage',\n beforeDraw: (chart) => {\n if (image.complete) {\n const ctx = chart.ctx;\n const {top, left, width, height} = chart.chartArea;\n const x = left + width / 2 - image.width / 2;\n const y = top + height / 2 - image.height / 2;\n ctx.drawImage(image, x, y);\n } else {\n image.onload = () => chart.draw();\n }\n }\n};\n// </block:plugin>\n\n// <block:config:0>\nconst config = {\n type: 'doughnut',\n data: data,\n plugins: [plugin],\n};\n// </block:config>\n\nmodule.exports = {\n actions: [],\n config: config,\n};\n```\n\n:::\n\n::::"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 3, \"subpages\", 1]"
},
{
"title": "Data Decimation",
"description": null,
"content": {
"Configuration Options": "Namespace: `options.plugins.decimation`, the global options for the plugin are defined in `Chart.defaults.plugins.decimation`.\n\n| Name | Type | Default | Description\n| ---- | ---- | ------- | -----------\n| `enabled` | `boolean` | `false` | Is decimation enabled?\n| `algorithm` | `string` | `'min-max'` | Decimation algorithm to use. See the [more...](#decimation-algorithms)\n| `samples` | `number` | | If the `'lttb'` algorithm is used, this is the number of samples in the output dataset. Defaults to the canvas width to pick 1 sample per pixel.\n| `threshold` | `number` | | If the number of samples in the current axis range is above this value, the decimation will be triggered. Defaults to 4 times the canvas width.<br />The number of point after decimation can be higher than the `threshold` value.",
"Decimation Algorithms": {
"Largest Triangle Three Bucket (LTTB) Decimation": "[LTTB](https://github.com/sveinn-steinarsson/flot-downsample) decimation reduces the number of data points significantly. This is most useful for showing trends in data using only a few data points.",
"Min/Max Decimation": "[Min/max](https://digital.ni.com/public.nsf/allkb/F694FFEEA0ACF282862576020075F784) decimation will preserve peaks in your data but could require up to 4 points for each pixel. This type of decimation would work well for a very noisy signal where you need to see data peaks."
},
"Requirements": "To use the decimation plugin, the following requirements must be met:\n\n[\"The dataset must have an [`indexAxis`](../charts/line.md#general) of `'x'`\", 'The dataset must be a line', \"The X axis for the dataset must be either a [`'linear'`](../axes/cartesian/linear.md) or [`'time'`](../axes/cartesian/time.md) type axis\", 'Data must not need parsing, i.e. [`parsing`](../general/data-structures.md#dataset-configuration) must be `false`', 'The dataset object must be mutable. The plugin stores the original data as `dataset._data` and then defines a new `data` property on the dataset.', 'There must be more points on the chart than the threshold value. Take a look at the Configuration Options for more information.']",
"Related Samples": [
"[Data Decimation Sample](../samples/advanced/data-decimation)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 3, \"subpages\", 2]"
},
{
"title": "Device Pixel Ratio",
"description": null,
"content": {
"Configuration Options": "Namespace: `options`\n\n| Name | Type | Default | Description\n| ---- | ---- | ------- | -----------\n| `devicePixelRatio` | `number` | `window.devicePixelRatio` | Override the window's default devicePixelRatio."
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 3, \"subpages\", 3]"
},
{
"title": "Elements",
"description": null,
"content": {
"Global Configuration": "The element options can be specified per chart or globally. The global options for elements are defined in `Chart.defaults.elements`. For example, to set the border width of all bar charts globally, you would do:\n\n```\nChart.defaults.elements.bar.borderWidth = 2;\n```",
"Point Configuration": {
"Point Styles": {
"Types": "The `pointStyle` argument accepts the following type of inputs: `string`, `Image` and `HTMLCanvasElement`",
"Info": "When a string is provided, the following values are supported:\n\n[\"`'circle'`\", \"`'cross'`\", \"`'crossRot'`\", \"`'dash'`\", \"`'line'`\", \"`'rect'`\", \"`'rectRounded'`\", \"`'rectRot'`\", \"`'star'`\", \"`'triangle'`\", '`false`']\n\nIf the value is an image or a canvas element, that image or canvas element is drawn on the canvas using [drawImage](https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/drawImage)."
}
},
"Line Configuration": "Line elements are used to represent the line in a line chart.\n\nNamespace: `options.elements.line`, global line options: `Chart.defaults.elements.line`.\n\n| Name | Type | Default | Description\n| ---- | ---- | ------- | -----------\n| `tension` | `number` | `0` | B\u00e9zier curve tension (`0` for no B\u00e9zier curves).\n| `backgroundColor` | [`Color`](/general/colors.md) | `Chart.defaults.backgroundColor` | Line fill color.\n| `borderWidth` | `number` | `3` | Line stroke width.\n| `borderColor` | [`Color`](/general/colors.md) | `Chart.defaults.borderColor` | Line stroke color.\n| `borderCapStyle` | `string` | `'butt'` | Line cap style. See [MDN](https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineCap).\n| `borderDash` | `number[]` | `[]` | Line dash. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash).\n| `borderDashOffset` | `number` | `0.0` | Line dash offset. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset).\n| `borderJoinStyle` | `'round'`\\|`'bevel'`\\|`'miter'` | `'miter'` | Line join style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin).\n| `capBezierPoints` | `boolean` | `true` | `true` to keep B\u00e9zier control inside the chart, `false` for no restriction.\n| `cubicInterpolationMode` | `string` | `'default'` | Interpolation mode to apply. [See more...](/charts/line.md#cubicinterpolationmode)\n| `fill` | `boolean`\\|`string` | `false` | How to fill the area under the line. See [area charts](/charts/area.md#filling-modes).\n| `stepped` | `boolean` | `false` | `true` to show the line as a stepped line (`tension` will be ignored).",
"Bar Configuration": "Bar elements are used to represent the bars in a bar chart.\n\nNamespace: `options.elements.bar`, global bar options: `Chart.defaults.elements.bar`.\n\n| Name | Type | Default | Description\n| ---- | ---- | ------- | -----------\n| `backgroundColor` | [`Color`](/general/colors.md) | `Chart.defaults.backgroundColor` | Bar fill color.\n| `borderWidth` | `number` | `0` | Bar stroke width.\n| `borderColor` | [`Color`](/general/colors.md) | `Chart.defaults.borderColor` | Bar stroke color.\n| `borderSkipped` | `string` | `'start'` | Skipped (excluded) border: `'start'`, `'end'`, `'middle'`, `'bottom'`, `'left'`, `'top'`, `'right'` or `false`.\n| `borderRadius` | `number`\\|`object` | `0` | The bar border radius (in pixels).\n| `inflateAmount` | `number`\\|`'auto'` | `'auto'` | The amount of pixels to inflate the bar rectangle(s) when drawing.\n| [`pointStyle`](#point-styles) | `string`\\|`Image`\\|`HTMLCanvasElement` | `'circle'` | Style of the point for legend.",
"Arc Configuration": "Arcs are used in the polar area, doughnut and pie charts.\n\nNamespace: `options.elements.arc`, global arc options: `Chart.defaults.elements.arc`.\n\n| Name | Type | Default | Description\n| ---- | ---- | ------- | -----------\n| `angle` - for polar only | `number` | `circumference / (arc count)` | Arc angle to cover.\n| `backgroundColor` | [`Color`](/general/colors.md) | `Chart.defaults.backgroundColor` | Arc fill color.\n| `borderAlign` | `'center'`\\|`'inner'` | `'center'` | Arc stroke alignment.\n| `borderColor` | [`Color`](/general/colors.md) | `'#fff'` | Arc stroke color.\n| `borderDash` | `number[]` | `[]` | Arc line dash. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash).\n| `borderDashOffset` | `number` | `0.0` | Arc line dash offset. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset).\n| `borderJoinStyle` | `'round'`\\|`'bevel'`\\|`'miter'` | `'bevel'`\\|`'round'` | Line join style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). The default is `'round'` when `borderAlign` is `'inner'`\n| `borderWidth`| `number` | `2` | Arc stroke width.\n| `circular` | `boolean` | `true` | By default the Arc is curved. If `circular: false` the Arc will be flat"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 3, \"subpages\", 4]"
},
{
"title": "Configuration",
"description": null,
"content": {
"Configuration object structure": {
"type": "Chart type determines the main type of the chart.\n\n**note** A dataset can override the `type`, this is how mixed charts are constructed.",
"data": "See [Data Structures](../general/data-structures.md) for details.",
"options": "Majority of the documentation talks about these options.",
"plugins": "Inline plugins can be included in this array. It is an alternative way of adding plugins for single chart (vs registering the plugin globally).\nMore about plugins in the [developers section](../developers/plugins.md)."
},
"Global Configuration": "This concept was introduced in Chart.js 1.0 to keep configuration [DRY](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself), and allow for changing options globally across chart types, avoiding the need to specify options for each instance, or the default for a particular chart type.\n\nChart.js merges the `options` object passed to the chart with the global configuration using chart type defaults and scales defaults appropriately. This way you can be as specific as you would like in your individual chart configuration, while still changing the defaults for all chart types where applicable. The global general options are defined in `Chart.defaults`. The defaults for each chart type are discussed in the documentation for that chart type.\n\nThe following example would set the interaction mode to 'nearest' for all charts where this was not overridden by the chart type defaults or the options passed to the constructor on creation.\n\n```\nChart.defaults.interaction.mode = 'nearest';\n\n// Interaction mode is set to nearest because it was not overridden here\nconst chartInteractionModeNearest = new Chart(ctx, {\n type: 'line',\n data: data\n});\n\n// This chart would have the interaction mode that was passed in\nconst chartDifferentInteractionMode = new Chart(ctx, {\n type: 'line',\n data: data,\n options: {\n interaction: {\n // Overrides the global setting\n mode: 'index'\n }\n }\n});\n```",
"Dataset Configuration": "Options may be configured directly on the dataset. The dataset options can be changed at multiple different levels. See [options](../general/options.md#dataset-level-options) for details on how the options are resolved.\n\nThe following example would set the `showLine` option to 'false' for all line datasets except for those overridden by options passed to the dataset on creation.\n\n```\n// Do not show lines for all datasets by default\nChart.defaults.datasets.line.showLine = false;\n\n// This chart would show a line only for the third dataset\nconst chart = new Chart(ctx, {\n type: 'line',\n data: {\n datasets: [{\n data: [0, 0],\n }, {\n data: [0, 1]\n }, {\n data: [1, 0],\n showLine: true // overrides the `line` dataset default\n }, {\n type: 'scatter', // 'line' dataset default does not affect this dataset since it's a 'scatter'\n data: [1, 1]\n }]\n }\n});\n```"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 3, \"subpages\", 5]"
},
{
"title": "Interactions",
"description": null,
"content": {
"Events": {
"Event Option": "For example, to have the chart only respond to click events, you could do:\n\n```\nconst chart = new Chart(ctx, {\n type: 'line',\n data: data,\n options: {\n // This chart will not respond to mousemove, etc\n events: ['click']\n }\n});\n```\n\nEvents for each plugin can be further limited by defining (allowed) events array in plugin options:\n\n```\nconst chart = new Chart(ctx, {\n type: 'line',\n data: data,\n options: {\n // All of these (default) events trigger a hover and are passed to all plugins,\n // unless limited at plugin options\n events: ['mousemove', 'mouseout', 'click', 'touchstart', 'touchmove'],\n plugins: {\n tooltip: {\n // Tooltip will only receive click events\n events: ['click']\n }\n }\n }\n});\n```\n\nEvents that do not fire over chartArea, like `mouseout`, can be captured using a simple plugin:\n\n```\nconst chart = new Chart(ctx, {\n type: 'line',\n data: data,\n options: {\n // these are the default events:\n // events: ['mousemove', 'mouseout', 'click', 'touchstart', 'touchmove'],\n },\n plugins: [{\n id: 'myEventCatcher',\n beforeEvent(chart, args, pluginOptions) {\n const event = args.event;\n if (event.type === 'mouseout') {\n // process the event\n }\n }\n }]\n});\n```\n\nFor more information about plugins, see [Plugins](../developers/plugins.md)",
"Converting Events to Data Values": "A common occurrence is taking an event, such as a click, and finding the data coordinates on the chart where the event occurred. Chart.js provides helpers that make this a straightforward process.\n\n```\nconst chart = new Chart(ctx, {\n type: 'line',\n data: data,\n options: {\n onClick: (e) => {\n const canvasPosition = Chart.helpers.getRelativePosition(e, chart);\n\n // Substitute the appropriate scale IDs\n const dataX = chart.scales.x.getValueForPixel(canvasPosition.x);\n const dataY = chart.scales.y.getValueForPixel(canvasPosition.y);\n }\n }\n});\n```\n\nWhen using a bundler, the helper functions have to be imported separately, for a full explanation of this please head over to the [integration](../getting-started/integration.md#helper-functions) page"
},
"Modes": {
"point": "Finds all of the items that intersect the point.\n\n```\nconst chart = new Chart(ctx, {\n type: 'line',\n data: data,\n options: {\n interaction: {\n mode: 'point'\n }\n }\n});\n```",
"nearest": "Gets the items that are at the nearest distance to the point. The nearest item is determined based on the distance to the center of the chart item (point, bar). You can use the `axis` setting to define which coordinates are considered in distance calculation. If `intersect` is true, this is only triggered when the mouse position intersects an item in the graph. This is very useful for combo charts where points are hidden behind bars.\n\n```\nconst chart = new Chart(ctx, {\n type: 'line',\n data: data,\n options: {\n interaction: {\n mode: 'nearest'\n }\n }\n});\n```",
"index": "Finds item at the same index. If the `intersect` setting is true, the first intersecting item is used to determine the index in the data. If `intersect` false the nearest item, in the x direction, is used to determine the index.\n\n```\nconst chart = new Chart(ctx, {\n type: 'line',\n data: data,\n options: {\n interaction: {\n mode: 'index'\n }\n }\n});\n```\n\nTo use index mode in a chart like the horizontal bar chart, where we search along the y direction, you can use the `axis` setting introduced in v2.7.0. By setting this value to `'y'` on the y direction is used.\n\n```\nconst chart = new Chart(ctx, {\n type: 'bar',\n data: data,\n options: {\n interaction: {\n mode: 'index',\n axis: 'y'\n }\n }\n});\n```",
"dataset": "Finds items in the same dataset. If the `intersect` setting is true, the first intersecting item is used to determine the index in the data. If `intersect` false the nearest item is used to determine the index.\n\n```\nconst chart = new Chart(ctx, {\n type: 'line',\n data: data,\n options: {\n interaction: {\n mode: 'dataset'\n }\n }\n});\n```",
"x": "Returns all items that would intersect based on the `X` coordinate of the position only. Would be useful for a vertical cursor implementation. Note that this only applies to cartesian charts.\n\n```\nconst chart = new Chart(ctx, {\n type: 'line',\n data: data,\n options: {\n interaction: {\n mode: 'x'\n }\n }\n});\n```",
"y": "Returns all items that would intersect based on the `Y` coordinate of the position. This would be useful for a horizontal cursor implementation. Note that this only applies to cartesian charts.\n\n```\nconst chart = new Chart(ctx, {\n type: 'line',\n data: data,\n options: {\n interaction: {\n mode: 'y'\n }\n }\n});\n```"
},
"Custom Interaction Modes": "New modes can be defined by adding functions to the `Chart.Interaction.modes` map. You can use the `Chart.Interaction.evaluateInteractionItems` function to help implement these.\n\nExample:\n\n```\nimport { Interaction } from 'chart.js';\nimport { getRelativePosition } from 'chart.js/helpers';\n\n/**\n * Custom interaction mode\n * @function Interaction.modes.myCustomMode\n * @param {Chart} chart - the chart we are returning items from\n * @param {Event} e - the event we are find things at\n * @param {InteractionOptions} options - options to use\n * @param {boolean} [useFinalPosition] - use final element position (animation target)\n * @return {InteractionItem[]} - items that are found\n */\nInteraction.modes.myCustomMode = function(chart, e, options, useFinalPosition) {\n const position = getRelativePosition(e, chart);\n\n const items = [];\n Interaction.evaluateInteractionItems(chart, 'x', position, (element, datasetIndex, index) => {\n if (element.inXRange(position.x, useFinalPosition) && myCustomLogic(element)) {\n items.push({element, datasetIndex, index});\n }\n });\n return items;\n};\n\n// Then, to use it...\nnew Chart.js(ctx, {\n type: 'line',\n data: data,\n options: {\n interaction: {\n mode: 'myCustomMode'\n }\n }\n})\n```\n\nIf you're using TypeScript, you'll also need to register the new mode:\n\n```\ndeclare module 'chart.js' {\n interface InteractionModeMap {\n myCustomMode: InteractionModeFunction;\n }\n}\n```"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 3, \"subpages\", 6]"
},
{
"title": "Layout",
"description": null,
"content": {
"Layout": "Namespace: `options.layout`, the global options for the chart layout is defined in `Chart.defaults.layout`.\n\n| Name | Type | Default | [Scriptable](../general/options.md#scriptable-options) | Description\n| ---- | ---- | ------- | :----: | -----------\n| `autoPadding` | `boolean` | `true` | No | Apply automatic padding so visible elements are completely drawn.\n| `padding` | [`Padding`](../general/padding.md) | `0` | Yes | The padding to add inside the chart."
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 3, \"subpages\", 7]"
},
{
"title": "Legend",
"description": null,
"content": {
"Configuration options": "Namespace: `options.plugins.legend`, the global options for the chart legend is defined in `Chart.defaults.plugins.legend`.\n\n:::warning\nThe doughnut, pie, and polar area charts override the legend defaults. To change the overrides for those chart types, the options are defined in `Chart.overrides[type].plugins.legend`.\n:::\n\n| Name | Type | Default | Description\n| ---- | ---- | ------- | -----------\n| `display` | `boolean` | `true` | Is the legend shown?\n| `position` | `string` | `'top'` | Position of the legend. [more...](#position)\n| `align` | `string` | `'center'` | Alignment of the legend. [more...](#align)\n| `maxHeight` | `number` | | Maximum height of the legend, in pixels\n| `maxWidth` | `number` | | Maximum width of the legend, in pixels\n| `fullSize` | `boolean` | `true` | Marks that this box should take the full width/height of the canvas (moving other boxes). This is unlikely to need to be changed in day-to-day use.\n| `onClick` | `function` | | A callback that is called when a click event is registered on a label item. Arguments: `[event, legendItem, legend]`.\n| `onHover` | `function` | | A callback that is called when a 'mousemove' event is registered on top of a label item. Arguments: `[event, legendItem, legend]`.\n| `onLeave` | `function` | | A callback that is called when a 'mousemove' event is registered outside of a previously hovered label item. Arguments: `[event, legendItem, legend]`.\n| `reverse` | `boolean` | `false` | Legend will show datasets in reverse order.\n| `labels` | `object` | | See the [Legend Label Configuration](#legend-label-configuration) section below.\n| `rtl` | `boolean` | | `true` for rendering the legends from right to left.\n| `textDirection` | `string` | canvas' default | This will force the text direction `'rtl'` or `'ltr'` on the canvas for rendering the legend, regardless of the css specified on the canvas\n| `title` | `object` | | See the [Legend Title Configuration](#legend-title-configuration) section below.\n\n:::tip Note\nIf you need more visual customizations, please use an [HTML legend](../samples/legend/html.md).\n:::",
"Position": "Position of the legend. Options are:\n\n[\"`'top'`\", \"`'left'`\", \"`'bottom'`\", \"`'right'`\", \"`'chartArea'`\"]\n\nWhen using the `'chartArea'` option the legend position is at the moment not configurable, it will always be on the left side of the chart in the middle.",
"Align": "Alignment of the legend. Options are:\n\n[\"`'start'`\", \"`'center'`\", \"`'end'`\"]\n\nDefaults to `'center'` for unrecognized values.",
"Legend Label Configuration": "Namespace: `options.plugins.legend.labels`\n\n| Name | Type | Default | Description\n| ---- | ---- | ------- | -----------\n| `boxWidth` | `number` | `40` | Width of coloured box.\n| `boxHeight` | `number` | `font.size` | Height of the coloured box.\n| `color` | [`Color`](../general/colors.md) | `Chart.defaults.color` | Color of label and the strikethrough.\n| `font` | `Font` | `Chart.defaults.font` | See [Fonts](../general/fonts.md)\n| `padding` | `number` | `10` | Padding between rows of colored boxes.\n| `generateLabels` | `function` | | Generates legend items for each thing in the legend. Default implementation returns the text + styling for the color box. See [Legend Item](#legend-item-interface) for details.\n| `filter` | `function` | `null` | Filters legend items out of the legend. Receives 2 parameters, a [Legend Item](#legend-item-interface) and the chart data.\n| `sort` | `function` | `null` | Sorts legend items. Type is : `sort(a: LegendItem, b: LegendItem, data: ChartData): number;`. Receives 3 parameters, two [Legend Items](#legend-item-interface) and the chart data. The return value of the function is a number that indicates the order of the two legend item parameters. The ordering matches the [return value](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#description) of `Array.prototype.sort()`\n| [`pointStyle`](elements.md#point-styles) | [`pointStyle`](elements.md#types) | `'circle'` | If specified, this style of point is used for the legend. Only used if `usePointStyle` is true.\n| `textAlign` | `string` | `'center'` | Horizontal alignment of the label text. Options are: `'left'`, `'right'` or `'center'`.\n| `usePointStyle` | `boolean` | `false` | Label style will match corresponding point style (size is based on pointStyleWidth or the minimum value between boxWidth and font.size).\n| `pointStyleWidth` | `number` | `null` | If `usePointStyle` is true, the width of the point style used for the legend.\n| `useBorderRadius` | `boolean` | `false` | Label borderRadius will match corresponding borderRadius.\n| `borderRadius` | `number` | `undefined` | Override the borderRadius to use.",
"Legend Title Configuration": "Namespace: `options.plugins.legend.title`\n\n| Name | Type | Default | Description\n| ---- | ---- | ------- | -----------\n| `color` | [`Color`](../general/colors.md) | `Chart.defaults.color` | Color of text.\n| `display` | `boolean` | `false` | Is the legend title displayed.\n| `font` | `Font` | `Chart.defaults.font` | See [Fonts](../general/fonts.md)\n| `padding` | [`Padding`](../general/padding.md) | `0` | Padding around the title.\n| `text` | `string` | | The string title.",
"Legend Item Interface": "Items passed to the legend `onClick` function are the ones returned from `labels.generateLabels`. These items must implement the following interface.\n\n```\n{\n // Label that will be displayed\n text: string,\n\n // Border radius of the legend item.\n // Introduced in 3.1.0\n borderRadius?: number | BorderRadius,\n\n // Index of the associated dataset\n datasetIndex: number,\n\n // Fill style of the legend box\n fillStyle: Color,\n\n // Text color\n fontColor: Color,\n\n // If true, this item represents a hidden dataset. Label will be rendered with a strike-through effect\n hidden: boolean,\n\n // For box border. See https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineCap\n lineCap: string,\n\n // For box border. See https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash\n lineDash: number[],\n\n // For box border. See https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset\n lineDashOffset: number,\n\n // For box border. See https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin\n lineJoin: string,\n\n // Width of box border\n lineWidth: number,\n\n // Stroke style of the legend box\n strokeStyle: Color,\n\n // Point style of the legend box (only used if usePointStyle is true)\n pointStyle: string | Image | HTMLCanvasElement,\n\n // Rotation of the point in degrees (only used if usePointStyle is true)\n rotation: number\n}\n```",
"Example": "The following example will create a chart with the legend enabled and turn all the text red in color.\n\n```\nconst chart = new Chart(ctx, {\n type: 'bar',\n data: data,\n options: {\n plugins: {\n legend: {\n display: true,\n labels: {\n color: 'rgb(255, 99, 132)'\n }\n }\n }\n }\n});\n```",
"Custom On Click Actions": "It can be common to want to trigger different behaviour when clicking an item in the legend. This can be easily achieved using a callback in the config object.\n\nThe default legend click handler is:\n\n```\nfunction(e, legendItem, legend) {\n const index = legendItem.datasetIndex;\n const ci = legend.chart;\n if (ci.isDatasetVisible(index)) {\n ci.hide(index);\n legendItem.hidden = true;\n } else {\n ci.show(index);\n legendItem.hidden = false;\n }\n}\n```\n\nLet's say we wanted instead to link the display of the first two datasets. We could change the click handler accordingly.\n\n```\nconst defaultLegendClickHandler = Chart.defaults.plugins.legend.onClick;\nconst pieDoughnutLegendClickHandler = Chart.controllers.doughnut.overrides.plugins.legend.onClick;\nconst newLegendClickHandler = function (e, legendItem, legend) {\n const index = legendItem.datasetIndex;\n const type = legend.chart.config.type;\n\n if (index > 1) {\n // Do the original logic\n if (type === 'pie' || type === 'doughnut') {\n pieDoughnutLegendClickHandler(e, legendItem, legend)\n } else {\n defaultLegendClickHandler(e, legendItem, legend);\n }\n\n } else {\n let ci = legend.chart;\n [\n ci.getDatasetMeta(0),\n ci.getDatasetMeta(1)\n ].forEach(function(meta) {\n meta.hidden = meta.hidden === null ? !ci.data.datasets[index].hidden : null;\n });\n ci.update();\n }\n};\n\nconst chart = new Chart(ctx, {\n type: 'line',\n data: data,\n options: {\n plugins: {\n legend: {\n onClick: newLegendClickHandler\n }\n }\n }\n});\n```\n\nNow when you click the legend in this chart, the visibility of the first two datasets will be linked together."
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 3, \"subpages\", 8]"
},
{
"title": "Locale",
"description": null,
"content": {
"Configuration Options": "Namespace: `options`\n\n| Name | Type | Default | Description\n| ---- | ---- | ------- | -----------\n| `locale` | `string` | `undefined` | a string with a BCP 47 language tag, leveraging on [INTL NumberFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat)."
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 3, \"subpages\", 9]"
},
{
"title": "Responsive Charts",
"description": null,
"content": {
"Configuration Options": "Namespace: `options`\n\n| Name | Type | Default | Description\n| ---- | ---- | ------- | -----------\n| `responsive` | `boolean` | `true` | Resizes the chart canvas when its container does ([important note...](#important-note)).\n| `maintainAspectRatio` | `boolean` | `true` | Maintain the original canvas aspect ratio `(width / height)` when resizing.\n| `aspectRatio` | `number` | `1`\\|`2` | Canvas aspect ratio (i.e. `width / height`, a value of 1 representing a square canvas). Note that this option is ignored if the height is explicitly defined either as attribute or via the style. The default value varies by chart type; Radial charts (doughnut, pie, polarArea, radar) default to `1` and others default to `2`.\n| `onResize` | `function` | `null` | Called when a resize occurs. Gets passed two arguments: the chart instance and the new size.\n| `resizeDelay` | `number` | `0` | Delay the resize update by the given amount of milliseconds. This can ease the resize process by debouncing the update of the elements.",
"Important Note": "Detecting when the canvas size changes can not be done directly from the `canvas` element. Chart.js uses its parent container to update the canvas *render* and *display* sizes. However, this method requires the container to be **relatively positioned** and **dedicated to the chart canvas only**. Responsiveness can then be achieved by setting relative values for the container size ([example](https://codepen.io/chartjs/pen/YVWZbz)):\n\n```\n<div class=\"chart-container\" style=\"position: relative; height:40vh; width:80vw\">\n <canvas id=\"chart\"></canvas>\n</div>\n```\n\nThe chart can also be programmatically resized by modifying the container size:\n\n```\nchart.canvas.parentNode.style.height = '128px';\nchart.canvas.parentNode.style.width = '128px';\n```\n\nNote that in order for the above code to correctly resize the chart height, the [`maintainAspectRatio`](#configuration-options) option must also be set to `false`.",
"Printing Resizable Charts": "CSS media queries allow changing styles when printing a page. The CSS applied from these media queries may cause charts to need to resize. However, the resize won't happen automatically. To support resizing charts when printing, you need to hook the [onbeforeprint](https://developer.mozilla.org/en-US/docs/Web/API/WindowEventHandlers/onbeforeprint) event and manually trigger resizing of each chart.\n\n```\nfunction beforePrintHandler () {\n for (let id in Chart.instances) {\n Chart.instances[id].resize();\n }\n}\n```\n\nYou may also find that, due to complexities in when the browser lays out the document for printing and when resize events are fired, Chart.js is unable to properly resize for the print layout. To work around this, you can pass an explicit size to `.resize()` then use an [onafterprint](https://developer.mozilla.org/en-US/docs/Web/API/WindowEventHandlers/onafterprint) event to restore the automatic size when done.\n\n```\nwindow.addEventListener('beforeprint', () => {\n myChart.resize(600, 600);\n});\nwindow.addEventListener('afterprint', () => {\n myChart.resize();\n});\n```"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 3, \"subpages\", 10]"
},
{
"title": "Subtitle",
"description": null,
"content": {
"Subtitle Configuration": "Namespace: `options.plugins.subtitle`. The global defaults for subtitle are configured in `Chart.defaults.plugins.subtitle`.\n\nExactly the same configuration options with [title](./title.md) are available for subtitle, the namespaces only differ.",
"Example Usage": "The example below would enable a title of 'Custom Chart Subtitle' on the chart that is created.\n\n```\nconst chart = new Chart(ctx, {\n type: 'line',\n data: data,\n options: {\n plugins: {\n subtitle: {\n display: true,\n text: 'Custom Chart Subtitle'\n }\n }\n }\n});\n```"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 3, \"subpages\", 11]"
},
{
"title": "Title",
"description": null,
"content": {
"Title Configuration": {
"Position": "Possible title position values are:\n\n[\"`'top'`\", \"`'left'`\", \"`'bottom'`\", \"`'right'`\"]"
},
"Align": "Alignment of the title. Options are:\n\n[\"`'start'`\", \"`'center'`\", \"`'end'`\"]",
"Example Usage": "The example below would enable a title of 'Custom Chart Title' on the chart that is created.\n\n```\nconst chart = new Chart(ctx, {\n type: 'line',\n data: data,\n options: {\n plugins: {\n title: {\n display: true,\n text: 'Custom Chart Title'\n }\n }\n }\n});\n```\n\nThis example shows how to specify separate top and bottom title text padding:\n\n```\nconst chart = new Chart(ctx, {\n type: 'line',\n data: data,\n options: {\n plugins: {\n title: {\n display: true,\n text: 'Custom Chart Title',\n padding: {\n top: 10,\n bottom: 30\n }\n }\n }\n }\n});\n```"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 3, \"subpages\", 12]"
},
{
"title": "Tooltip",
"description": null,
"content": {
"Tooltip Configuration": {
"Position Modes": "Possible modes are:\n\n[\"`'average'`\", \"`'nearest'`\"]\n\n`'average'` mode will place the tooltip at the average position of the items displayed in the tooltip. `'nearest'` will place the tooltip at the position of the element closest to the event position.\n\nYou can also define [custom position modes](#custom-position-modes).",
"Tooltip Alignment": "The `xAlign` and `yAlign` options define the position of the tooltip caret. If these parameters are unset, the optimal caret position is determined.\n\nThe following values for the `xAlign` setting are supported.\n\n[\"`'left'`\", \"`'center'`\", \"`'right'`\"]\n\nThe following values for the `yAlign` setting are supported.\n\n[\"`'top'`\", \"`'center'`\", \"`'bottom'`\"]",
"Text Alignment": "The `titleAlign`, `bodyAlign` and `footerAlign` options define the horizontal position of the text lines with respect to the tooltip box. The following values are supported.\n\n[\"`'left'` (default)\", \"`'right'`\", \"`'center'`\"]\n\nThese options are only applied to text lines. Color boxes are always aligned to the left edge.",
"Sort Callback": "Allows sorting of [tooltip items](#tooltip-item-context). Must implement at minimum a function that can be passed to [Array.prototype.sort](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort). This function can also accept a third parameter that is the data object passed to the chart.",
"Filter Callback": "Allows filtering of [tooltip items](#tooltip-item-context). Must implement at minimum a function that can be passed to [Array.prototype.filter](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/filter). This function can also accept a fourth parameter that is the data object passed to the chart."
},
"Tooltip Callbacks": {
"Label Callback": "The `label` callback can change the text that displays for a given data point. A common example to show a unit. The example below puts a `'$'` before every row.\n\n```\nconst chart = new Chart(ctx, {\n type: 'line',\n data: data,\n options: {\n plugins: {\n tooltip: {\n callbacks: {\n label: function(context) {\n let label = context.dataset.label || '';\n\n if (label) {\n label += ': ';\n }\n if (context.parsed.y !== null) {\n label += new Intl.NumberFormat('en-US', { style: 'currency', currency: 'USD' }).format(context.parsed.y);\n }\n return label;\n }\n }\n }\n }\n }\n});\n```",
"Label Color Callback": "For example, to return a red box with a blue dashed border that has a border radius for each item in the tooltip you could do:\n\n```\nconst chart = new Chart(ctx, {\n type: 'line',\n data: data,\n options: {\n plugins: {\n tooltip: {\n callbacks: {\n labelColor: function(context) {\n return {\n borderColor: 'rgb(0, 0, 255)',\n backgroundColor: 'rgb(255, 0, 0)',\n borderWidth: 2,\n borderDash: [2, 2],\n borderRadius: 2,\n };\n },\n labelTextColor: function(context) {\n return '#543453';\n }\n }\n }\n }\n }\n});\n```",
"Label Point Style Callback": "For example, to draw triangles instead of the regular color box for each item in the tooltip, you could do:\n\n```\nconst chart = new Chart(ctx, {\n type: 'line',\n data: data,\n options: {\n plugins: {\n tooltip: {\n usePointStyle: true,\n callbacks: {\n labelPointStyle: function(context) {\n return {\n pointStyle: 'triangle',\n rotation: 0\n };\n }\n }\n }\n }\n }\n});\n```",
"Tooltip Item Context": "The tooltip items passed to the tooltip callbacks implement the following interface.\n\n```\n{\n // The chart the tooltip is being shown on\n chart: Chart\n\n // Label for the tooltip\n label: string,\n\n // Parsed data values for the given `dataIndex` and `datasetIndex`\n parsed: object,\n\n // Raw data values for the given `dataIndex` and `datasetIndex`\n raw: object,\n\n // Formatted value for the tooltip\n formattedValue: string,\n\n // The dataset the item comes from\n dataset: object\n\n // Index of the dataset the item comes from\n datasetIndex: number,\n\n // Index of this data item in the dataset\n dataIndex: number,\n\n // The chart element (point, arc, bar, etc.) for this tooltip item\n element: Element,\n}\n```"
},
"External (Custom) Tooltips": "External tooltips allow you to hook into the tooltip rendering process so that you can render the tooltip in your own custom way. Generally this is used to create an HTML tooltip instead of an on-canvas tooltip. The `external` option takes a function which is passed a context parameter containing the `chart` and `tooltip`. You can enable external tooltips in the global or chart configuration like so:\n\n```\nconst myPieChart = new Chart(ctx, {\n type: 'pie',\n data: data,\n options: {\n plugins: {\n tooltip: {\n // Disable the on-canvas tooltip\n enabled: false,\n\n external: function(context) {\n // Tooltip Element\n let tooltipEl = document.getElementById('chartjs-tooltip');\n\n // Create element on first render\n if (!tooltipEl) {\n tooltipEl = document.createElement('div');\n tooltipEl.id = 'chartjs-tooltip';\n tooltipEl.innerHTML = '<table></table>';\n document.body.appendChild(tooltipEl);\n }\n\n // Hide if no tooltip\n const tooltipModel = context.tooltip;\n if (tooltipModel.opacity === 0) {\n tooltipEl.style.opacity = 0;\n return;\n }\n\n // Set caret Position\n tooltipEl.classList.remove('above', 'below', 'no-transform');\n if (tooltipModel.yAlign) {\n tooltipEl.classList.add(tooltipModel.yAlign);\n } else {\n tooltipEl.classList.add('no-transform');\n }\n\n function getBody(bodyItem) {\n return bodyItem.lines;\n }\n\n // Set Text\n if (tooltipModel.body) {\n const titleLines = tooltipModel.title || [];\n const bodyLines = tooltipModel.body.map(getBody);\n\n let innerHtml = '<thead>';\n\n titleLines.forEach(function(title) {\n innerHtml += '<tr><th>' + title + '</th></tr>';\n });\n innerHtml += '</thead><tbody>';\n\n bodyLines.forEach(function(body, i) {\n const colors = tooltipModel.labelColors[i];\n let style = 'background:' + colors.backgroundColor;\n style += '; border-color:' + colors.borderColor;\n style += '; border-width: 2px';\n const span = '<span style=\"' + style + '\">' + body + '</span>';\n innerHtml += '<tr><td>' + span + '</td></tr>';\n });\n innerHtml += '</tbody>';\n\n let tableRoot = tooltipEl.querySelector('table');\n tableRoot.innerHTML = innerHtml;\n }\n\n const position = context.chart.canvas.getBoundingClientRect();\n const bodyFont = Chart.helpers.toFont(tooltipModel.options.bodyFont);\n\n // Display, position, and set styles for font\n tooltipEl.style.opacity = 1;\n tooltipEl.style.position = 'absolute';\n tooltipEl.style.left = position.left + window.pageXOffset + tooltipModel.caretX + 'px';\n tooltipEl.style.top = position.top + window.pageYOffset + tooltipModel.caretY + 'px';\n tooltipEl.style.font = bodyFont.string;\n tooltipEl.style.padding = tooltipModel.padding + 'px ' + tooltipModel.padding + 'px';\n tooltipEl.style.pointerEvents = 'none';\n }\n }\n }\n }\n});\n```\n\nSee [samples](/samples/tooltip/html.md) for examples on how to get started with external tooltips.",
"Tooltip Model": "The tooltip model contains parameters that can be used to render the tooltip.\n\n```\n{\n chart: Chart,\n\n // The items that we are rendering in the tooltip. See Tooltip Item Interface section\n dataPoints: TooltipItem[],\n\n // Positioning\n xAlign: string,\n yAlign: string,\n\n // X and Y properties are the top left of the tooltip\n x: number,\n y: number,\n width: number,\n height: number,\n // Where the tooltip points to\n caretX: number,\n caretY: number,\n\n // Body\n // The body lines that need to be rendered\n // Each object contains 3 parameters\n // before: string[] // lines of text before the line with the color square\n // lines: string[], // lines of text to render as the main item with color square\n // after: string[], // lines of text to render after the main lines\n body: object[],\n // lines of text that appear after the title but before the body\n beforeBody: string[],\n // line of text that appear after the body and before the footer\n afterBody: string[],\n\n // Title\n // lines of text that form the title\n title: string[],\n\n // Footer\n // lines of text that form the footer\n footer: string[],\n\n // style to render for each item in body[]. This is the style of the squares in the tooltip\n labelColors: TooltipLabelStyle[],\n labelTextColors: Color[],\n labelPointStyles: { pointStyle: PointStyle; rotation: number }[],\n\n // 0 opacity is a hidden tooltip\n opacity: number,\n\n // tooltip options\n options: Object\n}\n```",
"Custom Position Modes": "New modes can be defined by adding functions to the `Chart.Tooltip.positioners` map.\n\nExample:\n\n```\nimport { Tooltip } from 'chart.js';\n\n/**\n * Custom positioner\n * @function Tooltip.positioners.myCustomPositioner\n * @param elements {Chart.Element[]} the tooltip elements\n * @param eventPosition {Point} the position of the event in canvas coordinates\n * @returns {TooltipPosition} the tooltip position\n */\nTooltip.positioners.myCustomPositioner = function(elements, eventPosition) {\n // A reference to the tooltip model\n const tooltip = this;\n\n /* ... */\n\n return {\n x: 0,\n y: 0\n // You may also include xAlign and yAlign to override those tooltip options.\n };\n};\n\n// Then, to use it...\nnew Chart(ctx, {\n data,\n options: {\n plugins: {\n tooltip: {\n position: 'myCustomPositioner'\n }\n }\n }\n})\n```\n\nSee [samples](/samples/tooltip/position.md) for a more detailed example.\n\nIf you're using TypeScript, you'll also need to register the new mode:\n\n```\ndeclare module 'chart.js' {\n interface TooltipPositionerMap {\n myCustomPositioner: TooltipPositionerFunction<ChartType>;\n }\n}\n```",
"Default font overrides": "By default, the `titleFont`, `bodyFont` and `footerFont` listen to the `Chart.defaults.font` options for setting its values.\nOverriding these normally by accessing the object won't work because it is backed by a get function that looks to the default `font` namespace.\nSo you will need to override this get function with your own function that returns the desired config.\n\nExample:\n\n```\nChart.defaults.plugins.tooltip.titleFont = () => ({ size: 20, lineHeight: 1.2, weight: 800 });\n```"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 3, \"subpages\", 13]"
}
],
"path": "[\"subpages\", 3]"
},
{
"title": "Developers",
"description": "Documentation section: developers",
"content": {},
"metadata": {
"type": "directory",
"path": "/home/anhnh/CodeWikiBench/data/Chart.js/original/docs/developers"
},
"subpages": [
{
"title": "API",
"description": null,
"content": {
".destroy()": "Use this to destroy any chart instances that are created. This will clean up any references stored to the chart object within Chart.js, along with any associated event listeners attached by Chart.js.\nThis must be called before the canvas is reused for a new chart.\n\n```\n// Destroys a specific chart instance\nmyLineChart.destroy();\n```",
".update(mode?)": "Triggers an update of the chart. This can be safely called after updating the data object. This will update all scales, legends, and then re-render the chart.\n\n```\nmyLineChart.data.datasets[0].data[2] = 50; // Would update the first dataset's value of 'March' to be 50\nmyLineChart.update(); // Calling update now animates the position of March from 90 to 50.\n```\n\nA `mode` can be provided to indicate transition configuration should be used. This can be either:\n\n[\"**string value**: Core calls this method using any of `'active'`, `'hide'`, `'reset'`, `'resize'`, `'show'` or `undefined`. `'none'` is also supported for skipping animations for single update. Please see [animations](../configuration/animations.md) docs for more details.\", '**function**: that receives a context object `{ datasetIndex: number }` and returns a mode string, allowing different modes per dataset.']\n\nExamples:\n\n```\n// Using string mode\nmyChart.update('active');\n\n// Using function mode for dataset-specific animations\nmyChart.update(ctx => ctx.datasetIndex === 0 ? 'active' : 'none');\n```\n\nSee [Updating Charts](updates.md) for more details.",
".reset()": "Reset the chart to its state before the initial animation. A new animation can then be triggered using `update`.\n\n```\nmyLineChart.reset();\n```",
".render()": "Triggers a redraw of all chart elements. Note, this does not update elements for new data. Use `.update()` in that case.",
".stop()": "Use this to stop any current animation. This will pause the chart during any current animation frame. Call `.render()` to re-animate.\n\n```\n// Stops the charts animation loop at its current frame\nmyLineChart.stop();\n// => returns 'this' for chainability\n```",
".resize(width?, height?)": "Use this to manually resize the canvas element. This is run each time the canvas container is resized, but you can call this method manually if you change the size of the canvas nodes container element.\n\nYou can call `.resize()` with no parameters to have the chart take the size of its container element, or you can pass explicit dimensions (e.g., for [printing](../configuration/responsive.md#printing-resizable-charts)).\n\n```\n// Resizes & redraws to fill its container element\nmyLineChart.resize();\n// => returns 'this' for chainability\n\n// With an explicit size:\nmyLineChart.resize(width, height);\n```",
".clear()": "Will clear the chart canvas. Used extensively internally between animation frames, but you might find it useful.\n\n```\n// Will clear the canvas that myLineChart is drawn on\nmyLineChart.clear();\n// => returns 'this' for chainability\n```",
".toBase64Image(type?, quality?)": "This returns a base 64 encoded string of the chart in its current state.\n\n```\nmyLineChart.toBase64Image();\n// => returns png data url of the image on the canvas\n\nmyLineChart.toBase64Image('image/jpeg', 1)\n// => returns a jpeg data url in the highest quality of the canvas\n```",
".getElementsAtEventForMode(e, mode, options, useFinalPosition)": "Calling `getElementsAtEventForMode(e, mode, options, useFinalPosition)` on your Chart instance passing an event and a mode will return the elements that are found. The `options` and `useFinalPosition` arguments are passed through to the handlers.\n\nTo get an item that was clicked on, `getElementsAtEventForMode` can be used.\n\n```\nfunction clickHandler(evt) {\n const points = myChart.getElementsAtEventForMode(evt, 'nearest', { intersect: true }, true);\n\n if (points.length) {\n const firstPoint = points[0];\n const label = myChart.data.labels[firstPoint.index];\n const value = myChart.data.datasets[firstPoint.datasetIndex].data[firstPoint.index];\n }\n}\n```",
".getSortedVisibleDatasetMetas()": "Returns an array of all the dataset meta's in the order that they are drawn on the canvas that are not hidden.\n\n```\nconst visibleMetas = chart.getSortedVisibleDatasetMetas();\n```",
".getDatasetMeta(index)": "Looks for the dataset that matches the current index and returns that metadata. This returned data has all of the metadata that is used to construct the chart.\n\nThe `data` property of the metadata will contain information about each point, bar, etc. depending on the chart type.\n\nExtensive examples of usage are available in the [Chart.js tests](https://github.com/chartjs/Chart.js/tree/master/test).\n\n```\nconst meta = myChart.getDatasetMeta(0);\nconst x = meta.data[0].x;\n```",
"getVisibleDatasetCount": "Returns the number of datasets that are currently not hidden.\n\n```\nconst numberOfVisibleDatasets = chart.getVisibleDatasetCount();\n```",
"isDatasetVisible(datasetIndex)": "Returns a boolean if a dataset at the given index is currently visible.\n\nThe visibility is determined by first checking the hidden property in the dataset metadata (set via [`setDatasetVisibility()`](#setdatasetvisibility-datasetindex-visibility) and accessible through [`getDatasetMeta()`](#getdatasetmeta-index)). If this is not set, the hidden property of the dataset object itself (`chart.data.datasets[n].hidden`) is returned.\n\n```\nchart.isDatasetVisible(1);\n```",
"setDatasetVisibility(datasetIndex, visibility)": "Sets the visibility for a given dataset. This can be used to build a chart legend in HTML. During click on one of the HTML items, you can call `setDatasetVisibility` to change the appropriate dataset.\n\n```\nchart.setDatasetVisibility(1, false); // hides dataset at index 1\nchart.update(); // chart now renders with dataset hidden\n```",
"toggleDataVisibility(index)": "Toggles the visibility of an item in all datasets. A dataset needs to explicitly support this feature for it to have an effect. From internal chart types, doughnut / pie, polar area, and bar use this.\n\n```\nchart.toggleDataVisibility(2); // toggles the item in all datasets, at index 2\nchart.update(); // chart now renders with item hidden\n```",
"getDataVisibility(index)": "Returns the stored visibility state of a data index for all datasets. Set by [toggleDataVisibility](#toggledatavisibility-index). A dataset controller should use this method to determine if an item should not be visible.\n\n```\nconst visible = chart.getDataVisibility(2);\n```",
"hide(datasetIndex, dataIndex?)": "If dataIndex is not specified, sets the visibility for the given dataset to false. Updates the chart and animates the dataset with `'hide'` mode. This animation can be configured under the `hide` key in animation options. Please see [animations](../configuration/animations.md) docs for more details.\n\nIf dataIndex is specified, sets the hidden flag of that element to true and updates the chart.\n\n```\nchart.hide(1); // hides dataset at index 1 and does 'hide' animation.\nchart.hide(0, 2); // hides the data element at index 2 of the first dataset.\n```",
"show(datasetIndex, dataIndex?)": "If dataIndex is not specified, sets the visibility for the given dataset to true. Updates the chart and animates the dataset with `'show'` mode. This animation can be configured under the `show` key in animation options. Please see [animations](../configuration/animations.md) docs for more details.\n\nIf dataIndex is specified, sets the hidden flag of that element to false and updates the chart.\n\n```\nchart.show(1); // shows dataset at index 1 and does 'show' animation.\nchart.show(0, 2); // shows the data element at index 2 of the first dataset.\n```",
"setActiveElements(activeElements)": "Sets the active (hovered) elements for the chart. See the \"Programmatic Events\" sample file to see this in action.\n\n```\nchart.setActiveElements([\n {datasetIndex: 0, index: 1},\n]);\n```",
"isPluginEnabled(pluginId)": "Returns a boolean if a plugin with the given ID has been registered to the chart instance.\n\n```\nchart.isPluginEnabled('filler');\n```",
"Static: getChart(key)": "Finds the chart instance from the given key. If the key is a `string`, it is interpreted as the ID of the Canvas node for the Chart. The key can also be a `CanvasRenderingContext2D` or an `HTMLDOMElement`. This will return `undefined` if no Chart is found. To be found, the chart must have previously been created.\n\n```\nconst chart = Chart.getChart(\"canvas-id\");\n```",
"Static: register(chartComponentLike)": "Used to register plugins, axis types or chart types globally to all your charts.\n\n```\nimport { Chart, Tooltip, LinearScale, PointElement, BubbleController } from 'chart.js';\n\nChart.register(Tooltip, LinearScale, PointElement, BubbleController);\n```",
"Static: unregister(chartComponentLike)": "Used to unregister plugins, axis types or chart types globally from all your charts.\n\n```\nimport { Chart, Tooltip, LinearScale, PointElement, BubbleController } from 'chart.js';\n\nChart.unregister(Tooltip, LinearScale, PointElement, BubbleController);\n```"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 4, \"subpages\", 0]"
},
{
"title": "New Axes",
"description": null,
"content": {
"Scale Properties": "Scale instances are given the following properties during the fitting process.\n\n```\n{\n left: number, // left edge of the scale bounding box\n right: number, // right edge of the bounding box\n top: number,\n bottom: number,\n width: number, // the same as right - left\n height: number, // the same as bottom - top\n\n // Margin on each side. Like css, this is outside the bounding box.\n margins: {\n left: number,\n right: number,\n top: number,\n bottom: number\n },\n\n // Amount of padding on the inside of the bounding box (like CSS)\n paddingLeft: number,\n paddingRight: number,\n paddingTop: number,\n paddingBottom: number\n}\n```",
"Scale Interface": "To work with Chart.js, custom scale types must implement the following interface.\n\n```\n{\n // Determines the data limits. Should set this.min and this.max to be the data max/min\n determineDataLimits: function() {},\n\n // Generate tick marks. this.chart is the chart instance. The data object can be accessed as this.chart.data\n // buildTicks() should create a ticks array on the axis instance, if you intend to use any of the implementations from the base class\n buildTicks: function() {},\n\n // Get the label to show for the given value\n getLabelForValue: function(value) {},\n\n // Get the pixel (x coordinate for horizontal axis, y coordinate for vertical axis) for a given value\n // @param index: index into the ticks array\n getPixelForTick: function(index) {},\n\n // Get the pixel (x coordinate for horizontal axis, y coordinate for vertical axis) for a given value\n // @param value : the value to get the pixel for\n // @param [index] : index into the data array of the value\n getPixelForValue: function(value, index) {},\n\n // Get the value for a given pixel (x coordinate for horizontal axis, y coordinate for vertical axis)\n // @param pixel : pixel value\n getValueForPixel: function(pixel) {}\n}\n```\n\nOptionally, the following methods may also be overwritten, but an implementation is already provided by the `Chart.Scale` base class.\n\n```\n{\n // Adds labels to objects in the ticks array. The default implementation simply calls this.options.ticks.callback(numericalTick, index, ticks);\n generateTickLabels: function() {},\n\n // Determine how much the labels will rotate by. The default implementation will only rotate labels if the scale is horizontal.\n calculateLabelRotation: function() {},\n\n // Fits the scale into the canvas.\n // this.maxWidth and this.maxHeight will tell you the maximum dimensions the scale instance can be. Scales should endeavour to be as efficient as possible with canvas space.\n // this.margins is the amount of space you have on either side of your scale that you may expand in to. This is used already for calculating the best label rotation\n // You must set this.minSize to be the size of your scale. It must be an object containing 2 properties: width and height.\n // You must set this.width to be the width and this.height to be the height of the scale\n fit: function() {},\n\n // Draws the scale onto the canvas. this.(left|right|top|bottom) will have been populated to tell you the area on the canvas to draw in\n // @param chartArea : an object containing four properties: left, right, top, bottom. This is the rectangle that lines, bars, etc will be drawn in. It may be used, for example, to draw grid lines.\n draw: function(chartArea) {}\n}\n```\n\nThe Core.Scale base class also has some utility functions that you may find useful.\n\n```\n{\n // Returns true if the scale instance is horizontal\n isHorizontal: function() {},\n\n // Returns the scale tick objects ({label, major})\n getTicks: function() {}\n}\n```"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 4, \"subpages\", 1]"
},
{
"title": "New Charts",
"description": null,
"content": {
"Dataset Controller Interface": "Dataset controllers must implement the following interface.\n\n```\n{\n // Defaults for charts of this type\n defaults: {\n // If set to `false` or `null`, no dataset level element is created.\n // If set to a string, this is the type of element to create for the dataset.\n // For example, a line create needs to create a line element so this is the string 'line'\n datasetElementType: string | null | false,\n\n // If set to `false` or `null`, no elements are created for each data value.\n // If set to a string, this is the type of element to create for each data value.\n // For example, a line create needs to create a point element so this is the string 'point'\n dataElementType: string | null | false,\n }\n\n // ID of the controller\n id: string;\n\n // Update the elements in response to new data\n // @param mode : update mode, core calls this method using any of `'active'`, `'hide'`, `'reset'`, `'resize'`, `'show'` or `undefined`\n update: function(mode) {}\n}\n```\n\nThe following methods may optionally be overridden by derived dataset controllers.\n\n```\n{\n // Draw the representation of the dataset. The base implementation works in most cases, and an example of a derived version\n // can be found in the line controller\n draw: function() {},\n\n // Initializes the controller\n initialize: function() {},\n\n // Ensures that the dataset represented by this controller is linked to a scale. Overridden to helpers.noop in the polar area and doughnut controllers as these\n // chart types using a single scale\n linkScales: function() {},\n\n // Parse the data into the controller meta data. The default implementation will work for cartesian parsing, but an example of an overridden\n // version can be found in the doughnut controller\n parse: function(start, count) {},\n}\n```",
"Extending Existing Chart Types": "Extending or replacing an existing controller type is easy. Simply replace the constructor for one of the built-in types with your own.\n\nThe built-in controller types are:\n\n['`BarController`', '`BubbleController`', '`DoughnutController`', '`LineController`', '`PieController`', '`PolarAreaController`', '`RadarController`', '`ScatterController`']\n\nThese controllers are also available in the UMD package, directly under `Chart`. Eg: `Chart.BarController`.\n\nFor example, to derive a new chart type that extends from a bubble chart, you would do the following.\n\n```\nimport {BubbleController} from 'chart.js';\nclass Custom extends BubbleController {\n draw() {\n // Call bubble controller method to draw all the points\n super.draw(arguments);\n\n // Now we can do some custom drawing for this dataset. Here we'll draw a red box around the first point in each dataset\n const meta = this.getMeta();\n const pt0 = meta.data[0];\n\n const {x, y} = pt0.getProps(['x', 'y']);\n const {radius} = pt0.options;\n\n const ctx = this.chart.ctx;\n ctx.save();\n ctx.strokeStyle = 'red';\n ctx.lineWidth = 1;\n ctx.strokeRect(x - radius, y - radius, 2 * radius, 2 * radius);\n ctx.restore();\n }\n};\nCustom.id = 'derivedBubble';\nCustom.defaults = BubbleController.defaults;\n\n// Stores the controller so that the chart initialization routine can look it up\nChart.register(Custom);\n\n// Now we can create and use our new chart type\nnew Chart(ctx, {\n type: 'derivedBubble',\n data: data,\n options: options\n});\n```",
"TypeScript Typings": "If you want your new chart type to be statically typed, you must provide a `.d.ts` TypeScript declaration file. Chart.js provides a way to augment built-in types with user-defined ones, by using the concept of \"declaration merging\".\n\nWhen adding a new chart type, `ChartTypeRegistry` must contain the declarations for the new type, either by extending an existing entry in `ChartTypeRegistry` or by creating a new one.\n\nFor example, to provide typings for a new chart type that extends from a bubble chart, you would add a `.d.ts` containing:\n\n```\nimport { ChartTypeRegistry } from 'chart.js';\n\ndeclare module 'chart.js' {\n interface ChartTypeRegistry {\n derivedBubble: ChartTypeRegistry['bubble']\n }\n}\n```"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 4, \"subpages\", 2]"
},
{
"title": "Contributing",
"description": null,
"content": {
"Joining the project": "Active committers and contributors are invited to introduce themselves and request commit access to this project. We have a very active Discord community that you can join [here](https://discord.gg/HxEguTK6av). If you think you can help, we'd love to have you!",
"Building and Testing": {
"Documentation": "We use [Vuepress](https://vuepress.vuejs.org/) to manage the docs which are contained as Markdown files in the docs directory. You can run the doc server locally using these commands:\n\n```\n> pnpm run docs:dev\n```",
"Image-Based Tests": "Some display-related functionality is difficult to test via typical Jasmine units. For this reason, we introduced image-based tests ([#3988](https://github.com/chartjs/Chart.js/pull/3988) and [#5777](https://github.com/chartjs/Chart.js/pull/5777)) to assert that a chart is drawn pixel-for-pixel matching an expected image.\n\nGenerated charts in image-based tests should be **as minimal as possible** and focus only on the tested feature to prevent failure if another feature breaks (e.g. disable the title and legend when testing scales).\n\nYou can create a new image-based test by following the steps below:\n\n['Create a JS file ([example](https://github.com/chartjs/Chart.js/blob/f7b671006a86201808402c3b6fe2054fe834fd4a/test/fixtures/controller.bubble/radius-scriptable.js)) or JSON file ([example](https://github.com/chartjs/Chart.js/blob/4b421a50bfa17f73ac7aa8db7d077e674dbc148d/test/fixtures/plugin.filler/fill-line-dataset.json)) that defines chart config and generation options.', 'Add this file in `test/fixtures/{spec.name}/{feature-name}.json`.', \"Add a [describe line](https://github.com/chartjs/Chart.js/blob/4b421a50bfa17f73ac7aa8db7d077e674dbc148d/test/specs/plugin.filler.tests.js#L10) to the beginning of `test/specs/{spec.name}.tests.js` if it doesn't exist yet.\", 'Run `pnpm run dev`.', 'Click the *\"Debug\"* button (top/right): a test should fail with the associated canvas visible.', 'Right-click on the chart and *\"Save image as...\"* `test/fixtures/{spec.name}/{feature-name}.png` making sure not to activate the tooltip or any hover functionality', 'Refresh the browser page (`CTRL+R`): test should now pass', 'Verify test relevancy by changing the feature values *slightly* in the JSON file.']\n\nTests should pass in both browsers. In general, we've hidden all text in image tests since it's quite difficult to get them to pass between different browsers. As a result, it is recommended to hide all scales in image-based tests. It is also recommended to disable animations. If tests still do not pass, adjust [`tolerance` and/or `threshold`](https://github.com/chartjs/Chart.js/blob/1ca0ffb5d5b6c2072176fd36fa85a58c483aa434/test/jasmine.matchers.js) at the beginning of the JSON file keeping them **as low as possible**.\n\nWhen a test fails, the expected and actual images are shown. If you'd like to see the images even when the tests pass, set `\"debug\": true` in the JSON file."
},
"Bugs and Issues": "Please report these on the GitHub page - at <a href=\"https://github.com/chartjs/Chart.js\" target=\"_blank\">github.com/chartjs/Chart.js</a>. Please do not use issues for support requests. For help using Chart.js, please take a look at the [`chart.js`](https://stackoverflow.com/questions/tagged/chart.js) tag on Stack Overflow.\n\nWell-structured, detailed bug reports are hugely valuable for the project.\n\nGuidelines for reporting bugs:\n\n['Check the issue search to see if it has already been reported', 'Isolate the problem to a simple test case', 'Please include a demonstration of the bug on a website such as [JS Bin](https://jsbin.com/), [JS Fiddle](https://jsfiddle.net/), or [Codepen](https://codepen.io/pen/). ([Template](https://codepen.io/pen?template=wvezeOq)). If filing a bug against `master`, you may reference the latest code via <https://www.chartjs.org/dist/master/chart.umd.min.js> (changing the filename to point at the file you need as appropriate). Do not rely on these files for production purposes as they may be removed at any time.']\n\nPlease provide any additional details associated with the bug, if it's browser or screen density specific, or only happens with a certain configuration or data."
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 4, \"subpages\", 3]"
},
{
"title": "Developers",
"description": null,
"content": {
"Latest resources": "The latest documentation and samples, including unreleased features, are available at:\n\n['<https://www.chartjs.org/docs/master/>', '<https://www.chartjs.org/samples/master/>']",
"Development releases": "Latest builds are available for testing at:\n\n['<https://www.chartjs.org/dist/master/chart.js>', '<https://www.chartjs.org/dist/master/chart.umd.min.js>']\n\n:::warning Warning\n\nDevelopment builds **must not** be used for production purposes or as replacement for a CDN. See [available CDNs](../getting-started/installation.md#cdn).\n\n:::",
"Browser support": "All modern and up-to-date browsers are supported, including, but not limited to:\n\n['Chrome', 'Edge', 'Firefox', 'Safari']\n\nAs of version 3, we have dropped Internet Explorer 11 support.\n\nBrowser support for the canvas element is available in all modern & major mobile browsers. [CanIUse](https://caniuse.com/#feat=canvas)\n\nRun `npx browserslist` at the root of the [codebase](https://github.com/chartjs/Chart.js) to get a list of supported browsers.\n\nThanks to [BrowserStack](https://browserstack.com) for allowing our team to test on thousands of browsers.",
"Previous versions": "To migrate from version 2 to version 3, please see [the v3 migration guide](../getting-started/v3-migration).\n\nVersion 3 has a largely different API than earlier versions.\n\nMost earlier version options have current equivalents or are the same.\n\nPlease note - documentation for previous versions is available online or in the GitHub repo.\n\n['[2.9.4 Documentation](https://www.chartjs.org/docs/2.9.4/)', '[1.x Documentation](https://github.com/chartjs/Chart.js/tree/v1.1.1/docs)']"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 4, \"subpages\", 4]"
},
{
"title": "Plugins",
"description": null,
"content": {
"Using plugins": "Plugins can be shared between chart instances:\n\n```\nconst plugin = { /* plugin implementation */ };\n\n// chart1 and chart2 use \"plugin\"\nconst chart1 = new Chart(ctx, {\n plugins: [plugin]\n});\n\nconst chart2 = new Chart(ctx, {\n plugins: [plugin]\n});\n\n// chart3 doesn't use \"plugin\"\nconst chart3 = new Chart(ctx, {});\n```\n\nPlugins can also be defined directly in the chart `plugins` config (a.k.a. *inline plugins*):\n\n:::warning\n*inline* plugins are not registered. Some plugins require registering, i.e. can't be used *inline*.\n:::\n\n```\nconst chart = new Chart(ctx, {\n plugins: [{\n beforeInit: function(chart, args, options) {\n //..\n }\n }]\n});\n```\n\nHowever, this approach is not ideal when the customization needs to apply to many charts.",
"Global plugins": "Plugins can be registered globally to be applied on all charts (a.k.a. *global plugins*):\n\n```\nChart.register({\n // plugin implementation\n});\n```\n\n:::warning\n*inline* plugins can't be registered globally.\n:::",
"Configuration": {
"Plugin ID": "Plugins must define a unique id in order to be configurable.\n\nThis id should follow the [npm package name convention](https://docs.npmjs.com/files/package.json#name):\n\n[\"can't start with a dot or an underscore\", \"can't contain any non-URL-safe characters\", \"can't contain uppercase letters\", 'should be something short, but also reasonably descriptive']\n\nIf a plugin is intended to be released publicly, you may want to check the [registry](https://www.npmjs.com/search?q=chartjs-plugin-) to see if there's something by that name already. Note that in this case, the package name should be prefixed by `chartjs-plugin-` to appear in Chart.js plugin registry.",
"Plugin options": {
"Disable plugins": "To disable a global plugin for a specific chart instance, the plugin options must be set to `false`:\n\n```\nChart.register({\n id: 'p1',\n // ...\n});\n\nconst chart = new Chart(ctx, {\n options: {\n plugins: {\n p1: false // disable plugin 'p1' for this instance\n }\n }\n});\n```\n\nTo disable all plugins for a specific chart instance, set `options.plugins` to `false`:\n\n```\nconst chart = new Chart(ctx, {\n options: {\n plugins: false // all plugins are disabled for this instance\n }\n});\n```",
"Plugin defaults": "You can set default values for your plugin options in the `defaults` entry of your plugin object. In the example below the canvas will always have a lightgreen backgroundColor unless the user overrides this option in `options.plugins.custom_canvas_background_color.color`.\n\n```\nconst plugin = {\n id: 'custom_canvas_background_color',\n beforeDraw: (chart, args, options) => {\n const {ctx} = chart;\n ctx.save();\n ctx.globalCompositeOperation = 'destination-over';\n ctx.fillStyle = options.color;\n ctx.fillRect(0, 0, chart.width, chart.height);\n ctx.restore();\n },\n defaults: {\n color: 'lightGreen'\n }\n}\n```"
}
},
"Plugin Core API": {
"Chart Initialization": "Plugins are notified during the initialization process. These hooks can be used to set up data needed for the plugin to operate.\n\n",
"Chart Update": "Plugins are notified throughout the update process.\n\n",
"Scale Update": "Plugins are notified throughout the scale update process.\n\n",
"Rendering": "Plugins can interact with the chart throughout the render process. The rendering process is documented in the flowchart below. Each of the green processes is a plugin notification. The red lines indicate how cancelling part of the render process can occur when a plugin returns `false` from a hook. Not all hooks are cancelable, however, in general most `before*` hooks can be cancelled.\n\n",
"Event Handling": "Plugins can interact with the chart during the event handling process. The event handling flow is documented in the flowchart below. Each of the green processes is a plugin notification. If a plugin makes changes that require a re-render, the plugin can set `args.changed` to `true` to indicate that a render is needed. The built-in tooltip plugin uses this method to indicate when the tooltip has changed.\n\n",
"Chart destroy": "Plugins are notified during the destroy process. These hooks can be used to destroy things that the plugin made and used during its life.\nThe `destroy` hook has been deprecated since Chart.js version 3.7.0, use the `afterDestroy` hook instead.\n\n"
},
"TypeScript Typings": "If you want your plugin to be statically typed, you must provide a `.d.ts` TypeScript declaration file. Chart.js provides a way to augment built-in types with user-defined ones, by using the concept of \"declaration merging\".\n\nWhen adding a plugin, `PluginOptionsByType` must contain the declarations for the plugin.\n\nFor example, to provide typings for the [`canvas backgroundColor plugin`](../configuration/canvas-background.md), you would add a `.d.ts` containing:\n\n```\nimport {ChartType, Plugin} from 'chart.js';\n\ndeclare module 'chart.js' {\n interface PluginOptionsByType<TType extends ChartType> {\n customCanvasBackgroundColor?: {\n color?: string\n }\n }\n}\n```"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 4, \"subpages\", 5]"
},
{
"title": "Publishing an extension",
"description": null,
"content": {
"Awesome": "You'd probably want your extension to be listed in the [awesome](https://github.com/chartjs/awesome).\n\nNote the minimum extension age requirement of 30 days.",
"ESM": {
"Rollup": "`output.globals` can be used to convert the helpers.\n\n```\nmodule.exports = {\n // ...\n output: {\n globals: {\n 'chart.js': 'Chart',\n 'chart.js/helpers': 'Chart.helpers'\n }\n }\n};\n```"
}
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 4, \"subpages\", 6]"
},
{
"title": "Updating Charts",
"description": null,
"content": {
"Adding or Removing Data": "Adding and removing data is supported by changing the data array. To add data, just add data into the data array as seen in this example, to remove it you can pop it again.\n\n```\nfunction addData(chart, label, newData) {\n chart.data.labels.push(label);\n chart.data.datasets.forEach((dataset) => {\n dataset.data.push(newData);\n });\n chart.update();\n}\n\nfunction removeData(chart) {\n chart.data.labels.pop();\n chart.data.datasets.forEach((dataset) => {\n dataset.data.pop();\n });\n chart.update();\n}\n```",
"Updating Options": "To update the options, mutating the `options` property in place or passing in a new options object are supported.\n\n['If the options are mutated in place, other option properties would be preserved, including those calculated by Chart.js.', 'If created as a new object, it would be like creating a new chart with the options - old options would be discarded.']\n\n```\nfunction updateConfigByMutating(chart) {\n chart.options.plugins.title.text = 'new title';\n chart.update();\n}\n\nfunction updateConfigAsNewObject(chart) {\n chart.options = {\n responsive: true,\n plugins: {\n title: {\n display: true,\n text: 'Chart.js'\n }\n },\n scales: {\n x: {\n display: true\n },\n y: {\n display: true\n }\n }\n };\n chart.update();\n}\n```\n\nScales can be updated separately without changing other options.\nTo update the scales, pass in an object containing all the customization including those unchanged ones.\n\nVariables referencing any one from `chart.scales` would be lost after updating scales with a new `id` or the changed `type`.\n\n```\nfunction updateScales(chart) {\n let xScale = chart.scales.x;\n let yScale = chart.scales.y;\n chart.options.scales = {\n newId: {\n display: true\n },\n y: {\n display: true,\n type: 'logarithmic'\n }\n };\n chart.update();\n // need to update the reference\n xScale = chart.scales.newId;\n yScale = chart.scales.y;\n}\n```\n\nYou can update a specific scale by its id as well.\n\n```\nfunction updateScale(chart) {\n chart.options.scales.y = {\n type: 'logarithmic'\n };\n chart.update();\n}\n```\n\nCode sample for updating options can be found in [line-datasets.html](https://www.chartjs.org/docs/latest/samples/area/line-datasets.html).",
"Preventing Animations": "Sometimes when a chart updates, you may not want an animation. To achieve this you can call `update` with `'none'` as mode.\n\n```\nmyChart.update('none');\n```"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 4, \"subpages\", 7]"
}
],
"path": "[\"subpages\", 4]"
},
{
"title": "General",
"description": "Documentation section: general",
"content": {},
"metadata": {
"type": "directory",
"path": "/home/anhnh/CodeWikiBench/data/Chart.js/original/docs/general"
},
"subpages": [
{
"title": "Accessibility",
"description": null,
"content": {
"Examples": "These are some examples of **accessible** `canvas` elements.\n\nBy setting the `role` and `aria-label`, this `canvas` now has an accessible name.\n\n```\n<canvas id=\"goodCanvas1\" width=\"400\" height=\"100\" aria-label=\"Hello ARIA World\" role=\"img\"></canvas>\n```\n\nThis `canvas` element has a text alternative via fallback content.\n\n```\n<canvas id=\"okCanvas2\" width=\"400\" height=\"100\">\n <p>Hello Fallback World</p>\n</canvas>\n```\n\nThese are some bad examples of **inaccessible** `canvas` elements.\n\nThis `canvas` element does not have an accessible name or role.\n\n```\n<canvas id=\"badCanvas1\" width=\"400\" height=\"100\"></canvas>\n```\n\nThis `canvas` element has inaccessible fallback content.\n\n```\n<canvas id=\"badCanvas2\" width=\"400\" height=\"100\">Your browser does not support the canvas element.</canvas>\n```"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 5, \"subpages\", 0]"
},
{
"title": "Colors",
"description": null,
"content": {
"Default colors": {
"Per-dataset color settings": "If your chart has multiple datasets, using default colors would make individual datasets indistinguishable. In that case, you can set `backgroundColor` and `borderColor` for each dataset:\n\n```\nconst data = {\n labels: ['A', 'B', 'C'],\n datasets: [\n {\n label: 'Dataset 1',\n data: [1, 2, 3],\n borderColor: '#36A2EB',\n backgroundColor: '#9BD0F5',\n },\n {\n label: 'Dataset 2',\n data: [2, 3, 4],\n borderColor: '#FF6384',\n backgroundColor: '#FFB1C1',\n }\n ]\n};\n```\n\nHowever, setting colors for each dataset might require additional work that you'd rather not do. In that case, consider using the following plugins with pre-defined or generated palettes.",
"Default color palette": "If you don't have any preference for colors, you can use the built-in `Colors` plugin. It will cycle through a palette of seven Chart.js brand colors:\n\n<div style=\"max-width: 500px;\">\n\n\n\n</div>\n\nAll you need is to import and register the plugin:\n\n```\nimport { Colors } from 'chart.js';\n\nChart.register(Colors);\n```\n\n:::tip Note\n\nIf you are using the UMD version of Chart.js, this plugin will be enabled by default. You can disable it by setting the `enabled` option to `false`:\n\n```\nconst options = {\n plugins: {\n colors: {\n enabled: false\n }\n }\n};\n```\n\n:::",
"Dynamic datasets at runtime": "By default, the colors plugin only works when you initialize the chart without any colors for the border or background specified.\nIf you want to force the colors plugin to always color your datasets, for example, when using dynamic datasets at runtime you will need to set the `forceOverride` option to true:\n\n```\nconst options = {\n plugins: {\n colors: {\n forceOverride: true\n }\n }\n};\n```",
"Advanced color palettes": "See the [awesome list](https://github.com/chartjs/awesome#plugins) for plugins that would give you more flexibility defining color palettes."
},
"Color formats": "You can specify the color as a string in either of the following notations:\n\n| Notation | Example | Example with transparency\n| -------- | ------- | -------------------------\n| [Hexadecimal](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color) | `#36A2EB` | `#36A2EB80`\n| [RGB](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/rgb) or [RGBA](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/rgba) | `rgb(54, 162, 235)` | `rgba(54, 162, 235, 0.5)`\n| [HSL](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/hsl) or [HSLA](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/hsla) | `hsl(204, 82%, 57%)` | `hsla(204, 82%, 57%, 0.5)`\n\nAlternatively, you can pass a [CanvasPattern](https://developer.mozilla.org/en-US/docs/Web/API/CanvasPattern) or [CanvasGradient](https://developer.mozilla.org/en/docs/Web/API/CanvasGradient) object instead of a string color to achieve some interesting effects.",
"Patterns and Gradients": "For example, you can fill a dataset with a pattern from an image.\n\n```\nconst img = new Image();\nimg.src = 'https://example.com/my_image.png';\nimg.onload = () => {\n const ctx = document.getElementById('canvas').getContext('2d');\n const fillPattern = ctx.createPattern(img, 'repeat');\n\n const chart = new Chart(ctx, {\n data: {\n labels: ['Item 1', 'Item 2', 'Item 3'],\n datasets: [{\n data: [10, 20, 30],\n backgroundColor: fillPattern\n }]\n }\n });\n};\n```\n\nPattern fills can help viewers with vision deficiencies (e.g., color-blindness or partial sight) [more easily understand your data](http://betweentwobrackets.com/data-graphics-and-colour-vision/).\n\nYou can use the [Patternomaly](https://github.com/ashiguruma/patternomaly) library to generate patterns to fill datasets:\n\n```\nconst chartData = {\n datasets: [{\n data: [45, 25, 20, 10],\n backgroundColor: [\n pattern.draw('square', '#ff6384'),\n pattern.draw('circle', '#36a2eb'),\n pattern.draw('diamond', '#cc65fe'),\n pattern.draw('triangle', '#ffce56')\n ]\n }],\n labels: ['Red', 'Blue', 'Purple', 'Yellow']\n};\n```"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 5, \"subpages\", 1]"
},
{
"title": "Data structures",
"description": null,
"content": {
"Primitive[]": "```\nconst cfg = {\n type: 'bar',\n data: {\n datasets: [{\n data: [20, 10],\n }],\n labels: ['a', 'b']\n }\n}\n```\n\nWhen `data` is an array of numbers, values from the `labels` array at the same index are used for the index axis (`x` for vertical, `y` for horizontal charts).",
"Array[]": "```\nconst cfg = {\n type: 'line',\n data: {\n datasets: [{\n data: [[10, 20], [15, null], [20, 10]]\n }]\n }\n}\n```\n\nWhen `data` is an array of arrays (or what TypeScript would call tuples), the first element of each tuple is the index (`x` for vertical, `y` for horizontal charts) and the second element is the value (`y` by default).",
"Object[]": "```\nconst cfg = {\n type: 'line',\n data: {\n datasets: [{\n data: [{x: 10, y: 20}, {x: 15, y: null}, {x: 20, y: 10}]\n }]\n }\n}\n```\n\n```\nconst cfg = {\n type: 'line',\n data: {\n datasets: [{\n data: [{x: '2016-12-25', y: 20}, {x: '2016-12-26', y: 10}]\n }]\n }\n}\n```\n\n```\nconst cfg = {\n type: 'bar',\n data: {\n datasets: [{\n data: [{x: 'Sales', y: 20}, {x: 'Revenue', y: 10}]\n }]\n }\n}\n```\n\nThis is also the internal format used for parsed data. In this mode, parsing can be disabled by specifying `parsing: false` at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.\n\nThe values provided must be parsable by the associated scales or in the internal format of the associated scales. For example, the `category` scale uses integers as an internal format, where each integer represents an index in the labels array; but, if parsing is enabled, it can also parse string labels.\n\n`null` can be used for skipped values.",
"Object[] using custom properties": "```\nconst cfg = {\n type: 'bar',\n data: {\n datasets: [{\n data: [{id: 'Sales', nested: {value: 1500}}, {id: 'Purchases', nested: {value: 500}}]\n }]\n },\n options: {\n parsing: {\n xAxisKey: 'id',\n yAxisKey: 'nested.value'\n }\n }\n}\n```\n\nWhen using the pie/doughnut, radar or polarArea chart type, the `parsing` object should have a `key` item that points to the value to look at. In this example, the doughnut chart will show two items with values 1500 and 500.\n\n```\nconst cfg = {\n type: 'doughnut',\n data: {\n datasets: [{\n data: [{id: 'Sales', nested: {value: 1500}}, {id: 'Purchases', nested: {value: 500}}]\n }]\n },\n options: {\n parsing: {\n key: 'nested.value'\n }\n }\n}\n```\n\nIf the key contains a dot, it needs to be escaped with a double slash:\n\n```\nconst cfg = {\n type: 'line',\n data: {\n datasets: [{\n data: [{'data.key': 'one', 'data.value': 20}, {'data.key': 'two', 'data.value': 30}]\n }]\n },\n options: {\n parsing: {\n xAxisKey: 'data\\\\.key',\n yAxisKey: 'data\\\\.value'\n }\n }\n}\n```\n\n:::warning\nWhen using object notation in a radar chart, you still need a `labels` array with labels for the chart to show correctly.\n:::",
"Object": "```\nconst cfg = {\n type: 'line',\n data: {\n datasets: [{\n data: {\n January: 10,\n February: 20\n }\n }]\n }\n}\n```\n\nIn this mode, the property name is used for the `index` scale and value for the `value` scale. For vertical charts, the index scale is `x` and value scale is `y`.",
"Dataset Configuration": {
"parsing": "```\nconst data = [{x: 'Jan', net: 100, cogs: 50, gm: 50}, {x: 'Feb', net: 120, cogs: 55, gm: 75}];\nconst cfg = {\n type: 'bar',\n data: {\n labels: ['Jan', 'Feb'],\n datasets: [{\n label: 'Net sales',\n data: data,\n parsing: {\n yAxisKey: 'net'\n }\n }, {\n label: 'Cost of goods sold',\n data: data,\n parsing: {\n yAxisKey: 'cogs'\n }\n }, {\n label: 'Gross margin',\n data: data,\n parsing: {\n yAxisKey: 'gm'\n }\n }]\n },\n};\n```"
},
"TypeScript": "When using TypeScript, if you want to use a data structure that is not the default data structure, you will need to pass it to the type interface when instantiating the data variable.\n\n```\nimport {ChartData} from 'chart.js';\n\nconst datasets: ChartData <'bar', {key: string, value: number} []> = {\n datasets: [{\n data: [{key: 'Sales', value: 20}, {key: 'Revenue', value: 10}],\n parsing: {\n xAxisKey: 'key',\n yAxisKey: 'value'\n }\n }],\n};\n```"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 5, \"subpages\", 2]"
},
{
"title": "Fonts",
"description": null,
"content": {
"Missing Fonts": "If a font is specified for a chart that does exist on the system, the browser will not apply the font when it is set. If you notice odd fonts appearing in your charts, check that the font you are applying exists on your system. See [issue 3318](https://github.com/chartjs/Chart.js/issues/3318) for more details.",
"Loading Fonts": "If a font is not cached and needs to be loaded, charts that use the font will need to be updated once the font is loaded. This can be accomplished using the [Font Loading APIs](https://developer.mozilla.org/en-US/docs/Web/API/CSS_Font_Loading_API). See [issue 8020](https://github.com/chartjs/Chart.js/issues/8020) for more details."
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 5, \"subpages\", 3]"
},
{
"title": "Options",
"description": null,
"content": {
"Option resolution": {
"Chart level options": [
"options",
"overrides[`config.type`]",
"defaults"
],
"Dataset level options": "`dataset.type` defaults to `config.type`, if not specified.\n\n['dataset', 'options.datasets[`dataset.type`]', 'options', 'overrides[`config.type`].datasets[`dataset.type`]', 'defaults.datasets[`dataset.type`]', 'defaults']",
"Dataset animation options": [
"dataset.animation",
"options.datasets[`dataset.type`].animation",
"options.animation",
"overrides[`config.type`].datasets[`dataset.type`].animation",
"defaults.datasets[`dataset.type`].animation",
"defaults.animation"
],
"Dataset element level options": "Each scope is looked up with `elementType` prefix in the option name first, then without the prefix. For example, `radius` for `point` element is looked up using `pointRadius` and if that does not hit, then `radius`.\n\n['dataset', 'options.datasets[`dataset.type`]', 'options.datasets[`dataset.type`].elements[`elementType`]', 'options.elements[`elementType`]', 'options', 'overrides[`config.type`].datasets[`dataset.type`]', 'overrides[`config.type`].datasets[`dataset.type`].elements[`elementType`]', 'defaults.datasets[`dataset.type`]', 'defaults.datasets[`dataset.type`].elements[`elementType`]', 'defaults.elements[`elementType`]', 'defaults']",
"Scale options": [
"options.scales",
"overrides[`config.type`].scales",
"defaults.scales",
"defaults.scale"
],
"Plugin options": "A plugin can provide `additionalOptionScopes` array of paths to additionally look for its options in. For root scope, use empty string: `''`. Most core plugins also take options from root scope.\n\n['options.plugins[`plugin.id`]', '(options.[`...plugin.additionalOptionScopes`])', 'overrides[`config.type`].plugins[`plugin.id`]', 'defaults.plugins[`plugin.id`]', '(defaults.[`...plugin.additionalOptionScopes`])']"
},
"Scriptable Options": "Scriptable options also accept a function which is called for each of the underlying data values and that takes the unique argument `context` representing contextual information (see [option context](options.md#option-context)).\nA resolver is passed as second parameter, that can be used to access other options in the same context.\n\n:::tip Note\n\nThe `context` argument should be validated in the scriptable function, because the function can be invoked in different contexts. The `type` field is a good candidate for this validation.\n\n:::\n\nExample:\n\n```\ncolor: function(context) {\n const index = context.dataIndex;\n const value = context.dataset.data[index];\n return value < 0 ? 'red' : // draw negative values in red\n index % 2 ? 'blue' : // else, alternate values in blue and green\n 'green';\n},\nborderColor: function(context, options) {\n const color = options.color; // resolve the value of another scriptable option: 'red', 'blue' or 'green'\n return Chart.helpers.color(color).lighten(0.2);\n}\n```",
"Indexable Options": "Indexable options also accept an array in which each item corresponds to the element at the same index. Note that if there are less items than data, the items are looped over. In many cases, using a [function](#scriptable-options) is more appropriate if supported.\n\nExample:\n\n```\ncolor: [\n 'red', // color for data at index 0\n 'blue', // color for data at index 1\n 'green', // color for data at index 2\n 'black', // color for data at index 3\n //...\n]\n```",
"Option Context": {
"chart": [
"`chart`: the associated chart",
"`type`: `'chart'`"
],
"dataset": "In addition to [chart](#chart)\n\n['`active`: true if an element is active (hovered)', '`dataset`: dataset at index `datasetIndex`', '`datasetIndex`: index of the current dataset', '`index`: same as `datasetIndex`', '`mode`: the update mode', \"`type`: `'dataset'`\"]",
"data": "In addition to [dataset](#dataset)\n\n['`active`: true if an element is active (hovered)', '`dataIndex`: index of the current data', '`parsed`: the parsed data values for the given `dataIndex` and `datasetIndex`', '`raw`: the raw data values for the given `dataIndex` and `datasetIndex`', '`element`: the element (point, arc, bar, etc.) for this data', '`index`: same as `dataIndex`', \"`type`: `'data'`\"]",
"scale": "In addition to [chart](#chart)\n\n['`scale`: the associated scale', \"`type`: `'scale'`\"]",
"tick": "In addition to [scale](#scale)\n\n['`tick`: the associated tick object', '`index`: tick index', \"`type`: `'tick'`\"]",
"pointLabel": "In addition to [scale](#scale)\n\n['`label`: the associated label value', '`index`: label index', \"`type`: `'pointLabel'`\"]",
"tooltip": "In addition to [chart](#chart)\n\n['`tooltip`: the tooltip object', '`tooltipItems`: the items the tooltip is displaying']"
}
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 5, \"subpages\", 4]"
},
{
"title": "Padding",
"description": null,
"content": {
"Number": "If this value is a number, it is applied to all sides (left, top, right, bottom).\n\nFor example, defining a 20px padding to all sides of the chart:\n\n```\nlet chart = new Chart(ctx, {\n type: 'line',\n data: data,\n options: {\n layout: {\n padding: 20\n }\n }\n});\n```",
"{top, left, bottom, right} object": "If this value is an object, the `left` property defines the left padding. Similarly, the `right`, `top` and `bottom` properties can also be specified.\nOmitted properties default to `0`.\n\nLet's say you wanted to add 50px of padding to the left side of the chart canvas, you would do:\n\n```\nlet chart = new Chart(ctx, {\n type: 'line',\n data: data,\n options: {\n layout: {\n padding: {\n left: 50\n }\n }\n }\n});\n```",
"{x, y} object": "This is a shorthand for defining left/right and top/bottom to the same values.\n\nFor example, 10px left / right and 4px top / bottom padding on a Radial Linear Axis [tick backdropPadding](../axes/radial/linear.md#linear-radial-axis-specific-tick-options):\n\n```\nlet chart = new Chart(ctx, {\n type: 'radar',\n data: data,\n options: {\n scales: {\n r: {\n ticks: {\n backdropPadding: {\n x: 10,\n y: 4\n }\n }\n }\n }\n});\n```"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 5, \"subpages\", 5]"
},
{
"title": "Performance",
"description": null,
"content": {
"Data structure and format": {
"Parsing": "Provide prepared data in the internal format accepted by the dataset and scales, and set `parsing: false`. See [Data structures](data-structures.md) for more information.",
"Data normalization": "Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the `normalized: true` option to let Chart.js know that you have done so. Even without this option, it can sometimes still be faster to provide sorted data.",
"Decimation": "Decimating your data will achieve the best results. When there is a lot of data to display on the graph, it doesn't make sense to show tens of thousands of data points on a graph that is only a few hundred pixels wide.\n\nThe [decimation plugin](../configuration/decimation.md) can be used with line charts to decimate data before the chart is rendered. This will provide the best performance since it will reduce the memory needed to render the chart.\n\nLine charts are able to do [automatic data decimation during draw](#automatic-data-decimation-during-draw), when certain conditions are met. You should still consider decimating data yourself before passing it in for maximum performance since the automatic decimation occurs late in the chart life cycle."
},
"Tick Calculation": {
"Rotation": "[Specify a rotation value](../axes/cartesian/index.md#tick-configuration) by setting `minRotation` and `maxRotation` to the same value, which avoids the chart from having to automatically determine a value to use.",
"Sampling": "Set the [`ticks.sampleSize`](../axes/cartesian/index.md#tick-configuration) option. This will determine how large your labels are by looking at only a subset of them in order to render axes more quickly. This works best if there is not a large variance in the size of your labels."
},
"Disable Animations": "If your charts have long render times, it is a good idea to disable animations. Doing so will mean that the chart needs to only be rendered once during an update instead of multiple times. This will have the effect of reducing CPU usage and improving general page performance.\nLine charts use Path2D caching when animations are disabled and Path2D is available.\n\nTo disable animations\n\n```\nnew Chart(ctx, {\n type: 'line',\n data: data,\n options: {\n animation: false\n }\n});\n```",
"Specify `min` and `max` for scales": "If you specify the `min` and `max`, the scale does not have to compute the range from the data.\n\n```\nnew Chart(ctx, {\n type: 'line',\n data: data,\n options: {\n scales: {\n x: {\n type: 'time',\n min: new Date('2019-01-01').valueOf(),\n max: new Date('2019-12-31').valueOf()\n },\n y: {\n type: 'linear',\n min: 0,\n max: 100\n }\n }\n }\n});\n```",
"Parallel rendering with web workers": "As of 2023, modern browser have the ability to [transfer rendering control of a canvas](https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/transferControlToOffscreen) to a web worker. Web workers can use the [OffscreenCanvas API](https://developer.mozilla.org/en-US/docs/Web/API/OffscreenCanvas) to render from a web worker onto canvases in the DOM. Chart.js is a canvas-based library and supports rendering in a web worker - just pass an OffscreenCanvas into the Chart constructor instead of a Canvas element.\n\nBy moving all Chart.js calculations onto a separate thread, the main thread can be freed up for other uses. Some tips and tricks when using Chart.js in a web worker:\n\n['Transferring data between threads can be expensive, so ensure that your config and data objects are as small as possible. Try generating them on the worker side if you can (workers can make HTTP requests!) or passing them to your worker as ArrayBuffers, which can be transferred quickly from one thread to another.', \"You can't transfer functions between threads, so if your config object includes functions you'll have to strip them out before transferring and then add them back later.\", \"You can't access the DOM from worker threads, so Chart.js plugins that use the DOM (including any mouse interactions) will likely not work.\", 'Ensure that you have a fallback if you support older browsers.', 'Resizing the chart must be done manually. See an example in the worker code below.']\n\nExample main thread code:\n\n```\nconst config = {};\nconst canvas = new HTMLCanvasElement();\nconst offscreenCanvas = canvas.transferControlToOffscreen();\n\nconst worker = new Worker('worker.js');\nworker.postMessage({canvas: offscreenCanvas, config}, [offscreenCanvas]);\n```\n\nExample worker code, in `worker.js`:\n\n```\nonmessage = function(event) {\n const {canvas, config} = event.data;\n const chart = new Chart(canvas, config);\n\n // Resizing the chart must be done manually, since OffscreenCanvas does not include event listeners.\n canvas.width = 100;\n canvas.height = 100;\n chart.resize();\n};\n```",
"Line Charts": {
"Leave B\u00e9zier curves disabled": "If you are drawing lines on your chart, disabling B\u00e9zier curves will improve render times since drawing a straight line is more performant than a B\u00e9zier curve. B\u00e9zier curves are disabled by default.",
"Automatic data decimation during draw": "Line element will automatically decimate data, when `tension`, `stepped`, and `borderDash` are left set to their default values (`false`, `0`, and `[]` respectively). This improves rendering speed by skipping drawing of invisible line segments.",
"Enable spanGaps": "If you have a lot of data points, it can be more performant to enable `spanGaps`. This disables segmentation of the line, which can be an unneeded step.\n\nTo enable `spanGaps`:\n\n```\nnew Chart(ctx, {\n type: 'line',\n data: {\n datasets: [{\n spanGaps: true // enable for a single dataset\n }]\n },\n options: {\n spanGaps: true // enable for all datasets\n }\n});\n```",
"Disable Line Drawing": "If you have a lot of data points, it can be more performant to disable rendering of the line for a dataset and only draw points. Doing this means that there is less to draw on the canvas which will improve render performance.\n\nTo disable lines:\n\n```\nnew Chart(ctx, {\n type: 'line',\n data: {\n datasets: [{\n showLine: false // disable for a single dataset\n }]\n },\n options: {\n showLine: false // disable for all datasets\n }\n});\n```",
"Disable Point Drawing": "If you have a lot of data points, it can be more performant to disable rendering of the points for a dataset and only draw lines. Doing this means that there is less to draw on the canvas which will improve render performance.\n\nTo disable point drawing:\n\n```\nnew Chart(ctx, {\n type: 'line',\n data: {\n datasets: [{\n pointRadius: 0 // disable for a single dataset\n }]\n },\n options: {\n datasets: {\n line: {\n pointRadius: 0 // disable for all `'line'` datasets\n }\n },\n elements: {\n point: {\n radius: 0 // default to disabled in all datasets\n }\n }\n }\n});\n```"
},
"When transpiling with Babel, consider using `loose` mode": "Babel 7.9 changed the way classes are constructed. It is slow, unless used with `loose` mode.\n[More information](https://github.com/babel/babel/issues/11356)"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 5, \"subpages\", 6]"
}
],
"path": "[\"subpages\", 5]"
},
{
"title": "Getting Started",
"description": "Documentation section: getting-started",
"content": {},
"metadata": {
"type": "directory",
"path": "/home/anhnh/CodeWikiBench/data/Chart.js/original/docs/getting-started"
},
"subpages": [
{
"title": "Getting Started",
"description": null,
"content": {
"Create a Chart": "In this example, we create a bar chart for a single dataset and render it on an HTML page. Add this code snippet to your page:\n\n```\n<div>\n <canvas id=\"myChart\"></canvas>\n</div>\n\n<script src=\"https://cdn.jsdelivr.net/npm/chart.js\"></script>\n\n<script>\n const ctx = document.getElementById('myChart');\n\n new Chart(ctx, {\n type: 'bar',\n data: {\n labels: ['Red', 'Blue', 'Yellow', 'Green', 'Purple', 'Orange'],\n datasets: [{\n label: '# of Votes',\n data: [12, 19, 3, 5, 2, 3],\n borderWidth: 1\n }]\n },\n options: {\n scales: {\n y: {\n beginAtZero: true\n }\n }\n }\n });\n</script>\n```\n\nYou should get a chart like this:\n\n\n\nLet's break this code down.\n\nFirst, we need to have a canvas in our page. It's recommended to give the chart its own container for [responsiveness](../configuration/responsive.md).\n\n```\n<div>\n <canvas id=\"myChart\"></canvas>\n</div>\n```\n\nNow that we have a canvas, we can include Chart.js from a CDN.\n\n```\n<script src=\"https://cdn.jsdelivr.net/npm/chart.js\"></script>\n```\n\nFinally, we can create a chart. We add a script that acquires the `myChart` canvas element and instantiates `new Chart` with desired configuration: `bar` chart type, labels, data points, and options.\n\n```\n<script>\n const ctx = document.getElementById('myChart');\n\n new Chart(ctx, {\n type: 'bar',\n data: {\n labels: ['Red', 'Blue', 'Yellow', 'Green', 'Purple', 'Orange'],\n datasets: [{\n label: '# of Votes',\n data: [12, 19, 3, 5, 2, 3],\n borderWidth: 1\n }]\n },\n options: {\n scales: {\n y: {\n beginAtZero: true\n }\n }\n }\n });\n</script>\n```\n\nYou can see all the ways to use Chart.js in the [step-by-step guide](./usage)."
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 6, \"subpages\", 0]"
},
{
"title": "Installation",
"description": null,
"content": {
"npm": "[](https://npmjs.com/package/chart.js)\n[](https://npmjs.com/package/chart.js)\n\n```\nnpm install chart.js\n```",
"CDN": {
"CDNJS": "[](https://cdnjs.com/libraries/Chart.js)\n\nChart.js built files are available on [CDNJS](https://cdnjs.com/):\n\n<https://cdnjs.com/libraries/Chart.js>",
"jsDelivr": "[](https://cdn.jsdelivr.net/npm/chart.js@latest/dist/) [](https://www.jsdelivr.com/package/npm/chart.js)\n\nChart.js built files are also available through [jsDelivr](https://www.jsdelivr.com/):\n\n<https://www.jsdelivr.com/package/npm/chart.js?path=dist>"
},
"GitHub": "[](https://github.com/chartjs/Chart.js/releases/latest)\n\nYou can download the latest version of [Chart.js on GitHub](https://github.com/chartjs/Chart.js/releases/latest).\n\nIf you download or clone the repository, you must [build](../developers/contributing.md#building-and-testing) Chart.js to generate the dist files. Chart.js no longer comes with prebuilt release versions, so an alternative option to downloading the repo is **strongly** advised."
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 6, \"subpages\", 1]"
},
{
"title": "Integration",
"description": null,
"content": {
"Script Tag": "```\n<script src=\"path/to/chartjs/dist/chart.umd.min.js\"></script>\n<script>\n const myChart = new Chart(ctx, {...});\n</script>\n```",
"Bundlers (Webpack, Rollup, etc.)": {
"Quick start": "If you don't care about the bundle size, you can use the `auto` package ensuring all features are available:\n\n```\nimport Chart from 'chart.js/auto';\n```",
"Bundle optimization": "When optimizing the bundle, you need to import and register the components that are needed in your application.\n\nThe options are categorized into controllers, elements, plugins, scales. You can pick and choose many of these, e.g. if you are not going to use tooltips, don't import and register the `Tooltip` plugin. But each type of chart has its own bare-minimum requirements (typically the type's controller, element(s) used by that controller and scale(s)):\n\n['Bar chart', ['`BarController`', '`BarElement`', 'Default scales: `CategoryScale` (x), `LinearScale` (y)'], 'Bubble chart', ['`BubbleController`', '`PointElement`', 'Default scales: `LinearScale` (x/y)'], 'Doughnut chart', ['`DoughnutController`', '`ArcElement`', 'Not using scales'], 'Line chart', ['`LineController`', '`LineElement`', '`PointElement`', 'Default scales: `CategoryScale` (x), `LinearScale` (y)'], 'Pie chart', ['`PieController`', '`ArcElement`', 'Not using scales'], 'PolarArea chart', ['`PolarAreaController`', '`ArcElement`', 'Default scale: `RadialLinearScale` (r)'], 'Radar chart', ['`RadarController`', '`LineElement`', '`PointElement`', 'Default scale: `RadialLinearScale` (r)'], 'Scatter chart', ['`ScatterController`', '`PointElement`', 'Default scales: `LinearScale` (x/y)']]\n\nAvailable plugins:\n\n['[`Decimation`](../configuration/decimation.md)', '`Filler` - used to fill area described by `LineElement`, see [Area charts](../charts/area.md)', '[`Legend`](../configuration/legend.md)', '[`SubTitle`](../configuration/subtitle.md)', '[`Title`](../configuration/title.md)', '[`Tooltip`](../configuration/tooltip.md)']\n\nAvailable scales:\n\n['Cartesian scales (x/y)', ['[`CategoryScale`](../axes/cartesian/category.md)', '[`LinearScale`](../axes/cartesian/linear.md)', '[`LogarithmicScale`](../axes/cartesian/logarithmic.md)', '[`TimeScale`](../axes/cartesian/time.md)', '[`TimeSeriesScale`](../axes/cartesian/timeseries.md)'], 'Radial scales (r)', ['[`RadialLinearScale`](../axes/radial/linear.md)']]",
"Helper functions": "If you want to use the helper functions, you will need to import these separately from the helpers package and use them as stand-alone functions.\n\nExample of [Converting Events to Data Values](../configuration/interactions.md#converting-events-to-data-values) using bundlers.\n\n```\nimport Chart from 'chart.js/auto';\nimport { getRelativePosition } from 'chart.js/helpers';\n\nconst chart = new Chart(ctx, {\n type: 'line',\n data: data,\n options: {\n onClick: (e) => {\n const canvasPosition = getRelativePosition(e, chart);\n\n // Substitute the appropriate scale IDs\n const dataX = chart.scales.x.getValueForPixel(canvasPosition.x);\n const dataY = chart.scales.y.getValueForPixel(canvasPosition.y);\n }\n }\n});\n```"
},
"CommonJS": "Because Chart.js is an ESM library, in CommonJS modules you should use a dynamic `import`:\n\n```\nconst { Chart } = await import('chart.js');\n```",
"RequireJS": "**Important:** RequireJS can load only [AMD modules](https://requirejs.org/docs/whyamd.html), so be sure to require one of the UMD builds instead (i.e. `dist/chart.umd.min.js`).\n\n```\nrequire(['path/to/chartjs/dist/chart.umd.min.js'], function(Chart){\n const myChart = new Chart(ctx, {...});\n});\n```\n\n:::tip Note\n\nIn order to use the time scale, you need to make sure [one of the available date adapters](https://github.com/chartjs/awesome#adapters) and corresponding date library are fully loaded **after** requiring Chart.js. For this you can use nested requires:\n\n```\nrequire(['chartjs'], function(Chart) {\n require(['moment'], function() {\n require(['chartjs-adapter-moment'], function() {\n new Chart(ctx, {...});\n });\n });\n});\n```\n\n:::"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 6, \"subpages\", 2]"
},
{
"title": "Step-by-step guide",
"description": null,
"content": {
"Build a new application with Chart.js": {
"Simple customizations": "Let\u2019s see how Chart.js charts can be customized. First, let\u2019s turn off the animations so the chart appears instantly. Second, let\u2019s hide the legend and tooltips since we have only one dataset and pretty trivial data.\n\nReplace the `new Chart(...);` invocation in `src/acquisitions.js` with the following snippet:\n\n```\n new Chart(\n document.getElementById('acquisitions'),\n {\n type: 'bar',\n options: {\n animation: false,\n plugins: {\n legend: {\n display: false\n },\n tooltip: {\n enabled: false\n }\n }\n },\n data: {\n labels: data.map(row => row.year),\n datasets: [\n {\n label: 'Acquisitions by year',\n data: data.map(row => row.count)\n }\n ]\n }\n }\n );\n```\n\nAs you can see, we\u2019ve added the `options` property to the second argument\u2014that\u2019s how you can specify all kinds of customization options for Chart.js. The [animation is disabled](../configuration/animations.md#disabling-animation) with a boolean flag provided via `animation`. Most chart-wide options (e.g., [responsiveness](../configuration/responsive.md) or [device pixel ratio](../configuration/device-pixel-ratio.md)) are configured like this.\n\nThe legend and tooltips are hidden with boolean flags provided under the respective sections in `plugins`. Note that some of Chart.js features are extracted into plugins: self-contained, separate pieces of code. A few of them are available as a part of [Chart.js distribution](https://github.com/chartjs/Chart.js/tree/master/src/plugins), other plugins are maintained independently and can be located in the [awesome list](https://github.com/chartjs/awesome) of plugins, framework integrations, and additional chart types.\n\nYou should be able to see the updated minimalistic chart in your browser.",
"Real-world data": "With hardcoded, limited-size, unrealistic data, it\u2019s hard to show the full potential of Chart.js. Let\u2019s quickly connect to a data API to make our example application closer to a production use case.\n\nLet\u2019s create the `src/api.js` file with the following contents:\n\n```\nimport { CubejsApi } from '@cubejs-client/core';\n\nconst apiUrl = 'https://heavy-lansford.gcp-us-central1.cubecloudapp.dev/cubejs-api/v1';\nconst cubeToken = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjEwMDAwMDAwMDAsImV4cCI6NTAwMDAwMDAwMH0.OHZOpOBVKr-sCwn8sbZ5UFsqI3uCs6e4omT7P6WVMFw';\n\nconst cubeApi = new CubejsApi(cubeToken, { apiUrl });\n\nexport async function getAquisitionsByYear() {\n const acquisitionsByYearQuery = {\n dimensions: [\n 'Artworks.yearAcquired',\n ],\n measures: [\n 'Artworks.count'\n ],\n filters: [ {\n member: 'Artworks.yearAcquired',\n operator: 'set'\n } ],\n order: {\n 'Artworks.yearAcquired': 'asc'\n }\n };\n\n const resultSet = await cubeApi.load(acquisitionsByYearQuery);\n\n return resultSet.tablePivot().map(row => ({\n year: parseInt(row['Artworks.yearAcquired']),\n count: parseInt(row['Artworks.count'])\n }));\n}\n\nexport async function getDimensions() {\n const dimensionsQuery = {\n dimensions: [\n 'Artworks.widthCm',\n 'Artworks.heightCm'\n ],\n measures: [\n 'Artworks.count'\n ],\n filters: [\n {\n member: 'Artworks.classification',\n operator: 'equals',\n values: [ 'Painting' ]\n },\n {\n member: 'Artworks.widthCm',\n operator: 'set'\n },\n {\n member: 'Artworks.widthCm',\n operator: 'lt',\n values: [ '500' ]\n },\n {\n member: 'Artworks.heightCm',\n operator: 'set'\n },\n {\n member: 'Artworks.heightCm',\n operator: 'lt',\n values: [ '500' ]\n }\n ]\n };\n\n const resultSet = await cubeApi.load(dimensionsQuery);\n\n return resultSet.tablePivot().map(row => ({\n width: parseInt(row['Artworks.widthCm']),\n height: parseInt(row['Artworks.heightCm']),\n count: parseInt(row['Artworks.count'])\n }));\n}\n```\n\nLet\u2019s see what\u2019s happening there:\n\n['We `import` the JavaScript client library for [Cube](https://cube.dev/?ref=eco-chartjs), an open-source API for data apps, configure it with the API URL (`apiUrl`) and the authentication token (`cubeToken`), and finally instantiate the client (`cubeApi`).', 'Cube API is hosted in [Cube Cloud](https://cube.dev/cloud/?ref=eco-chartjs) and connected to a database with a\\xa0[public dataset](https://github.com/MuseumofModernArt/collection)\\xa0of ~140,000 records representing all of the artworks in the collection of the [Museum of Modern Art](https://www.moma.org) in New York, USA. Certainly, a more real-world dataset than what we\u2019ve got now.', 'We define a couple of asynchronous functions to fetch data from the API: `getAquisitionsByYear` and `getDimensions`. The first one returns the number of artworks by the year of acquisition, the other returns the number of artworks for every width-height pair (we\u2019ll need it for another chart).', 'Let\u2019s take a look at `getAquisitionsByYear`. First, we create a declarative, JSON-based query in the `acquisitionsByYearQuery` variable. As you can see, we specify that for every `yearAcquired` we\u2019d like to get the `count` of artworks; `yearAcquired` has to be set (i.e., not undefined); the result set would be sorted by `yearAcquired` in the ascending order.', 'Second, we fetch the `resultSet` by calling `cubeApi.load` and map it to an array of objects with desired `year` and `count` properties.']\n\nNow, let\u2019s deliver the real-world data to our chart. Please apply a couple of changes to `src/acquisitions.js`: add an import and replace the definition of the `data` variable.\n\n```\nimport { getAquisitionsByYear } from './api'\n\n// ...\n\nconst data = await getAquisitionsByYear();\n```\n\nDone! Now, our chart with real-world data looks like this. Looks like something interesting happened in 1964, 1968, and 2008!\n\n\n\nWe\u2019re done with the bar chart. Let\u2019s try another Chart.js chart type.",
"Further customizations": "Chart.js supports many common chart types.\n\nFor instance, [Bubble chart](../charts/bubble.md) allows to display three dimensions of data at the same time: locations on `x` and `y` axes represent two dimensions, and the third dimension is represented by the size of the individual bubbles.\n\nTo create the chart, stop the already running application, then go to `src/index.html`, and uncomment the following two lines:\n\n```\n<div style=\"width: 500px;\"><canvas id=\"dimensions\"></canvas></div><br/>\n\n<script type=\"module\" src=\"dimensions.js\"></script>\n```\n\nThen, create the `src/dimensions.js` file with the following contents:\n\n```\nimport Chart from 'chart.js/auto'\nimport { getDimensions } from './api'\n\n(async function() {\n const data = await getDimensions();\n\n new Chart(\n document.getElementById('dimensions'),\n {\n type: 'bubble',\n data: {\n labels: data.map(x => x.year),\n datasets: [\n {\n label: 'Dimensions',\n data: data.map(row => ({\n x: row.width,\n y: row.height,\n r: row.count\n }))\n }\n ]\n }\n }\n );\n})();\n```\n\nProbably, everything is pretty straightforward there: we get data from the API and render a new chart with the `bubble` type, passing three dimensions of data as `x`, `y`, and `r` (radius) properties.\n\nNow, reset caches with `rm -rf .parcel-cache` and start the application again with `npm run dev`, `yarn dev`, or `pnpm dev`. We can review the new chart now:\n\n\n\nWell, it doesn\u2019t look pretty.\n\nFirst of all, the chart is not square. Artworks\u2019 width and height are equally important so we\u2019d like to make the chart width equal to its height as well. By default, Chart.js charts have the [aspect ratio](../configuration/responsive.md) of either 1 (for all radial charts, e.g., a doughnut chart) or 2 (for all the rest). Let\u2019s modify the aspect ratio for our chart:\n\n```\n// ...\n\n new Chart(\n document.getElementById('dimensions'),\n {\n type: 'bubble',\n options: {\n aspectRatio: 1,\n },\n\n// ...\n```\n\nLooks much better now:\n\n\n\nHowever, it\u2019s still not ideal. The horizontal axis spans from 0 to 500 while the vertical axis spans from 0 to 450. By default, Chart.js automatically adjusts the range (minimum and maximum values) of the axes to the values provided in the dataset, so the chart \u201cfits\u201d your data. Apparently, MoMa collection doesn\u2019t have artworks in the range of 450 to 500 cm in height. Let\u2019s modify the [axes configuration](../axes/) for our chart to account for that:\n\n```\n// ...\n\n new Chart(\n document.getElementById('dimensions'),\n {\n type: 'bubble',\n options: {\n aspectRatio: 1,\n scales: {\n x: {\n max: 500\n },\n y: {\n max: 500\n }\n }\n },\n\n// ...\n```\n\nGreat! Behold the updated chart:\n\n\n\nHowever, there\u2019s one more nitpick: what are these numbers? It\u2019s not very obvious that the units are centimetres. Let\u2019s apply a [custom tick format](../axes/labelling.md#creating-custom-tick-formats) to both axes to make things clear. We\u2019ll provide a callback function that would be called to format each tick value. Here\u2019s the updated axes configuration:\n\n```\n// ...\n\n new Chart(\n document.getElementById('dimensions'),\n {\n type: 'bubble',\n options: {\n aspectRatio: 1,\n scales: {\n x: {\n max: 500,\n ticks: {\n callback: value => `${value / 100} m`\n }\n },\n y: {\n max: 500,\n ticks: {\n callback: value => `${value / 100} m`\n }\n }\n }\n },\n\n// ...\n```\n\nPerfect, now we have proper units on both axes:\n\n",
"Multiple datasets": "Chart.js plots each dataset independently and allows to apply custom styles to them.\n\nTake a look at the chart: there\u2019s a visible \u201cline\u201d of bubbles with equal `x` and `y` coordinates representing square artworks. It would be cool to put these bubbles in their own dataset and paint them differently. Also, we can separate \u201ctaller\u201d artworks from \u201cwider\u201d ones and paint them differently, too. \n\nHere\u2019s how we can do that. Replace the `datasets` with the following code:\n\n```\n// ...\n\n datasets: [\n {\n label: 'width = height',\n data: data\n .filter(row => row.width === row.height)\n .map(row => ({\n x: row.width,\n y: row.height,\n r: row.count\n }))\n },\n {\n label: 'width > height',\n data: data\n .filter(row => row.width > row.height)\n .map(row => ({\n x: row.width,\n y: row.height,\n r: row.count\n }))\n },\n {\n label: 'width < height',\n data: data\n .filter(row => row.width < row.height)\n .map(row => ({\n x: row.width,\n y: row.height,\n r: row.count\n }))\n }\n ]\n\n// ..\n```\n\nAs you can see, we define three datasets with different labels. Each dataset gets its own slice of data extracted with `filter`. Now they are visually distinct and, as you already know, you can toggle their visibility independently.\n\n\n\nHere we rely on the default color palette. However, keep in mind every chart type supports a lot of [dataset options](../charts/bubble.md#dataset-properties) that you can feel free to customize.",
"Plugins": "Another\u2014and very powerful!\u2014way to customize Chart.js charts is to use plugins. You can find some in the [plugin directory](https://github.com/chartjs/awesome#plugins) or create your own, ad-hoc ones. In Chart.js ecosystem, it\u2019s idiomatic and expected to fine tune charts with plugins. For example, you can customize [canvas background](../configuration/canvas-background.md) or [add a border](../samples/plugins/chart-area-border.md) to it with simple ad-hoc plugins. Let\u2019s try the latter.\n\nPlugins have an [extensive API](../developers/plugins.md) but, in a nutshell, a plugin is defined as an object with a `name` and one or more callback functions defined in the extension points. Insert the following snippet before and in place of the `new Chart(...);` invocation in `src/dimensions.js`:\n\n```\n// ...\n\n const chartAreaBorder = {\n id: 'chartAreaBorder',\n\n beforeDraw(chart, args, options) {\n const { ctx, chartArea: { left, top, width, height } } = chart;\n\n ctx.save();\n ctx.strokeStyle = options.borderColor;\n ctx.lineWidth = options.borderWidth;\n ctx.setLineDash(options.borderDash || []);\n ctx.lineDashOffset = options.borderDashOffset;\n ctx.strokeRect(left, top, width, height);\n ctx.restore();\n }\n };\n\n new Chart(\n document.getElementById('dimensions'),\n {\n type: 'bubble',\n plugins: [ chartAreaBorder ],\n options: {\n plugins: {\n chartAreaBorder: {\n borderColor: 'red',\n borderWidth: 2,\n borderDash: [ 5, 5 ],\n borderDashOffset: 2,\n }\n },\n aspectRatio: 1,\n\n// ...\n```\n\nAs you can see, in this `chartAreaBorder` plugin, we acquire the canvas context, save its current state, apply styles, draw a rectangular shape around the chart area, and restore the canvas state. We\u2019re also passing the plugin in `plugins` so it\u2019s only applied to this particular chart. We also pass the plugin options in `options.plugins.chartAreaBorder`; we could surely hardcode them in the plugin source code but it\u2019s much more reusable this way.\n\nOur bubble chart looks fancier now:\n\n",
"Tree-shaking": "In production, we strive to ship as little code as possible, so the end users can load our data applications faster and have better experience. For that, we\u2019ll need to apply [tree-shaking](https://cube.dev/blog/how-to-build-tree-shakeable-javascript-libraries/?ref=eco-chartjs) which is fancy term for removing unused code from the JavaScript bundle.\n\nChart.js fully supports tree-shaking with its component design. You can register all Chart.js components at once (which is convenient when you\u2019re prototyping) and get them bundled with your application. Or, you can register only necessary components and get a minimal bundle, much less in size.\n\nLet\u2019s inspect our example application. What\u2019s the bundle size? You can stop the application and run `npm run build`, or `yarn build`, or `pnpm build`. In a few moments, you\u2019ll get something like this:\n\n```\n% yarn build\nyarn run v1.22.17\n$ parcel build src/index.html\n\u2728 Built in 88ms\n\ndist/index.html 381 B 164ms\ndist/index.74a47636.js 265.48 KB 1.25s\ndist/index.ba0c2e17.js 881 B 63ms\n\u2728 Done in 0.51s.\n```\n\nWe can see that Chart.js and other dependencies were bundled together in a single 265 KB file.\n\nTo reduce the bundle size, we\u2019ll need to apply a couple of changes to `src/acquisitions.js` and `src/dimensions.js`. First, we\u2019ll need to remove the following import statement from both files: `import Chart from 'chart.js/auto'`.\n\nInstead, let\u2019s load only necessary components and \u201cregister\u201d them with Chart.js using `Chart.register(...)`. Here\u2019s what we need in `src/acquisitions.js`:\n\n```\nimport {\n Chart,\n Colors,\n BarController,\n CategoryScale,\n LinearScale,\n BarElement,\n Legend\n} from 'chart.js'\n\nChart.register(\n Colors,\n BarController,\n BarElement,\n CategoryScale,\n LinearScale,\n Legend\n);\n```\n\nAnd here\u2019s the snippet for `src/dimensions.js`:\n\n```\nimport {\n Chart,\n Colors,\n BubbleController,\n CategoryScale,\n LinearScale,\n PointElement,\n Legend\n} from 'chart.js'\n\nChart.register(\n Colors,\n BubbleController,\n PointElement,\n CategoryScale,\n LinearScale,\n Legend\n);\n```\n\nYou can see that, in addition to the `Chart` class, we\u2019re also loading a controller for the chart type, scales, and other chart elements (e.g., bars or points). You can look all available components up in the [documentation](./integration.md#bundle-optimization).\n\nAlternatively, you can follow Chart.js advice in the console. For example, if you forget to import `BarController` for your bar chart, you\u2019ll see the following message in the browser console:\n\n```\nUnhandled Promise Rejection: Error: \"bar\" is not a registered controller.\n```\n\nRemember to carefully check for imports from `chart.js/auto` when preparing your application for production. It takes only one import like this to effectively disable tree-shaking.\n\nNow, let\u2019s inspect our application once again. Run `yarn build` and you\u2019ll get something like this:\n\n```\n% yarn build\nyarn run v1.22.17\n$ parcel build src/index.html\n\u2728 Built in 88ms\n\ndist/index.html 381 B 176ms\ndist/index.5888047.js 208.66 KB 1.23s\ndist/index.dcb2e865.js 932 B 58ms\n\u2728 Done in 0.51s.\n```\n\nBy importing and registering only select components, we\u2019ve removed more than 56 KB of unnecessary code. Given that other dependencies take ~50 KB in the bundle, tree-shaking helps remove ~25% of Chart.js code from the bundle for our example application. "
},
"Next steps": "Now you\u2019re familiar with all major concepts of Chart.js: chart types and elements, datasets, customization, plugins, components, and tree-shaking.\n\nFeel free to review many [examples of charts](../samples/information.md) in the documentation and check the [awesome list](https://github.com/chartjs/awesome) of Chart.js plugins and additional chart types as well as [framework integrations](https://github.com/chartjs/awesome#integrations) (e.g., React, Vue, Svelte, etc.). Also, don\u2019t hesitate to join [Chart.js Discord](https://discord.gg/HxEguTK6av) and follow [Chart.js on Twitter](https://twitter.com/chartjs).\n\nHave fun and good luck building with Chart.js!"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 6, \"subpages\", 3]"
},
{
"title": "Using From Node Js",
"description": null,
"content": {
"Using from Node.js": "You can use Chart.js in Node.js for server-side generation of plots with help from an NPM package such as [node-canvas](https://github.com/Automattic/node-canvas) or [skia-canvas](https://skia-canvas.org/).\n\nSample usage:\n\n```\nimport {CategoryScale, Chart, LinearScale, LineController, LineElement, PointElement} from 'chart.js';\nimport {Canvas} from 'skia-canvas';\nimport fsp from 'node:fs/promises';\n\nChart.register([\n CategoryScale,\n LineController,\n LineElement,\n LinearScale,\n PointElement\n]);\n\nconst canvas = new Canvas(400, 300);\nconst chart = new Chart(\n canvas, // TypeScript needs \"as any\" here\n {\n type: 'line',\n data: {\n labels: ['Red', 'Blue', 'Yellow', 'Green', 'Purple', 'Orange'],\n datasets: [{\n label: '# of Votes',\n data: [12, 19, 3, 5, 2, 3],\n borderColor: 'red'\n }]\n }\n }\n);\nconst pngBuffer = await canvas.toBuffer('png', {matte: 'white'});\nawait fsp.writeFile('output.png', pngBuffer);\nchart.destroy();\n```"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 6, \"subpages\", 4]"
}
],
"path": "[\"subpages\", 6]"
},
{
"title": "Migration",
"description": "Documentation section: migration",
"content": {},
"metadata": {
"type": "directory",
"path": "/home/anhnh/CodeWikiBench/data/Chart.js/original/docs/migration"
},
"subpages": [
{
"title": "3.x Migration Guide",
"description": null,
"content": {
"End user migration": {
"Setup and installation": [
"Distributed files are now in lower case. For example: `dist/chart.js`.",
"Chart.js is no longer providing the `Chart.bundle.js` and `Chart.bundle.min.js`. Please see the [installation](../getting-started/installation.md) and [integration](../getting-started/integration.md) docs for details on the recommended way to setup Chart.js if you were using these builds.",
"`moment` is no longer specified as an npm dependency. If you are using the `time` or `timeseries` scales, you must include one of [the available adapters](https://github.com/chartjs/awesome#adapters) and corresponding date library. You no longer need to exclude moment from your build.",
"The `Chart` constructor will throw an error if the canvas/context provided is already in use",
"Chart.js 3 is tree-shakeable. So if you are using it as an `npm` module in a project and want to make use of this feature, you need to import and register the controllers, elements, scales and plugins you want to use, for a list of all the available items to import see [integration](../getting-started/integration.md#bundlers-webpack-rollup-etc). You will not have to call `register` if importing Chart.js via a `script` tag or from the [`auto`](../getting-started/integration.md#bundlers-webpack-rollup-etc) register path as an `npm` module, in this case you will not get the tree shaking benefits. Here is an example of registering components:"
],
"Chart types": [
"`horizontalBar` chart type was removed. Horizontal bar charts can be configured using the new [`indexAxis`](../charts/bar.md#horizontal-bar-chart) option"
],
"Options": {
"Generic changes": [
"Indexable options are now looping. `backgroundColor: ['red', 'green']` will result in alternating `'red'` / `'green'` if there are more than 2 data points.",
"The input properties of object data can now be freely specified, see [data structures](../general/data-structures.md) for details.",
"Most options are resolved utilizing proxies, instead of merging with defaults. In addition to easily enabling different resolution routes for different contexts, it allows using other resolved options in scriptable options.",
[
"Options are by default scriptable and indexable, unless disabled for some reason.",
"Scriptable options receive a option resolver as second parameter for accessing other options in same context.",
"Resolution falls to upper scopes, if no match is found earlier. See [options](../general/options.md) for details."
]
],
"Specific changes": [
"`elements.rectangle` is now `elements.bar`",
"`hover.animationDuration` is now configured in `animation.active.duration`",
"`responsiveAnimationDuration` is now configured in `animation.resize.duration`",
"Polar area `elements.arc.angle` is now configured in degrees instead of radians.",
"Polar area `startAngle` option is now consistent with `Radar`, 0 is at top and value is in degrees. Default is changed from `-\u00bd\u03c0` to `0`.",
"Doughnut `rotation` option is now in degrees and 0 is at top. Default is changed from `-\u00bd\u03c0` to `0`.",
"Doughnut `circumference` option is now in degrees. Default is changed from `2\u03c0` to `360`.",
"Doughnut `cutoutPercentage` was renamed to `cutout`and accepts pixels as number and percent as string ending with `%`.",
"`scale` option was removed in favor of `options.scales.r` (or any other scale id, with `axis: 'r'`)",
"`scales.[x/y]Axes` arrays were removed. Scales are now configured directly to `options.scales` object with the object key being the scale Id.",
"`scales.[x/y]Axes.barPercentage` was moved to dataset option `barPercentage`",
"`scales.[x/y]Axes.barThickness` was moved to dataset option `barThickness`",
"`scales.[x/y]Axes.categoryPercentage` was moved to dataset option `categoryPercentage`",
"`scales.[x/y]Axes.maxBarThickness` was moved to dataset option `maxBarThickness`",
"`scales.[x/y]Axes.minBarLength` was moved to dataset option `minBarLength`",
"`scales.[x/y]Axes.scaleLabel` was renamed to `scales[id].title`",
"`scales.[x/y]Axes.scaleLabel.labelString` was renamed to `scales[id].title.text`",
"`scales.[x/y]Axes.ticks.beginAtZero` was renamed to `scales[id].beginAtZero`",
"`scales.[x/y]Axes.ticks.max` was renamed to `scales[id].max`",
"`scales.[x/y]Axes.ticks.min` was renamed to `scales[id].min`",
"`scales.[x/y]Axes.ticks.reverse` was renamed to `scales[id].reverse`",
"`scales.[x/y]Axes.ticks.suggestedMax` was renamed to `scales[id].suggestedMax`",
"`scales.[x/y]Axes.ticks.suggestedMin` was renamed to `scales[id].suggestedMin`",
"`scales.[x/y]Axes.ticks.unitStepSize` was removed. Use `scales[id].ticks.stepSize`",
"`scales.[x/y]Axes.ticks.userCallback` was renamed to `scales[id].ticks.callback`",
"`scales.[x/y]Axes.time.format` was renamed to `scales[id].time.parser`",
"`scales.[x/y]Axes.time.max` was renamed to `scales[id].max`",
"`scales.[x/y]Axes.time.min` was renamed to `scales[id].min`",
"`scales.[x/y]Axes.zeroLine*` options of axes were removed. Use scriptable scale options instead.",
"The dataset option `steppedLine` was removed. Use `stepped`",
"The chart option `showLines` was renamed to `showLine` to match the dataset option.",
"The chart option `startAngle` was moved to `radial` scale options.",
"To override the platform class used in a chart instance, pass `platform: PlatformClass` in the config object. Note that the class should be passed, not an instance of the class.",
"`aspectRatio` defaults to 1 for doughnut, pie, polarArea, and radar charts",
"`TimeScale` does not read `t` from object data by default anymore. The default property is `x` or `y`, depending on the orientation. See [data structures](../general/data-structures.md) for details on how to change the default.",
"`tooltips` namespace was renamed to `tooltip` to match the plugin name",
"`legend`, `title` and `tooltip` namespaces were moved from `options` to `options.plugins`.",
"`tooltips.custom` was renamed to `plugins.tooltip.external`"
],
"Defaults": [
"`global` namespace was removed from `defaults`. So `Chart.defaults.global` is now `Chart.defaults`",
"Dataset controller defaults were relocate to `overrides`. For example `Chart.defaults.line` is now `Chart.overrides.line`",
"`default` prefix was removed from defaults. For example `Chart.defaults.global.defaultColor` is now `Chart.defaults.color`",
"`defaultColor` was split to `color`, `borderColor` and `backgroundColor`",
"`defaultFontColor` was renamed to `color`",
"`defaultFontFamily` was renamed to `font.family`",
"`defaultFontSize` was renamed to `font.size`",
"`defaultFontStyle` was renamed to `font.style`",
"`defaultLineHeight` was renamed to `font.lineHeight`",
"Horizontal Bar default tooltip mode was changed from `'index'` to `'nearest'` to match vertical bar charts",
"`legend`, `title` and `tooltip` namespaces were moved from `Chart.defaults` to `Chart.defaults.plugins`.",
"`elements.line.fill` default changed from `true` to `false`.",
"Line charts no longer override the default `interaction` mode. Default is changed from `'index'` to `'nearest'`."
],
"Scales": "The configuration options for scales is the largest change in v3. The `xAxes` and `yAxes` arrays were removed and axis options are individual scales now keyed by scale ID.\n\nThe v2 configuration below is shown with it's new v3 configuration\n\n```\noptions: {\n scales: {\n xAxes: [{\n id: 'x',\n type: 'time',\n display: true,\n title: {\n display: true,\n text: 'Date'\n },\n ticks: {\n major: {\n enabled: true\n },\n font: function(context) {\n if (context.tick && context.tick.major) {\n return {\n weight: 'bold',\n color: '#FF0000'\n };\n }\n }\n }\n }],\n yAxes: [{\n id: 'y',\n display: true,\n title: {\n display: true,\n text: 'value'\n }\n }]\n }\n}\n```\n\nAnd now, in v3:\n\n```\noptions: {\n scales: {\n x: {\n type: 'time',\n display: true,\n title: {\n display: true,\n text: 'Date'\n },\n ticks: {\n major: {\n enabled: true\n },\n color: (context) => context.tick && context.tick.major && '#FF0000',\n font: function(context) {\n if (context.tick && context.tick.major) {\n return {\n weight: 'bold'\n };\n }\n }\n }\n },\n y: {\n display: true,\n title: {\n display: true,\n text: 'value'\n }\n }\n }\n}\n```\n\n[\"The time scale option `distribution: 'series'` was removed and a new scale type `timeseries` was introduced in its place\", 'In the time scale, `autoSkip` is now enabled by default for consistency with the other scales']",
"Animations": "Animation system was completely rewritten in Chart.js v3. Each property can now be animated separately. Please see [animations](../configuration/animations.md) docs for details.",
"Customizability": [
"`custom` attribute of elements was removed. Please use scriptable options",
"The `hover` property of scriptable options `context` object was renamed to `active` to align it with the datalabels plugin."
],
"Interactions": [
"To allow DRY configuration, a root options scope for common interaction options was added. `options.hover` and `options.plugins.tooltip` now both extend from `options.interaction`. Defaults are defined at `defaults.interaction` level, so by default hover and tooltip interactions share the same mode etc.",
"`interactions` are now limited to the chart area + allowed overflow",
"`{mode: 'label'}` was replaced with `{mode: 'index'}`",
"`{mode: 'single'}` was replaced with `{mode: 'nearest', intersect: true}`",
"`modes['X-axis']` was replaced with `{mode: 'index', intersect: false}`",
"`options.onClick` is now limited to the chart area",
"`options.onClick` and `options.onHover` now receive the `chart` instance as a 3rd argument",
"`options.onHover` now receives a wrapped `event` as the first parameter. The previous first parameter value is accessible via `event.native`.",
"`options.hover.onHover` was removed, use `options.onHover`."
],
"Ticks": [
"`options.gridLines` was renamed to `options.grid`",
"`options.gridLines.offsetGridLines` was renamed to `options.grid.offset`.",
"`options.gridLines.tickMarkLength` was renamed to `options.grid.tickLength`.",
"`options.ticks.fixedStepSize` is no longer used. Use `options.ticks.stepSize`.",
"`options.ticks.major` and `options.ticks.minor` were replaced with scriptable options for tick fonts.",
"`Chart.Ticks.formatters.linear` was renamed to `Chart.Ticks.formatters.numeric`.",
"`options.ticks.backdropPaddingX` and `options.ticks.backdropPaddingY` were replaced with `options.ticks.backdropPadding` in the radial linear scale."
],
"Tooltip": [
"`xLabel` and `yLabel` were removed. Please use `label` and `formattedValue`",
"The `filter` option will now be passed additional parameters when called and should have the method signature `function(tooltipItem, index, tooltipItems, data)`",
"The `custom` callback now takes a context object that has `tooltip` and `chart` properties",
"All properties of tooltip model related to the tooltip options have been moved to reside within the `options` property.",
"The callbacks no longer are given a `data` parameter. The tooltip item parameter contains the chart and dataset instead",
"The tooltip item's `index` parameter was renamed to `dataIndex` and `value` was renamed to `formattedValue`",
"The `xPadding` and `yPadding` options were merged into a single `padding` object"
]
}
},
"Developer migration": {
"Removed": {
"Removed from Chart": [
"`Chart.animationService`",
"`Chart.active`",
"`Chart.borderWidth`",
"`Chart.chart.chart`",
"`Chart.Bar`. New charts are created via `new Chart` and providing the appropriate `type` parameter",
"`Chart.Bubble`. New charts are created via `new Chart` and providing the appropriate `type` parameter",
"`Chart.Chart`",
"`Chart.Controller`",
"`Chart.Doughnut`. New charts are created via `new Chart` and providing the appropriate `type` parameter",
"`Chart.innerRadius` now lives on doughnut, pie, and polarArea controllers",
"`Chart.lastActive`",
"`Chart.Legend` was moved to `Chart.plugins.legend._element` and made private",
"`Chart.Line`. New charts are created via `new Chart` and providing the appropriate `type` parameter",
"`Chart.LinearScaleBase` now must be imported and cannot be accessed off the `Chart` object",
"`Chart.offsetX`",
"`Chart.offsetY`",
"`Chart.outerRadius` now lives on doughnut, pie, and polarArea controllers",
"`Chart.plugins` was replaced with `Chart.registry`. Plugin defaults are now in `Chart.defaults.plugins[id]`.",
"`Chart.plugins.register` was replaced by `Chart.register`.",
"`Chart.PolarArea`. New charts are created via `new Chart` and providing the appropriate `type` parameter",
"`Chart.prototype.generateLegend`",
"`Chart.platform`. It only contained `disableCSSInjection`. CSS is never injected in v3.",
"`Chart.PluginBase`",
"`Chart.Radar`. New charts are created via `new Chart` and providing the appropriate `type` parameter",
"`Chart.radiusLength`",
"`Chart.scaleService` was replaced with `Chart.registry`. Scale defaults are now in `Chart.defaults.scales[type]`.",
"`Chart.Scatter`. New charts are created via `new Chart` and providing the appropriate `type` parameter",
"`Chart.types`",
"`Chart.Title` was moved to `Chart.plugins.title._element` and made private",
"`Chart.Tooltip` is now provided by the tooltip plugin. The positioners can be accessed from `tooltipPlugin.positioners`",
"`ILayoutItem.minSize`"
],
"Removed from Dataset Controllers": [
"`BarController.getDatasetMeta().bar`",
"`DatasetController.addElementAndReset`",
"`DatasetController.createMetaData`",
"`DatasetController.createMetaDataset`",
"`DoughnutController.getRingIndex`"
],
"Removed from Elements": [
"`Element.getArea`",
"`Element.height`",
"`Element.hidden` was replaced by chart level status, usable with `getDataVisibility(index)` / `toggleDataVisibility(index)`",
"`Element.initialize`",
"`Element.inLabelRange`",
"`Line.calculatePointY`"
],
"Removed from Helpers": [
"`helpers.addEvent`",
"`helpers.aliasPixel`",
"`helpers.arrayEquals`",
"`helpers.configMerge`",
"`helpers.findIndex`",
"`helpers.findNextWhere`",
"`helpers.findPreviousWhere`",
"`helpers.extend`. Use `Object.assign` instead",
"`helpers.getValueAtIndexOrDefault`. Use `helpers.resolve` instead.",
"`helpers.indexOf`",
"`helpers.lineTo`",
"`helpers.longestText` was made private",
"`helpers.max`",
"`helpers.measureText` was made private",
"`helpers.min`",
"`helpers.nextItem`",
"`helpers.niceNum`",
"`helpers.numberOfLabelLines`",
"`helpers.previousItem`",
"`helpers.removeEvent`",
"`helpers.roundedRect`",
"`helpers.scaleMerge`",
"`helpers.where`"
],
"Removed from Layout": [
"`Layout.defaults`"
],
"Removed from Scales": [
"`LinearScaleBase.handleDirectionalChanges`",
"`LogarithmicScale.minNotZero`",
"`Scale.getRightValue`",
"`Scale.longestLabelWidth`",
"`Scale.longestTextCache` is now private",
"`Scale.margins` is now private",
"`Scale.mergeTicksOptions`",
"`Scale.ticksAsNumbers`",
"`Scale.tickValues` is now private",
"`TimeScale.getLabelCapacity` is now private",
"`TimeScale.tickFormatFunction` is now private"
],
"Removed from Plugins (Legend, Title, and Tooltip)": [
"`IPlugin.afterScaleUpdate`. Use `afterLayout` instead",
"`Legend.margins` is now private",
"Legend `onClick`, `onHover`, and `onLeave` options now receive the legend as the 3rd argument in addition to implicitly via `this`",
"Legend `onClick`, `onHover`, and `onLeave` options now receive a wrapped `event` as the first parameter. The previous first parameter value is accessible via `event.native`.",
"`Title.margins` is now private",
"The tooltip item's `x` and `y` attributes were replaced by `element`. You can use `element.x` and `element.y` or `element.tooltipPosition()` instead."
],
"Removal of Public APIs": "The following public APIs were removed.\n\n[\"`getElementAtEvent` is replaced with `chart.getElementsAtEventForMode(e, 'nearest', { intersect: true }, false)`\", \"`getElementsAtEvent` is replaced with `chart.getElementsAtEventForMode(e, 'index', { intersect: true }, false)`\", \"`getElementsAtXAxis` is replaced with `chart.getElementsAtEventForMode(e, 'index', { intersect: false }, false)`\", \"`getDatasetAtEvent` is replaced with `chart.getElementsAtEventForMode(e, 'dataset', { intersect: true }, false)`\"]",
"Removal of private APIs": "The following private APIs were removed.\n\n['`Chart._bufferedRender`', '`Chart._updating`', '`Chart.data.datasets[datasetIndex]._meta`', '`DatasetController._getIndexScaleId`', '`DatasetController._getIndexScale`', '`DatasetController._getValueScaleId`', '`DatasetController._getValueScale`', '`Element._ctx`', '`Element._model`', '`Element._view`', '`LogarithmicScale._valueOffset`', '`TimeScale.getPixelForOffset`', '`TimeScale.getLabelWidth`', '`Tooltip._lastActive`']"
},
"Renamed": {
"Renamed private APIs": "The private APIs listed below were renamed:\n\n['`BarController.calculateBarIndexPixels` was renamed to `BarController._calculateBarIndexPixels`', '`BarController.calculateBarValuePixels` was renamed to `BarController._calculateBarValuePixels`', '`BarController.getStackCount` was renamed to `BarController._getStackCount`', '`BarController.getStackIndex` was renamed to `BarController._getStackIndex`', '`BarController.getRuler` was renamed to `BarController._getRuler`', '`Chart.destroyDatasetMeta` was renamed to `Chart._destroyDatasetMeta`', '`Chart.drawDataset` was renamed to `Chart._drawDataset`', '`Chart.drawDatasets` was renamed to `Chart._drawDatasets`', '`Chart.eventHandler` was renamed to `Chart._eventHandler`', '`Chart.handleEvent` was renamed to `Chart._handleEvent`', '`Chart.initialize` was renamed to `Chart._initialize`', '`Chart.resetElements` was renamed to `Chart._resetElements`', '`Chart.unbindEvents` was renamed to `Chart._unbindEvents`', '`Chart.updateDataset` was renamed to `Chart._updateDataset`', '`Chart.updateDatasets` was renamed to `Chart._updateDatasets`', '`Chart.updateLayout` was renamed to `Chart._updateLayout`', '`DatasetController.destroy` was renamed to `DatasetController._destroy`', '`DatasetController.insertElements` was renamed to `DatasetController._insertElements`', '`DatasetController.onDataPop` was renamed to `DatasetController._onDataPop`', '`DatasetController.onDataPush` was renamed to `DatasetController._onDataPush`', '`DatasetController.onDataShift` was renamed to `DatasetController._onDataShift`', '`DatasetController.onDataSplice` was renamed to `DatasetController._onDataSplice`', '`DatasetController.onDataUnshift` was renamed to `DatasetController._onDataUnshift`', '`DatasetController.removeElements` was renamed to `DatasetController._removeElements`', '`DatasetController.resyncElements` was renamed to `DatasetController._resyncElements`', '`LayoutItem.isFullWidth` was renamed to `LayoutItem.isFullSize`', '`RadialLinearScale.setReductions` was renamed to `RadialLinearScale._setReductions`', '`RadialLinearScale.pointLabels` was renamed to `RadialLinearScale._pointLabels`', '`Scale.handleMargins` was renamed to `Scale._handleMargins`']"
},
"Changed": {
"Changed in Scales": {
"Changed in Ticks": [
"`Scale.afterBuildTicks` now has no parameters like the other callbacks",
"`Scale.buildTicks` is now expected to return tick objects",
"`Scale.convertTicksToLabels` was renamed to `generateTickLabels`. It is now expected to set the label property on the ticks given as input",
"`Scale.ticks` now contains objects instead of strings",
"When the `autoSkip` option is enabled, `Scale.ticks` now contains only the non-skipped ticks instead of all ticks.",
"Ticks are now always generated in monotonically increasing order"
],
"Changed in Time Scale": [
"`getValueForPixel` now returns milliseconds since the epoch"
]
},
"Changed in Controllers": {
"Core Controller": [
"The first parameter to `updateHoverStyle` is now an array of objects containing the `element`, `datasetIndex`, and `index`",
"The signature or `resize` changed, the first `silent` parameter was removed."
],
"Dataset Controllers": [
"`updateElement` was replaced with `updateElements` now taking the elements to update, the `start` index, `count`, and `mode`",
"`setHoverStyle` and `removeHoverStyle` now additionally take the `datasetIndex` and `index`"
]
},
"Changed in Interactions": [
"Interaction mode methods now return an array of objects containing the `element`, `datasetIndex`, and `index`"
],
"Changed in Layout": [
"`ILayoutItem.update` no longer has a return value"
],
"Changed in Helpers": {
"Canvas Helper": [
"The second parameter to `drawPoint` is now the full options object, so `style`, `rotation`, and `radius` are no longer passed explicitly",
"`helpers.getMaximumHeight` was replaced by `helpers.dom.getMaximumSize`",
"`helpers.getMaximumWidth` was replaced by `helpers.dom.getMaximumSize`",
"`helpers.clear` was renamed to `helpers.clearCanvas` and now takes `canvas` and optionally `ctx` as parameter(s).",
"`helpers.retinaScale` accepts optional third parameter `forceStyle`, which forces overriding current canvas style. `forceRatio` no longer falls back to `window.devicePixelRatio`, instead it defaults to `1`."
]
},
"Changed in Platform": [
"`Chart.platform` is no longer the platform object used by charts. Every chart instance now has a separate platform instance.",
"`Chart.platforms` is an object that contains two usable platform classes, `BasicPlatform` and `DomPlatform`. It also contains `BasePlatform`, a class that all platforms must extend from.",
"If the canvas passed in is an instance of `OffscreenCanvas`, the `BasicPlatform` is automatically used.",
"`isAttached` method was added to platform."
],
"Changed in IPlugin interface": [
"All plugin hooks have unified signature with 3 arguments: `chart`, `args` and `options`. This means change in signature for these hooks: `beforeInit`, `afterInit`, `reset`, `beforeLayout`, `afterLayout`, `beforeRender`, `afterRender`, `beforeDraw`, `afterDraw`, `beforeDatasetsDraw`, `afterDatasetsDraw`, `beforeEvent`, `afterEvent`, `resize`, `destroy`.",
"`afterDatasetsUpdate`, `afterUpdate`, `beforeDatasetsUpdate`, and `beforeUpdate` now receive `args` object as second argument. `options` argument is always the last and thus was moved from 2nd to 3rd place.",
"`afterEvent` and `beforeEvent` now receive a wrapped `event` as the `event` property of the second argument. The native event is available via `args.event.native`.",
"Initial `resize` is no longer silent. Meaning that `resize` event can fire between `beforeInit` and `afterInit`",
"New hooks: `install`, `start`, `stop`, and `uninstall`",
"`afterEvent` should notify about changes that need a render by setting `args.changed` to true. Because the `args` are shared with all plugins, it should only be set to true and not false."
]
}
}
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 7, \"subpages\", 0]"
},
{
"title": "4.x Migration Guide",
"description": null,
"content": {
"End user migration": {
"Charts": [
"Charts don't override the default tooltip callbacks, so all chart types have the same-looking tooltips.",
"Default scale override has been removed if the configured scale starts with `x`/`y`. Defining `xAxes` in your config will now create a second scale instead of overriding the default `x` axis."
],
"Options": {
"Specific changes": [
"The radialLinear grid indexable and scriptable options don't decrease the index of the specified grid line anymore.",
"The `destroy` plugin hook has been removed and replaced with `afterDestroy`.",
"Ticks callback on time scale now receives timestamp instead of a formatted label.",
"`scales[id].grid.drawBorder` has been renamed to `scales[id].border.display`.",
"`scales[id].grid.borderWidth` has been renamed to `scales[id].border.width`.",
"`scales[id].grid.borderColor` has been renamed to `scales[id].border.color`.",
"`scales[id].grid.borderDash` has been renamed to `scales[id].border.dash`.",
"`scales[id].grid.borderDashOffset` has been renamed to `scales[id].border.dashOffset`.",
"The z index for the border of a scale is now configurable instead of being 1 higher as the grid z index.",
"Linear scales now add and subtracts `5%` of the max value to the range if the min and max are the same instead of `1`.",
"If the tooltip callback returns `undefined`, then the default callback will be used.",
"`maintainAspectRatio` respects container height.",
"Time and timeseries scales use `ticks.stepSize` instead of `time.stepSize`, which has been removed.",
"`maxTickslimit` won't be used for the ticks in `autoSkip` if the determined max ticks is less then the `maxTicksLimit`.",
"`dist/chart.js` has been removed.",
"`dist/chart.min.js` has been renamed to `dist/chart.umd.min.js` (and before 4.5.0 `dist/chart.umd.js`).",
"`dist/chart.esm.js` has been renamed to `dist/chart.js`."
],
"Type changes": [
"The order of the `ChartMeta` parameters have been changed from `<Element, DatasetElement, Type>` to `<Type, Element, DatasetElement>`."
]
},
"General": [
"Chart.js becomes an [ESM-only package](https://nodejs.org/api/esm.html) ([the UMD bundle is still available](../getting-started/installation.md#cdn)). To use Chart.js, your project should also be an ES module. Make sure to have this in your `package.json`:",
"```\n{\n \"type\": \"module\"\n}\n```",
"If you are experiencing problems with [Jest](https://jestjs.io), follow its [documentation](https://jestjs.io/docs/ecmascript-modules) to enable the ESM support. Or, we can recommend you migrating to [Vitest](https://vitest.dev/). Vitest has the ESM support out of the box and [almost the same API as Jest](https://vitest.dev/guide/migration.html#migrating-from-jest). See an [example of migration](https://github.com/reactchartjs/react-chartjs-2/commit/7f3ec96101d21e43cae8cbfe5e09a46a17cff1ef).",
"Removed fallback to `fontColor` for the legend text and strikethrough color.",
"Removed `config._chart` fallback for `this.chart` in the filler plugin.",
"Removed `this._chart` in the filler plugin."
]
}
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 7, \"subpages\", 1]"
}
],
"path": "[\"subpages\", 7]"
},
{
"title": "Samples",
"description": "Documentation section: samples",
"content": {},
"metadata": {
"type": "directory",
"path": "/home/anhnh/CodeWikiBench/data/Chart.js/original/docs/samples"
},
"subpages": [
{
"title": "Chart.js Samples",
"description": null,
"content": {
"Out of the box working samples": "These samples are made for demonstration purposes only. They won't work out of the box if you copy paste them into your own website. This is because of how the docs are getting built. Some boilerplate code gets hidden.\nFor a sample that can be copied and pasted and used directly you can check the [usage page](../getting-started/usage.md).",
"Autogenerated data": "The data used in the samples is autogenerated using custom functions. These functions do not ship with the library, for more information about this you can check the [utils page](./utils.md).",
"Actions block": "The samples have an `actions` code block. These actions are not part of Chart.js. They are internally transformed to separate buttons together with `onClick` listeners by a plugin we use in the documentation. To implement such actions yourself you can make some buttons and add `onClick` event listeners to them. Then in these event listeners you can call your variable in which you made the chart and do the logic that the button is supposed to do."
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 0]"
},
{
"title": "Utils",
"description": null,
"content": {
"Disclaimer": "The Utils file contains multiple helper functions that the chart.js sample pages use to generate charts.\nThese functions are subject to change, including but not limited to breaking changes without prior notice.\n\nBecause of this please don't rely on this file in production environments.",
"Functions": "<<< @/scripts/utils.js\n\n[File on github](https://github.com/chartjs/Chart.js/blob/master/docs/scripts/utils.js)",
"Components": "Some of the samples make reference to a `components` object. This is an artifact of using a module bundler to build the samples. The creation of that components object is shown below. If chart.js is included as a browser script, these items are accessible via the `Chart` object, i.e `Chart.Tooltip`.\n\n<<< @/scripts/components.js\n\n[File on github](https://github.com/chartjs/Chart.js/blob/master/docs/scripts/components.js)"
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 1]"
},
{
"title": "Advanced",
"description": "Documentation section: advanced",
"content": {},
"metadata": {
"type": "directory",
"path": "/home/anhnh/CodeWikiBench/data/Chart.js/original/docs/samples/advanced"
},
"subpages": [
{
"title": "Data Decimation",
"description": null,
"content": {
"Docs": [
"[Data Decimation](../../configuration/decimation.md)",
"[Line](../../charts/line.md)",
"[Time Scale](../../axes/cartesian/time.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 2, \"subpages\", 0]"
},
{
"title": "Derived Axis Type",
"description": null,
"content": {
"Log2 axis implementation": "<<< @/scripts/log2.js",
"Docs": [
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Line](../../charts/line.md)",
"[New Axes](../../developers/axes.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 2, \"subpages\", 1]"
},
{
"title": "Derived Chart Type",
"description": null,
"content": {
"DerivedBubble Implementation": "<<< @/scripts/derived-bubble.js",
"Docs": [
"[Bubble Chart](../../charts/bubble.md)",
"[New Charts](../../developers/charts.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 2, \"subpages\", 2]"
},
{
"title": "Linear Gradient",
"description": null,
"content": {
"Docs": [
"[Colors](../../general/colors.md)",
[
"[Patterns and Gradients](../../general/colors.md#patterns-and-gradients) "
],
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Options](../../general/options.md)",
[
"[Scriptable Options](../../general/options.md#scriptable-options)"
],
"[Line](../../charts/line.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 2, \"subpages\", 3]"
},
{
"title": "Programmatic Event Triggers",
"description": null,
"content": {
"API": [
"[Chart](../../api/classes/Chart.md)",
[
"[`setActiveElements`](../../api/classes/Chart.md#setactiveelements)"
],
"[TooltipModel](../../api/interfaces/TooltipModel.md)",
[
"[`setActiveElements`](../../api/interfaces/TooltipModel.md#setactiveelements)"
]
],
"Docs": [
"[Bar](../../charts/bar.md)",
[
"[Interactions (`hoverBorderColor`)](../../charts/bar.md#interactions)"
],
"[Interactions](../../configuration/interactions.md)",
"[Tooltip](../../configuration/tooltip.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 2, \"subpages\", 4]"
},
{
"title": "Animation Progress Bar",
"description": null,
"content": {
"Initial animation": "<progress id=\"initialProgress\" max=\"1\" value=\"0\" style=\"width: 100%\"></progress>",
"Other animations": "<progress id=\"animationProgress\" max=\"1\" value=\"0\" style=\"width: 100%\"></progress>\n\n```\n// <block:actions:2>\nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: -100, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Dataset',\n handler(chart) {\n const data = chart.data;\n const dsColor = Utils.namedColor(chart.data.datasets.length);\n const newDataset = {\n label: 'Dataset ' + (data.datasets.length + 1),\n backgroundColor: Utils.transparentize(dsColor, 0.5),\n borderColor: dsColor,\n data: Utils.numbers({count: data.labels.length, min: -100, max: 100}),\n };\n chart.data.datasets.push(newDataset);\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const data = chart.data;\n if (data.datasets.length > 0) {\n data.labels = Utils.months({count: data.labels.length + 1});\n\n for (let index = 0; index < data.datasets.length; ++index) {\n data.datasets[index].data.push(Utils.rand(-100, 100));\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Dataset',\n handler(chart) {\n chart.data.datasets.pop();\n chart.update();\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.labels.splice(-1, 1); // remove the label first\n\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// </block:actions>\n\n// <block:setup:1>\nconst initProgress = document.getElementById('initialProgress');\nconst progress = document.getElementById('animationProgress');\n\nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n }\n ]\n};\n// </block:setup>\n\n// <block:config:0>\nconst config = {\n type: 'line',\n data: data,\n options: {\n animation: {\n duration: 2000,\n onProgress: function(context) {\n if (context.initial) {\n initProgress.value = context.currentStep / context.numSteps;\n } else {\n progress.value = context.currentStep / context.numSteps;\n }\n },\n onComplete: function(context) {\n if (context.initial) {\n console.log('Initial animation finished');\n } else {\n console.log('animation finished');\n }\n }\n },\n interaction: {\n mode: 'nearest',\n axis: 'x',\n intersect: false\n },\n plugins: {\n title: {\n display: true,\n text: 'Chart.js Line Chart - Animation Progress Bar'\n }\n },\n },\n};\n// </block:config>\n\nmodule.exports = {\n actions: actions,\n config: config,\n output: 'console.log output is displayed here'\n};\n```",
"Docs": [
"[Animations](../../configuration/animations.md)",
[
"[Animation Callbacks](../../configuration/animations.md#animation-callbacks)"
],
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Line](../../charts/line.md)",
"[Options](../../general/options.md)",
[
"[Scriptable Options](../../general/options.md#scriptable-options)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 2, \"subpages\", 5]"
},
{
"title": "Radial Gradient",
"description": null,
"content": {
"Docs": [
"[Polar Area Chart](../../charts/polar.md)",
[
"[Styling](../../charts/polar.md#styling)"
],
"[Options](../../general/options.md)",
[
"[Scriptable Options](../../general/options.md#scriptable-options)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 2, \"subpages\", 6]"
}
],
"path": "[\"subpages\", 8, \"subpages\", 2]"
},
{
"title": "Animations",
"description": "Documentation section: animations",
"content": {},
"metadata": {
"type": "directory",
"path": "/home/anhnh/CodeWikiBench/data/Chart.js/original/docs/samples/animations"
},
"subpages": [
{
"title": "Delay",
"description": null,
"content": {
"Docs": [
"[Animations](../../configuration/animations.md)",
[
"[animation (`delay`)](../../configuration/animations.md#animation)",
"[Animation Callbacks](../../configuration/animations.md#animation-callbacks)"
],
"[Bar](../../charts/bar.md)",
[
"[Stacked Bar Chart](../../charts/bar.md#stacked-bar-chart)"
],
"[Options](../../general/options.md)",
[
"[Scriptable Options](../../general/options.md#scriptable-options)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 3, \"subpages\", 0]"
},
{
"title": "Drop",
"description": null,
"content": {
"Docs": [
"[Area](../../charts/area.md)",
"[Animations](../../configuration/animations.md)",
[
"[animation (`easing`)](../../configuration/animations.md#animation)",
"[animations (`from`)](../../configuration/animations.md#animations-2)"
],
"[Line](../../charts/line.md)",
[
"[Line Styling](../../charts/line.md#line-styling)",
[
"`fill`",
"`tension`"
]
],
"[Options](../../general/options.md)",
[
"[Scriptable Options](../../general/options.md#scriptable-options)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 3, \"subpages\", 1]"
},
{
"title": "Loop",
"description": null,
"content": {
"Docs": [
"[Animations](../../configuration/animations.md)",
[
"[animation](../../configuration/animations.md#animation)",
[
"`duration`",
"`easing`",
"**`loop`**"
],
"[Default animations (`radius`)](../../configuration/animations.md#default-animations)"
],
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Elements](../../configuration/elements.md)",
[
"[Point Configuration](../../configuration/elements.md#point-configuration)",
[
"`hoverRadius`",
"`hoverBackgroundColor`"
]
],
"[Line](../../charts/line.md)",
"[Options](../../general/options.md)",
[
"[Scriptable Options](../../general/options.md#scriptable-options)"
],
"[Tooltip (`enabled`)](../../configuration/tooltip.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 3, \"subpages\", 2]"
},
{
"title": "Progressive Line With Easing",
"description": null,
"content": {
"Api ": [
"[Chart](../../api/classes/Chart.md)",
[
"[`getDatasetMeta`](../../api/classes/Chart.md#getdatasetmeta)"
],
"[Scale](../../api/classes/Scale.md)",
[
"[`getPixelForValue`](../../api/classes/Scale.md#getpixelforvalue)"
]
],
"Docs": [
"[Animations](../../configuration/animations.md)",
[
"[animation](../../configuration/animations.md#animation)",
[
"`delay`",
"`duration`",
"`easing`",
"`loop`"
],
"[Easing](../../configuration/animations.md#easing)"
],
"[Line](../../charts/line.md)",
"[Options](../../general/options.md)",
[
"[Scriptable Options](../../general/options.md#scriptable-options)",
[
"[Data Context](../../general/options.md#data)"
]
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 3, \"subpages\", 3]"
},
{
"title": "Progressive Line",
"description": null,
"content": {
"Api ": [
"[Chart](../../api/classes/Chart.md)",
[
"[`getDatasetMeta`](../../api/classes/Chart.md#getdatasetmeta)"
],
"[Scale](../../api/classes/Scale.md)",
[
"[`getPixelForValue`](../../api/classes/Scale.md#getpixelforvalue)"
]
],
"Docs": [
"[Animations](../../configuration/animations.md)",
[
"[animation](../../configuration/animations.md#animation)",
[
"`delay`",
"`duration`",
"`easing`",
"`loop`"
]
],
"[Line](../../charts/line.md)",
"[Options](../../general/options.md)",
[
"[Scriptable Options](../../general/options.md#scriptable-options)",
[
"[Data Context](../../general/options.md#data)"
]
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 3, \"subpages\", 4]"
}
],
"path": "[\"subpages\", 8, \"subpages\", 3]"
},
{
"title": "Area",
"description": "Documentation section: area",
"content": {},
"metadata": {
"type": "directory",
"path": "/home/anhnh/CodeWikiBench/data/Chart.js/original/docs/samples/area"
},
"subpages": [
{
"title": "Line Chart Boundaries",
"description": null,
"content": {
"Docs": [
"[Area](../../charts/area.md)",
[
"[Filling modes](../../charts/area.md#filling-modes)",
[
"Boundary: `'start'`, `'end'`, `'origin'`"
]
],
"[Line](../../charts/line.md)",
"[Data structures (`labels`)](../../general/data-structures.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 4, \"subpages\", 0]"
},
{
"title": "Line Chart Datasets",
"description": null,
"content": {
"Docs": [
"[Area](../../charts/area.md)",
[
"[Filling modes](../../charts/area.md#filling-modes)"
],
"[Line](../../charts/line.md)",
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Axes scales](../../axes/)",
[
"[Common options to all axes (`stacked`)](../../axes/#common-options-to-all-axes)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 4, \"subpages\", 1]"
},
{
"title": "Line Chart drawTime",
"description": null,
"content": {
"Docs": [
"[Area](../../charts/area.md)",
[
"[Configuration (`drawTime`)](../../charts/area.md#configuration)"
],
"[Line](../../charts/line.md)",
[
"[Line Styling (`tension`)](../../charts/line.md#line-styling)"
],
"[Data structures (`labels`)](../../general/data-structures.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 4, \"subpages\", 2]"
},
{
"title": "Line Chart Stacked",
"description": null,
"content": {
"Docs": [
"[Area](../../charts/area.md)",
[
"[Filling modes](../../charts/area.md#filling-modes)"
],
"[Line](../../charts/line.md)",
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Axes scales](../../axes/)",
[
"[Common options to all axes (`stacked`)](../../axes/#common-options-to-all-axes)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 4, \"subpages\", 3]"
},
{
"title": "Radar Chart Stacked",
"description": null,
"content": {
"Docs": [
"[Area](../../charts/area.md)",
[
"[Filling modes](../../charts/area.md#filling-modes)",
"[`propagate`](../../charts/area.md#propagate)"
],
"[Radar](../../charts/radar.md)",
"[Data structures (`labels`)](../../general/data-structures.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 4, \"subpages\", 4]"
}
],
"path": "[\"subpages\", 8, \"subpages\", 4]"
},
{
"title": "Bar",
"description": "Documentation section: bar",
"content": {},
"metadata": {
"type": "directory",
"path": "/home/anhnh/CodeWikiBench/data/Chart.js/original/docs/samples/bar"
},
"subpages": [
{
"title": "Bar Chart Border Radius",
"description": null,
"content": {
"Docs": [
"[Bar](../../charts/bar.md)",
[
"[`borderRadius`](../../charts/bar.md#borderradius)"
],
"[Data structures (`labels`)](../../general/data-structures.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 5, \"subpages\", 0]"
},
{
"title": "Floating Bars",
"description": null,
"content": {
"Docs": [
"[Bar](../../charts/bar.md)",
"[Data structures (`labels`)](../../general/data-structures.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 5, \"subpages\", 1]"
},
{
"title": "Horizontal Bar Chart",
"description": null,
"content": {
"Docs": [
"[Bar](../../charts/bar.md)",
[
"[Horizontal Bar Chart](../../charts/bar.md#horizontal-bar-chart)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 5, \"subpages\", 2]"
},
{
"title": "Stacked Bar Chart with Groups",
"description": null,
"content": {
"Docs": [
"[Bar](../../charts/bar.md)",
[
"[Stacked Bar Chart](../../charts/bar.md#stacked-bar-chart)"
],
"[Data structures (`labels`)](../../general/data-structures.md)",
[
"[Dataset Configuration (`stack`)](../../general/data-structures.md#dataset-configuration)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 5, \"subpages\", 3]"
},
{
"title": "Stacked Bar Chart",
"description": null,
"content": {
"Docs": [
"[Bar](../../charts/bar.md)",
[
"[Stacked Bar Chart](../../charts/bar.md#stacked-bar-chart)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 5, \"subpages\", 4]"
},
{
"title": "Vertical Bar Chart",
"description": null,
"content": {
"Docs": [
"[Bar](../../charts/bar.md)",
"[Data structures (`labels`)](../../general/data-structures.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 5, \"subpages\", 5]"
}
],
"path": "[\"subpages\", 8, \"subpages\", 5]"
},
{
"title": "Legend",
"description": "Documentation section: legend",
"content": {},
"metadata": {
"type": "directory",
"path": "/home/anhnh/CodeWikiBench/data/Chart.js/original/docs/samples/legend"
},
"subpages": [
{
"title": "Events",
"description": null,
"content": {
"Docs": [
"[Doughnut and Pie Charts](../../charts/doughnut.md)",
"[Legend](../../configuration/legend.md)",
[
"`onHover`",
"`onLeave`"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 6, \"subpages\", 0]"
},
{
"title": "HTML Legend",
"description": null,
"content": {
"Docs ": [
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Line](../../charts/line.md)",
"[Legend](../../configuration/legend.md)",
[
"`display: false`"
],
"[Plugins](../../developers/plugins.md) "
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 6, \"subpages\", 1]"
},
{
"title": "Point Style",
"description": null,
"content": {
"Docs ": [
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Line](../../charts/line.md)",
"[Legend](../../configuration/legend.md)",
[
"[Legend Label Configuration](../../configuration/legend.md#legend-label-configuration)",
[
"`usePointStyle`"
]
],
"[Elements](../../configuration/elements.md)",
[
"[Point Configuration](../../configuration/elements.md#point-configuration)",
"[Point Styles](../../configuration/elements.md#point-styles)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 6, \"subpages\", 2]"
},
{
"title": "Position",
"description": null,
"content": {
"Docs ": [
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Line](../../charts/line.md)",
"[Legend](../../configuration/legend.md)",
[
"[Position](../../configuration/legend.md#position)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 6, \"subpages\", 3]"
},
{
"title": "Alignment and Title Position",
"description": null,
"content": {
"Docs ": [
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Line](../../charts/line.md)",
"[Legend](../../configuration/legend.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 6, \"subpages\", 4]"
}
],
"path": "[\"subpages\", 8, \"subpages\", 6]"
},
{
"title": "Line",
"description": "Documentation section: line",
"content": {},
"metadata": {
"type": "directory",
"path": "/home/anhnh/CodeWikiBench/data/Chart.js/original/docs/samples/line"
},
"subpages": [
{
"title": "Interpolation Modes",
"description": null,
"content": {
"Docs ": [
"[Line](../../charts/line.md)",
[
"[`cubicInterpolationMode`](../../charts/line.md#cubicinterpolationmode)",
"[Line Styling (`tension`)](../../charts/line.md#line-styling)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 7, \"subpages\", 0]"
},
{
"title": "Line Chart",
"description": null,
"content": {
"Docs": [
"[Line](../../charts/line.md)",
"[Data structures (`labels`)](../../general/data-structures.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 7, \"subpages\", 1]"
},
{
"title": "Multi Axis Line Chart",
"description": null,
"content": {
"Docs": [
"[Axes scales](../../axes/)",
"[Cartesian Axes](../../axes/cartesian/)",
[
"[Axis Position](../../axes/cartesian/#axis-position)"
],
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Line](../../charts/line.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 7, \"subpages\", 2]"
},
{
"title": "Point Styling",
"description": null,
"content": {
"Docs": [
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Line](../../charts/line.md)",
[
"[Point Styling](../../charts/line.md#point-styling)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 7, \"subpages\", 3]"
},
{
"title": "Line Segment Styling",
"description": null,
"content": {
"Docs": [
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Line](../../charts/line.md)",
[
"[Line Styling](../../charts/line.md#line-styling)",
"[Segment](../../charts/line.md#segment)"
],
"[Options](../../general/options.md)",
[
"[Scriptable Options](../../general/options.md#scriptable-options)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 7, \"subpages\", 4]"
},
{
"title": "Stepped Line Charts",
"description": null,
"content": {
"Docs": [
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Line](../../charts/line.md)",
[
"[Stepped](../../charts/line.md#stepped)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 7, \"subpages\", 5]"
},
{
"title": "Line Styling",
"description": null,
"content": {
"Docs": [
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Line](../../charts/line.md)",
[
"[Line Styling](../../charts/line.md#line-styling)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 7, \"subpages\", 6]"
}
],
"path": "[\"subpages\", 8, \"subpages\", 7]"
},
{
"title": "Other Charts",
"description": "Documentation section: other-charts",
"content": {},
"metadata": {
"type": "directory",
"path": "/home/anhnh/CodeWikiBench/data/Chart.js/original/docs/samples/other-charts"
},
"subpages": [
{
"title": "Bubble",
"description": null,
"content": {
"Docs": [
"[Bubble](../../charts/bubble.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 8, \"subpages\", 0]"
},
{
"title": "Combo bar/line",
"description": null,
"content": {
"Docs": [
"[Bar](../../charts/bar.md)",
"[Line](../../charts/line.md)",
"[Data structures (`labels`)](../../general/data-structures.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 8, \"subpages\", 1]"
},
{
"title": "Doughnut",
"description": null,
"content": {
"Docs": [
"[Doughnut and Pie Charts](../../charts/doughnut.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 8, \"subpages\", 2]"
},
{
"title": "Multi Series Pie",
"description": null,
"content": {
"Docs": [
"[Doughnut and Pie Charts](../../charts/doughnut.md)",
"[Options](../../general/options.md)",
[
"[Scriptable Options](../../general/options.md#scriptable-options)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 8, \"subpages\", 3]"
},
{
"title": "Pie",
"description": null,
"content": {
"Docs": [
"[Doughnut and Pie Charts](../../charts/doughnut.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 8, \"subpages\", 4]"
},
{
"title": "Polar area centered point labels",
"description": null,
"content": {
"Docs": [
"[Polar Area Chart](../../charts/polar.md)",
"[Linear Radial Axis](../../axes/radial/linear.md)",
[
"[Point Label Options (`centerPointLabels`)](../../axes/radial/linear.md#point-label-options)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 8, \"subpages\", 5]"
},
{
"title": "Polar area",
"description": null,
"content": {
"Docs": [
"[Polar Area Chart](../../charts/polar.md)",
"[Radial linear scale](../../axes/radial/linear.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 8, \"subpages\", 6]"
},
{
"title": "Radar skip points",
"description": null,
"content": {
"Docs": [
"[Radar](../../charts/radar.md)",
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Radial linear scale](../../axes/radial/linear.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 8, \"subpages\", 7]"
},
{
"title": "Radar",
"description": null,
"content": {
"Docs": [
"[Radar](../../charts/radar.md)",
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Radial linear scale](../../axes/radial/linear.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 8, \"subpages\", 8]"
},
{
"title": "Scatter - Multi axis",
"description": null,
"content": {
"Docs": [
"[Scatter](../../charts/scatter.md)",
"[Cartesian Axes](../../axes/cartesian/)",
[
"[Axis Position](../../axes/cartesian/#axis-position)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 8, \"subpages\", 9]"
},
{
"title": "Scatter",
"description": null,
"content": {
"Docs": [
"[Scatter](../../charts/scatter.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 8, \"subpages\", 10]"
},
{
"title": "Stacked bar/line",
"description": null,
"content": {
"Docs": [
"[Axes scales](../../axes/)",
[
"[Common options to all axes (`stacked`)](../../axes/#common-options-to-all-axes)",
"[Stacking](../../axes/#stacking)"
],
"[Bar](../../charts/bar.md)",
"[Line](../../charts/line.md)",
"[Data structures (`labels`)](../../general/data-structures.md)",
[
"[Dataset Configuration (`stack`)](../../general/data-structures.md#dataset-configuration)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 8, \"subpages\", 11]"
}
],
"path": "[\"subpages\", 8, \"subpages\", 8]"
},
{
"title": "Plugins",
"description": "Documentation section: plugins",
"content": {},
"metadata": {
"type": "directory",
"path": "/home/anhnh/CodeWikiBench/data/Chart.js/original/docs/samples/plugins"
},
"subpages": [
{
"title": "Chart Area Border",
"description": null,
"content": {
"Docs": [
"[Line](../../charts/line.md)",
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Plugins](../../developers/plugins.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 9, \"subpages\", 0]"
},
{
"title": "Doughnut Empty State",
"description": null,
"content": {
"Docs": [
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Plugins](../../developers/plugins.md)",
"[Doughnut and Pie Charts](../../charts/doughnut.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 9, \"subpages\", 1]"
},
{
"title": "Quadrants",
"description": null,
"content": {
"Docs": [
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Plugins](../../developers/plugins.md)",
"[Scatter](../../charts/scatter.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 9, \"subpages\", 2]"
}
],
"path": "[\"subpages\", 8, \"subpages\", 9]"
},
{
"title": "Scale Options",
"description": "Documentation section: scale-options",
"content": {},
"metadata": {
"type": "directory",
"path": "/home/anhnh/CodeWikiBench/data/Chart.js/original/docs/samples/scale-options"
},
"subpages": [
{
"title": "Center Positioning",
"description": null,
"content": {
"Docs": [
"[Scatter](../../charts/scatter.md)",
"[Cartesian Axes](../../axes/cartesian/)",
[
"[Axis Position](../../axes/cartesian/#axis-position)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 10, \"subpages\", 0]"
},
{
"title": "Grid Configuration",
"description": null,
"content": {
"Docs": [
"[Line](../../charts/line.md)",
"[Options](../../general/options.md)",
[
"[Scriptable Options](../../general/options.md#scriptable-options)",
[
"[Tick Context](../../general/options.md#tick)"
]
],
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Axes Styling](../../axes/styling.md)",
[
"[Grid Line Configuration](../../axes/styling.md#grid-line-configuration)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 10, \"subpages\", 1]"
},
{
"title": "Tick Configuration",
"description": null,
"content": {
"Docs": [
"[Line](../../charts/line.md)",
"[Options](../../general/options.md)",
[
"[Scriptable Options](../../general/options.md#scriptable-options)",
[
"[Tick Context](../../general/options.md#tick)"
]
],
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Axes Styling](../../axes/styling.md)",
[
"[Tick Configuration](../../axes/styling.md#tick-configuration)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 10, \"subpages\", 2]"
},
{
"title": "Title Configuration",
"description": null,
"content": {
"Docs": [
"[Line](../../charts/line.md)",
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Axes Styling](../../axes/styling.md)",
"[Cartesian Axes](../../axes/cartesian/)",
[
"[Common options to all cartesian axes](../../axes/cartesian/#common-options-to-all-cartesian-axes)"
],
"[Labeling Axes](../../axes/labelling.md)",
[
"[Scale Title Configuration](../../axes/labelling.md#scale-title-configuration)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 10, \"subpages\", 3]"
}
],
"path": "[\"subpages\", 8, \"subpages\", 10]"
},
{
"title": "Scales",
"description": "Documentation section: scales",
"content": {},
"metadata": {
"type": "directory",
"path": "/home/anhnh/CodeWikiBench/data/Chart.js/original/docs/samples/scales"
},
"subpages": [
{
"title": "Linear Scale - Suggested Min-Max",
"description": null,
"content": {
"Docs": [
"[Line](../../charts/line.md)",
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Axes scales](../../axes/)",
[
"[Common options to all axes](../../axes/#common-options-to-all-axes)",
"[Axis Range Settings](../../axes/#axis-range-settings)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 11, \"subpages\", 0]"
},
{
"title": "Linear Scale - Min-Max",
"description": null,
"content": {
"Docs": [
"[Line](../../charts/line.md)",
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Axes scales](../../axes/)",
[
"[Common options to all axes (`min`,`max`)](../../axes/#common-options-to-all-axes)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 11, \"subpages\", 1]"
},
{
"title": "Linear Scale - Step Size",
"description": null,
"content": {
"Docs": [
"[Line](../../charts/line.md)",
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Axes scales](../../axes/)",
[
"[Common options to all axes (`min`,`max`)](../../axes/#common-options-to-all-axes)"
],
"[Linear Axis](../../axes/cartesian/linear.md)",
[
"[Linear Axis specific tick options (`stepSize`)](../../axes/cartesian/linear.md#linear-axis-specific-tick-options)",
"[Step Size](../../axes/cartesian/linear.md#step-size)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 11, \"subpages\", 2]"
},
{
"title": "Log Scale",
"description": null,
"content": {
"Docs": [
"[Line](../../charts/line.md)",
"[Logarithmic Axis](../../axes/cartesian/logarithmic.md)",
"[Data structures (`labels`)](../../general/data-structures.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 11, \"subpages\", 3]"
},
{
"title": "Stacked Linear / Category",
"description": null,
"content": {
"Docs": [
"[Line](../../charts/line.md)",
"[Axes scales](../../axes/)",
[
"[Stacking](../../axes/#stacking)"
],
"[Data structures (`labels`)](../../general/data-structures.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 11, \"subpages\", 4]"
},
{
"title": "Time Scale - Combo Chart",
"description": null,
"content": {
"Docs": [
"[Bar](../../charts/bar.md)",
"[Line](../../charts/line.md)",
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Time Scale](../../axes/cartesian/time.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 11, \"subpages\", 5]"
},
{
"title": "Time Scale",
"description": null,
"content": {
"Docs": [
"[Line](../../charts/line.md)",
"[Time Cartesian Axis](../../axes/cartesian/time.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 11, \"subpages\", 6]"
},
{
"title": "Time Scale - Max Span",
"description": null,
"content": {
"Docs": [
"[Line](../../charts/line.md)",
[
"[`spanGaps`](../../charts/line.md#line-styling)"
],
"[Time Scale](../../axes/cartesian/time.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 11, \"subpages\", 7]"
}
],
"path": "[\"subpages\", 8, \"subpages\", 11]"
},
{
"title": "Scriptable",
"description": "Documentation section: scriptable",
"content": {},
"metadata": {
"type": "directory",
"path": "/home/anhnh/CodeWikiBench/data/Chart.js/original/docs/samples/scriptable"
},
"subpages": [
{
"title": "Bar Chart",
"description": null,
"content": {
"Docs": [
"[Bar](../../charts/bar.md)",
"[Data structures (`labels`)](../../general/data-structures.md)",
[
"[Dataset Configuration (`stack`)](../../general/data-structures.md#dataset-configuration)"
],
"[Options](../../general/options.md)",
[
"[Scriptable Options](../../general/options.md#scriptable-options)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 12, \"subpages\", 0]"
},
{
"title": "Bubble Chart",
"description": null,
"content": {
"Docs": [
"[Bubble](../../charts/bubble.md)",
"[Options](../../general/options.md)",
[
"[Scriptable Options](../../general/options.md#scriptable-options)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 12, \"subpages\", 1]"
},
{
"title": "Line Chart",
"description": null,
"content": {
"Docs": [
"[Line](../../charts/line.md)",
[
"[Point Styling](../../charts/line.md#point-styling)"
],
"[Options](../../general/options.md)",
[
"[Scriptable Options](../../general/options.md#scriptable-options)"
],
"[Data structures (`labels`)](../../general/data-structures.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 12, \"subpages\", 2]"
},
{
"title": "Pie Chart",
"description": null,
"content": {
"Docs": [
"[Options](../../general/options.md)",
[
"[Scriptable Options](../../general/options.md#scriptable-options)"
],
"[Doughnut and Pie Charts](../../charts/doughnut.md) "
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 12, \"subpages\", 3]"
},
{
"title": "Polar Area Chart",
"description": null,
"content": {
"Docs": [
"[Options](../../general/options.md)",
[
"[Scriptable Options](../../general/options.md#scriptable-options)"
],
"[Polar Area Chart](../../charts/polar.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 12, \"subpages\", 4]"
},
{
"title": "Radar Chart",
"description": null,
"content": {
"Docs": [
"[Options](../../general/options.md)",
[
"[Scriptable Options](../../general/options.md#scriptable-options)"
],
"[Radar](../../charts/radar.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 12, \"subpages\", 5]"
}
],
"path": "[\"subpages\", 8, \"subpages\", 12]"
},
{
"title": "Subtitle",
"description": "Documentation section: subtitle",
"content": {},
"metadata": {
"type": "directory",
"path": "/home/anhnh/CodeWikiBench/data/Chart.js/original/docs/samples/subtitle"
},
"subpages": [
{
"title": "Basic",
"description": null,
"content": {
"Docs ": [
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Line](../../charts/line.md)",
"[Title](../../configuration/title.md)",
"[Subtitle](../../configuration/subtitle.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 13, \"subpages\", 0]"
}
],
"path": "[\"subpages\", 8, \"subpages\", 13]"
},
{
"title": "Title",
"description": "Documentation section: title",
"content": {},
"metadata": {
"type": "directory",
"path": "/home/anhnh/CodeWikiBench/data/Chart.js/original/docs/samples/title"
},
"subpages": [
{
"title": "Alignment",
"description": null,
"content": {
"Docs ": [
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Line](../../charts/line.md)",
"[Title](../../configuration/title.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 14, \"subpages\", 0]"
}
],
"path": "[\"subpages\", 8, \"subpages\", 14]"
},
{
"title": "Tooltip",
"description": "Documentation section: tooltip",
"content": {},
"metadata": {
"type": "directory",
"path": "/home/anhnh/CodeWikiBench/data/Chart.js/original/docs/samples/tooltip"
},
"subpages": [
{
"title": "Custom Tooltip Content",
"description": null,
"content": {
"Docs ": [
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Line](../../charts/line.md)",
"[Tooltip](../../configuration/tooltip.md)",
[
"[Tooltip Callbacks](../../configuration/tooltip.md#tooltip-callbacks)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 15, \"subpages\", 0]"
},
{
"title": "External HTML Tooltip",
"description": null,
"content": {
"Docs ": [
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Line](../../charts/line.md)",
"[Tooltip](../../configuration/tooltip.md)",
[
"[External (Custom) Tooltips](../../configuration/tooltip.md#external-custom-tooltips)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 15, \"subpages\", 1]"
},
{
"title": "Interaction Modes",
"description": null,
"content": {
"Docs ": [
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Line](../../charts/line.md)",
"[Tooltip](../../configuration/tooltip.md)",
"[Interactions](../../configuration/interactions.md)"
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 15, \"subpages\", 2]"
},
{
"title": "Point Style",
"description": null,
"content": {
"Docs ": [
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Line](../../charts/line.md)",
"[Tooltip](../../configuration/tooltip.md)",
[
"`usePointStyle`"
],
"[Elements](../../configuration/elements.md)",
[
"[Point Styles](../../configuration/elements.md#point-styles)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 15, \"subpages\", 3]"
},
{
"title": "Position",
"description": null,
"content": {
"Docs ": [
"[Data structures (`labels`)](../../general/data-structures.md)",
"[Line](../../charts/line.md)",
"[Tooltip](../../configuration/tooltip.md)",
[
"[Position Modes](../../configuration/tooltip.md#position-modes)",
"[Custom Position Modes](../../configuration/tooltip.md#custom-position-modes)"
]
]
},
"metadata": {},
"subpages": [],
"path": "[\"subpages\", 8, \"subpages\", 15, \"subpages\", 4]"
}
],
"path": "[\"subpages\", 8, \"subpages\", 15]"
}
],
"path": "[\"subpages\", 8]"
}
]
},
"rubrics": {
"rubrics": [
{
"requirements": "Chart Instance and Lifecycle Management",
"weight": 3,
"sub_tasks": [
{
"requirements": "Chart Instantiation and Configuration",
"weight": 3,
"sub_tasks": [
{
"requirements": "The system provides a primary Chart object that encapsulates all state and functionality for a single chart instance with canvas element and configuration object.",
"weight": 3
},
{
"requirements": "A core configuration object (type, data, options, plugins) defines the initial state and behavior of the chart instance.",
"weight": 3
},
{
"requirements": "Installation and integration methods for incorporating Chart.js into applications (npm, bundlers, script tags).",
"weight": 2
}
]
},
{
"requirements": "Chart Instance API and Control",
"weight": 3,
"sub_tasks": [
{
"requirements": "Manages rendering and re-rendering through render() and update() methods with configurable update modes.",
"weight": 3
},
{
"requirements": "Provides methods for resource cleanup and instance destruction (destroy(), clear()).",
"weight": 2
},
{
"requirements": "Supports dynamic data manipulation (add/remove) and visibility toggling (hide/show methods).",
"weight": 2
},
{
"requirements": "Allows for programmatic interaction with chart elements (getElementsAtEventForMode, setActiveElements).",
"weight": 1
}
]
},
{
"requirements": "Component Registry System",
"weight": 2,
"sub_tasks": [
{
"requirements": "A static registry manages all available components (charts, scales, plugins) that can be instantiated.",
"weight": 2
},
{
"requirements": "Supports dynamic registration and unregistration of components, enabling tree-shaking and custom extensions.",
"weight": 2
}
]
}
]
},
{
"requirements": "Configuration and Options Resolution System",
"weight": 3,
"sub_tasks": [
{
"requirements": "Hierarchical Options Resolution",
"weight": 3,
"sub_tasks": [
{
"requirements": "Options are resolved from global defaults, to chart-specific defaults, to dataset-level options, and finally to element-specific options.",
"weight": 3
},
{
"requirements": "Specific components like scales, plugins, titles, and tooltips have their own dedicated option scopes.",
"weight": 2
}
]
},
{
"requirements": "Dynamic Options System",
"weight": 3,
"sub_tasks": [
{
"requirements": "Scriptable options are functions that receive a context object (chart, dataset, dataIndex) and return a value, allowing for data-dependent configuration.",
"weight": 3
},
{
"requirements": "Indexable options are arrays that map values to elements by their index.",
"weight": 2
}
]
},
{
"requirements": "Visual Configuration",
"weight": 2,
"sub_tasks": [
{
"requirements": "Color management, patterns, gradients, and visual styling options with multiple color formats.",
"weight": 2
},
{
"requirements": "Chart layout, padding, and spacing configuration.",
"weight": 2
},
{
"requirements": "Global configuration for elements (points, lines, bars, arcs) that can be overridden at lower levels.",
"weight": 2
}
]
}
]
},
{
"requirements": "Chart Types and Visualization",
"weight": 3,
"sub_tasks": [
{
"requirements": "Cartesian Charts",
"weight": 3,
"sub_tasks": [
{
"requirements": "Bar Charts with vertical and horizontal orientations, stacking capabilities, and comprehensive styling options.",
"weight": 3
},
{
"requirements": "Line Charts with point styling, line styling, area filling capabilities, and stacked area support.",
"weight": 3
},
{
"requirements": "Scatter and Bubble Charts for displaying relationships between variables with point-based visualization.",
"weight": 2
}
]
},
{
"requirements": "Radial Charts",
"weight": 2,
"sub_tasks": [
{
"requirements": "Pie and Doughnut Charts for displaying proportional data with circular visualization.",
"weight": 2
},
{
"requirements": "Polar and Radar Charts for multi-dimensional data visualization with radial coordinate systems.",
"weight": 2
}
]
},
{
"requirements": "Mixed Chart Types",
"weight": 1,
"sub_tasks": [
{
"requirements": "Capability to combine multiple chart types in a single visualization by associating different controllers with different datasets.",
"weight": 2
},
{
"requirements": "Chart-specific behaviors like line interpolation, bar stacking, and pie/doughnut segment calculation.",
"weight": 2
}
]
}
]
},
{
"requirements": "Component-Based Rendering Architecture",
"weight": 3,
"sub_tasks": [
{
"requirements": "Layout Engine",
"weight": 3,
"sub_tasks": [
{
"requirements": "Organizes and positions all chart components (canvas, axes, legend, title) within the available space.",
"weight": 3
},
{
"requirements": "Manages padding and responsive resizing of the chart canvas and its internal drawing area.",
"weight": 2
}
]
},
{
"requirements": "Scale System",
"weight": 3,
"sub_tasks": [
{
"requirements": "Modular Scale subsystem that maps data values to pixel coordinates on the canvas with extensible base interface.",
"weight": 3
},
{
"requirements": "Cartesian coordinate systems with Linear, Category, Time/TimeSeries, and Logarithmic scales.",
"weight": 3
},
{
"requirements": "Radial coordinate systems for circular chart types with specialized configuration options.",
"weight": 2
},
{
"requirements": "Each scale generates its own ticks, grid lines, and labels based on configuration and data range.",
"weight": 3
},
{
"requirements": "Supports stacking of values across multiple datasets on a single axis.",
"weight": 2
}
]
},
{
"requirements": "Dataset Controllers",
"weight": 3,
"sub_tasks": [
{
"requirements": "Chart type logic encapsulated in Dataset Controllers that manage drawing of specific visual representations.",
"weight": 3
},
{
"requirements": "Each controller interprets dataset properties and creates/updates primitive drawing elements (e.g., BarController creates bar elements).",
"weight": 3
}
]
},
{
"requirements": "Auxiliary UI Components",
"weight": 2,
"sub_tasks": [
{
"requirements": "Tooltip system with interaction modes, positioning, content customization, and extensive callbacks.",
"weight": 2
},
{
"requirements": "Legend system that generates items based on chart datasets and handles user interactions to toggle dataset visibility.",
"weight": 2
},
{
"requirements": "Title configuration and positioning within the chart layout.",
"weight": 2
}
]
}
]
},
{
"requirements": "Axes and Scales Configuration",
"weight": 3,
"sub_tasks": [
{
"requirements": "Common Scale Configuration",
"weight": 3,
"sub_tasks": [
{
"requirements": "Universal configuration options available to all axis types with common options and default scales.",
"weight": 3
},
{
"requirements": "Tick configuration including marks, labels, and formatting across all axes.",
"weight": 2
}
]
},
{
"requirements": "Axis Styling and Labeling",
"weight": 2,
"sub_tasks": [
{
"requirements": "Visual customization of axes including grid lines, borders, and scale titles.",
"weight": 2
},
{
"requirements": "Date adapters for time-based scales that parse and format various date formats independently of specific date/time libraries.",
"weight": 2
}
]
}
]
},
{
"requirements": "Data Processing Pipeline",
"weight": 3,
"sub_tasks": [
{
"requirements": "Data Ingestion and Structures",
"weight": 3,
"sub_tasks": [
{
"requirements": "Flexible data ingestion system that accepts multiple data structures (arrays of primitives, objects, etc.).",
"weight": 3
},
{
"requirements": "Configurable parsing engine that maps properties from custom data objects to internal chart values (x, y, r).",
"weight": 2
}
]
},
{
"requirements": "Data Normalization and Processing",
"weight": 2,
"sub_tasks": [
{
"requirements": "Data is normalized into an internal, consistent format used by controllers and scales.",
"weight": 2
}
]
},
{
"requirements": "Performance Optimization",
"weight": 2,
"sub_tasks": [
{
"requirements": "Data decimation module for performance optimization by reducing data points before rendering.",
"weight": 2
},
{
"requirements": "Multiple decimation algorithms (LTTB, Min/Max) for different optimization strategies.",
"weight": 1
},
{
"requirements": "Performance best practices for data parsing, normalization, and rendering with large datasets.",
"weight": 2
}
]
}
]
},
{
"requirements": "Interaction and Animation Engine",
"weight": 2,
"sub_tasks": [
{
"requirements": "Event System",
"weight": 3,
"sub_tasks": [
{
"requirements": "Captures canvas events (mousemove, click) and translates them into chart-specific interactions.",
"weight": 3
},
{
"requirements": "Interaction modes (point, nearest, index, dataset) define logic for finding and targeting chart elements from event coordinates.",
"weight": 3
},
{
"requirements": "Helper functions to convert event coordinates to data values on a given scale.",
"weight": 2
}
]
},
{
"requirements": "Animation System",
"weight": 2,
"sub_tasks": [
{
"requirements": "Core animation engine that manages visual transitions between chart states with configurable easing functions.",
"weight": 3
},
{
"requirements": "Distinct animation configurations for different chart update scenarios (initial render, resize, data update).",
"weight": 2
},
{
"requirements": "Animation lifecycle callbacks (onProgress, onComplete) for advanced effects.",
"weight": 1
}
]
}
]
},
{
"requirements": "Plugin System and Extensibility",
"weight": 2,
"sub_tasks": [
{
"requirements": "Plugin API and Usage",
"weight": 3,
"sub_tasks": [
{
"requirements": "Robust Plugin API that allows developers to hook into chart lifecycle to add custom functionality or modify behavior.",
"weight": 3
},
{
"requirements": "Lifecycle hooks at critical points including before/after initialization, updates, rendering, and destruction.",
"weight": 3
},
{
"requirements": "Plugins can be registered globally or per-chart basis with their own configuration scope.",
"weight": 2
}
]
},
{
"requirements": "Custom Component Development",
"weight": 2,
"sub_tasks": [
{
"requirements": "System designed for extensibility allowing developers to create and register new chart types and axis types.",
"weight": 2
},
{
"requirements": "New components created by extending base controller and scale classes and implementing defined interfaces.",
"weight": 2
},
{
"requirements": "Custom axis development with scale properties and interface implementation.",
"weight": 1
}
]
}
]
},
{
"requirements": "Development and Integration",
"weight": 2,
"sub_tasks": [
{
"requirements": "Framework Integration",
"weight": 2,
"sub_tasks": [
{
"requirements": "Integration with popular JavaScript frameworks and build tools with bundle optimization.",
"weight": 2
}
]
},
{
"requirements": "Responsive Design and Accessibility",
"weight": 2,
"sub_tasks": [
{
"requirements": "Responsive chart behavior and device compatibility with configuration options.",
"weight": 2
},
{
"requirements": "Accessibility features and best practices for inclusive chart design.",
"weight": 1
}
]
},
{
"requirements": "Migration and Versioning",
"weight": 1,
"sub_tasks": [
{
"requirements": "Version migration guides and compatibility information for end users.",
"weight": 1
}
]
}
]
}
]
}
} |