-
Notifications
You must be signed in to change notification settings - Fork 16
/
Copy pathapi.html
98 lines (98 loc) · 46.1 KB
/
api.html
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
<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>API | Chart.js</title>
<meta name="generator" content="VuePress 1.8.2">
<link rel="icon" href="/docs/3.1.0/favicon.ico">
<meta name="description" content="Open source HTML5 Charts for your website">
<link rel="preload" href="/docs/3.1.0/assets/css/0.styles.1623ef7a.css" as="style"><link rel="preload" href="/docs/3.1.0/assets/js/app.0ddc5917.js" as="script"><link rel="preload" href="/docs/3.1.0/assets/js/2.47b832b0.js" as="script"><link rel="preload" href="/docs/3.1.0/assets/js/156.88c22218.js" as="script"><link rel="prefetch" href="/docs/3.1.0/assets/js/10.ceebed1f.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/100.eee663a2.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/101.b9b1b068.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/102.479c4581.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/103.53ead1e1.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/104.5c7d8858.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/105.1d68e09a.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/106.92da18bd.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/107.6f10ac74.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/108.1e45abeb.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/109.a738a660.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/11.f705aaa7.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/110.e0faa63f.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/111.7354a214.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/112.6ca1a838.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/113.625030ba.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/114.3a9c0bc2.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/115.10b47ecd.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/116.bb2a90dc.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/117.38671888.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/118.5761cc61.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/119.3b5f344b.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/12.09150dfc.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/120.0e595569.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/121.97e3bd5c.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/122.d96fa0b5.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/123.1638a563.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/124.76f2c8c1.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/125.2a9384bc.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/126.f39ed9b5.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/127.787b00cf.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/128.e9a4c541.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/129.cdd55064.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/13.854ba43a.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/130.b0e9a64a.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/131.33f2cf0f.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/132.144a5acb.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/133.3b4bce40.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/134.dc5ffe9b.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/135.5c63beb8.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/136.ac5c4228.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/137.d8e51241.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/138.fdf11c55.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/139.990fd19a.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/14.081adf03.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/140.6046865f.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/141.eeadecc8.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/142.85d7ca48.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/143.a5488c00.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/144.0aead3ec.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/145.5a75acb9.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/146.f3118c3f.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/147.21dc728b.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/148.ce54af98.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/149.bdcfdade.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/15.aaf10464.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/150.62d02d68.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/151.9548d02d.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/152.48f8570e.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/153.c769f486.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/154.fcb3d380.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/155.4b834ca6.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/157.6b66074e.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/158.bfde7069.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/159.f33bb4c1.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/16.f65d25ae.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/160.e9680c69.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/161.9f1e28ab.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/162.fc3983a6.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/163.9e832dc0.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/164.3cc163f4.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/165.bfde4011.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/166.e764b73e.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/167.eff2831d.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/168.e618654e.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/169.9e5b7a91.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/17.9899e86e.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/170.ac0288f3.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/171.6b973c39.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/172.856e7c8a.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/173.d8445d26.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/174.ade5be43.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/175.ba3b8841.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/176.10bb64a2.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/177.39202147.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/178.55369968.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/179.801e181f.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/18.8259392d.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/180.4dbdd10b.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/181.66862476.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/182.1750aec1.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/183.a8ac6c4a.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/184.879d3753.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/185.6c8fa5a8.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/186.f6109ecf.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/187.24f55f38.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/188.9625ad8d.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/189.2785e485.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/19.59e65df3.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/190.6e8c7e8f.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/191.75063460.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/192.710f6faa.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/193.10f1ee73.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/194.98945737.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/195.b35e6ac4.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/196.a373af9e.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/197.0951760f.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/198.3eaf762c.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/199.e2df0be6.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/20.e8fa3191.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/200.1b76db29.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/201.1f3b8d0d.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/202.da641c48.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/203.58eb5db9.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/204.d13f1881.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/205.471d40f8.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/206.9d293c71.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/207.8219847c.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/208.7b13d4e9.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/209.28467871.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/21.fee6e631.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/210.53598657.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/211.d9c2da28.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/212.2e9df0fb.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/213.016ba575.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/214.9581b08a.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/215.903d226f.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/216.35952ef4.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/217.9d5607f9.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/218.d6c62cbb.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/219.fffb530f.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/22.5703057f.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/220.6fcc9be7.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/221.0badbc01.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/222.d26db47d.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/223.97b2025d.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/224.5757c412.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/225.4a17da2d.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/226.9aa0a8fc.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/227.1ae5f133.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/228.cc4dbf95.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/229.251d8765.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/23.134ecae5.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/230.2695cca3.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/231.ec9b28e6.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/232.f27f6418.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/233.155ff8a1.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/234.abea39d7.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/235.6160b7ca.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/236.8449bd12.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/237.39e18457.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/238.a35df5d4.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/239.ecf8e4da.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/24.266144a9.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/240.96c3a582.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/241.898273af.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/242.2ce1e199.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/25.5f549319.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/26.353585cd.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/27.b322463a.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/28.ba867bf5.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/29.f82ad649.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/3.f47fb655.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/30.c6424404.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/31.c150cc00.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/32.5ba19999.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/33.886e86c0.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/34.e6a38b20.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/35.2bc7aed5.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/36.a4911720.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/37.b47c5714.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/38.cd9de92b.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/39.804db20b.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/4.02ebacaa.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/40.2b5bc944.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/41.ffdbe277.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/42.861beeb2.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/43.eaeffe1e.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/44.a272b2bf.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/45.1c977b10.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/46.e4570fef.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/47.888e1be0.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/48.3d2b6dae.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/49.a9354155.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/5.3ebaf703.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/50.ece980c4.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/51.4ce2ec8a.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/52.44c00e86.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/53.df736d99.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/54.3cb944cc.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/55.49c0fd5c.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/56.8beb8892.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/57.62b24161.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/58.a738cc24.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/59.faa2f5d2.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/6.66c3a69e.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/60.4b0ad5e2.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/61.0c94f87a.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/62.1955e3ef.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/63.a2c68d92.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/64.61e33bb7.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/65.3ed92966.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/66.85ebdcec.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/67.7fdf739f.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/68.9ba7535b.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/69.e5b7dac5.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/7.444ac8c1.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/70.5f575655.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/71.e6886a7d.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/72.3cbbf440.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/73.7e0c7b18.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/74.26bae493.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/75.9641c3e4.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/76.a2eb57f4.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/77.aa12d9c5.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/78.5b5597b6.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/79.a436a5a4.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/8.213592ca.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/80.98082ae7.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/81.3c4dfdab.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/82.847186b1.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/83.1464037a.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/84.6c883a62.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/85.ce19abc2.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/86.44f69d78.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/87.3639bc16.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/88.14645b1d.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/89.f6686130.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/9.97a769a4.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/90.71dfc67f.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/91.2a2bd3d2.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/92.1906a5fc.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/93.040a325e.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/94.e69ba595.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/95.9d59b30f.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/96.281b52d0.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/97.5181339d.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/98.c10d3dd8.js"><link rel="prefetch" href="/docs/3.1.0/assets/js/99.43c1ef40.js">
<link rel="stylesheet" href="/docs/3.1.0/assets/css/0.styles.1623ef7a.css">
</head>
<body>
<div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/docs/3.1.0/" class="home-link router-link-active"><img src="/docs/3.1.0/favicon.ico" alt="Chart.js" class="logo"> <span class="site-name can-hide">Chart.js</span></a> <div class="links"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links can-hide"><div class="nav-item"><a href="/docs/3.1.0/" class="nav-link">
Home
</a></div><div class="nav-item"><a href="/docs/3.1.0/api/" class="nav-link">
API
</a></div><div class="nav-item"><a href="/docs/3.1.0/samples/" class="nav-link">
Samples
</a></div><div class="nav-item"><div class="dropdown-wrapper"><button type="button" aria-label="Community Menu" class="dropdown-title"><span class="title">Ecosystem</span> <span class="arrow down"></span></button> <button type="button" aria-label="Community Menu" class="mobile-dropdown-title"><span class="title">Ecosystem</span> <span class="arrow right"></span></button> <ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><!----> <a href="https://github.com/chartjs/awesome" target="_blank" rel="noopener noreferrer" class="nav-link external">
Awesome
<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></li><li class="dropdown-item"><!----> <a href="https://chartjs-slack.herokuapp.com/" target="_blank" rel="noopener noreferrer" class="nav-link external">
Slack
<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></li><li class="dropdown-item"><!----> <a href="https://stackoverflow.com/questions/tagged/chart.js" target="_blank" rel="noopener noreferrer" class="nav-link external">
Stack Overflow
<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></li></ul></div></div> <a href="https://github.com/chartjs/Chart.js" target="_blank" rel="noopener noreferrer" class="repo-link">
GitHub
<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></nav></div></header> <div class="sidebar-mask"></div> <aside class="sidebar"><nav class="nav-links"><div class="nav-item"><a href="/docs/3.1.0/" class="nav-link">
Home
</a></div><div class="nav-item"><a href="/docs/3.1.0/api/" class="nav-link">
API
</a></div><div class="nav-item"><a href="/docs/3.1.0/samples/" class="nav-link">
Samples
</a></div><div class="nav-item"><div class="dropdown-wrapper"><button type="button" aria-label="Community Menu" class="dropdown-title"><span class="title">Ecosystem</span> <span class="arrow down"></span></button> <button type="button" aria-label="Community Menu" class="mobile-dropdown-title"><span class="title">Ecosystem</span> <span class="arrow right"></span></button> <ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><!----> <a href="https://github.com/chartjs/awesome" target="_blank" rel="noopener noreferrer" class="nav-link external">
Awesome
<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></li><li class="dropdown-item"><!----> <a href="https://chartjs-slack.herokuapp.com/" target="_blank" rel="noopener noreferrer" class="nav-link external">
Slack
<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></li><li class="dropdown-item"><!----> <a href="https://stackoverflow.com/questions/tagged/chart.js" target="_blank" rel="noopener noreferrer" class="nav-link external">
Stack Overflow
<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></li></ul></div></div> <a href="https://github.com/chartjs/Chart.js" target="_blank" rel="noopener noreferrer" class="repo-link">
GitHub
<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></nav> <ul class="sidebar-links"><li><a href="/docs/3.1.0/" aria-current="page" class="sidebar-link">Chart.js</a></li><li><section class="sidebar-group collapsable depth-0"><p class="sidebar-heading"><span>Getting Started</span> <span class="arrow right"></span></p> <!----></section></li><li><section class="sidebar-group collapsable depth-0"><p class="sidebar-heading"><span>General</span> <span class="arrow right"></span></p> <!----></section></li><li><section class="sidebar-group collapsable depth-0"><p class="sidebar-heading"><span>Configuration</span> <span class="arrow right"></span></p> <!----></section></li><li><section class="sidebar-group collapsable depth-0"><p class="sidebar-heading"><span>Chart Types</span> <span class="arrow right"></span></p> <!----></section></li><li><section class="sidebar-group collapsable depth-0"><p class="sidebar-heading"><span>Axes</span> <span class="arrow right"></span></p> <!----></section></li><li><section class="sidebar-group collapsable depth-0"><p class="sidebar-heading open"><span>Developers</span> <span class="arrow down"></span></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/docs/3.1.0/developers/" aria-current="page" class="sidebar-link">Developers</a></li><li><a href="/docs/3.1.0/developers/api.html" aria-current="page" class="active sidebar-link">API</a></li><li><a href="/docs/3.1.0/api/" class="sidebar-link">TypeDoc</a></li><li><a href="/docs/3.1.0/developers/updates.html" class="sidebar-link">Updating Charts</a></li><li><a href="/docs/3.1.0/developers/plugins.html" class="sidebar-link">Plugins</a></li><li><a href="/docs/3.1.0/developers/charts.html" class="sidebar-link">New Charts</a></li><li><a href="/docs/3.1.0/developers/axes.html" class="sidebar-link">New Axes</a></li><li><a href="/docs/3.1.0/developers/contributing.html" class="sidebar-link">Contributing</a></li><li><a href="/docs/3.1.0/developers/publishing.html" class="sidebar-link">Publishing an extension</a></li></ul></section></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h1 id="api"><a href="#api" class="header-anchor">#</a> API</h1> <p>For each chart, there are a set of global prototype methods on the shared chart type which you may find useful. These are available on all charts created with Chart.js, but for the examples, let's use a line chart we've made.</p> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token comment">// For example:</span>
<span class="token keyword">var</span> myLineChart <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Chart</span><span class="token punctuation">(</span>ctx<span class="token punctuation">,</span> config<span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><h2 id="destroy"><a href="#destroy" class="header-anchor">#</a> .destroy()</h2> <p>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.
This must be called before the canvas is reused for a new chart.</p> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token comment">// Destroys a specific chart instance</span>
myLineChart<span class="token punctuation">.</span><span class="token function">destroy</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><h2 id="update-mode"><a href="#update-mode" class="header-anchor">#</a> .update(mode?)</h2> <p>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.</p> <div class="language-javascript extra-class"><pre class="language-javascript"><code>myLineChart<span class="token punctuation">.</span>data<span class="token punctuation">.</span>datasets<span class="token punctuation">[</span><span class="token number">0</span><span class="token punctuation">]</span><span class="token punctuation">.</span>data<span class="token punctuation">[</span><span class="token number">2</span><span class="token punctuation">]</span> <span class="token operator">=</span> <span class="token number">50</span><span class="token punctuation">;</span> <span class="token comment">// Would update the first dataset's value of 'March' to be 50</span>
myLineChart<span class="token punctuation">.</span><span class="token function">update</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// Calling update now animates the position of March from 90 to 50.</span>
</code></pre></div><p>A <code>mode</code> string can be provided to indicate transition configuration should be used. Core calls this method using any of <code>'active'</code>, <code>'hide'</code>, <code>'reset'</code>, <code>'resize'</code>, <code>'show'</code> or <code>undefined</code>. <code>'none'</code> is also a supported mode for skipping animations for single update. Please see <a href="/docs/3.1.0/configuration/animations.html">animations</a> docs for more details.</p> <p>Example:</p> <div class="language-javascript extra-class"><pre class="language-javascript"><code>myChart<span class="token punctuation">.</span><span class="token function">update</span><span class="token punctuation">(</span><span class="token string">'active'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><p>See <a href="/docs/3.1.0/developers/updates.html">Updating Charts</a> for more details.</p> <h2 id="reset"><a href="#reset" class="header-anchor">#</a> .reset()</h2> <p>Reset the chart to its state before the initial animation. A new animation can then be triggered using <code>update</code>.</p> <div class="language-javascript extra-class"><pre class="language-javascript"><code>myLineChart<span class="token punctuation">.</span><span class="token function">reset</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><h2 id="render"><a href="#render" class="header-anchor">#</a> .render()</h2> <p>Triggers a redraw of all chart elements. Note, this does not update elements for new data. Use <code>.update()</code> in that case.</p> <h2 id="stop"><a href="#stop" class="header-anchor">#</a> .stop()</h2> <p>Use this to stop any current animation. This will pause the chart during any current animation frame. Call <code>.render()</code> to re-animate.</p> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token comment">// Stops the charts animation loop at its current frame</span>
myLineChart<span class="token punctuation">.</span><span class="token function">stop</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token comment">// => returns 'this' for chainability</span>
</code></pre></div><h2 id="resize-width-height"><a href="#resize-width-height" class="header-anchor">#</a> .resize(width?, height?)</h2> <p>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.</p> <p>You can call <code>.resize()</code> with no parameters to have the chart take the size of its container element, or you can pass explicit dimensions (e.g., for <a href="/docs/3.1.0/configuration/responsive.html#printing-resizable-charts">printing</a>).</p> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token comment">// Resizes & redraws to fill its container element</span>
myLineChart<span class="token punctuation">.</span><span class="token function">resize</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token comment">// => returns 'this' for chainability</span>
<span class="token comment">// With an explicit size:</span>
myLineChart<span class="token punctuation">.</span><span class="token function">resize</span><span class="token punctuation">(</span>width<span class="token punctuation">,</span> height<span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><h2 id="clear"><a href="#clear" class="header-anchor">#</a> .clear()</h2> <p>Will clear the chart canvas. Used extensively internally between animation frames, but you might find it useful.</p> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token comment">// Will clear the canvas that myLineChart is drawn on</span>
myLineChart<span class="token punctuation">.</span><span class="token function">clear</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token comment">// => returns 'this' for chainability</span>
</code></pre></div><h2 id="tobase64image-type-quality"><a href="#tobase64image-type-quality" class="header-anchor">#</a> .toBase64Image(type?, quality?)</h2> <p>This returns a base 64 encoded string of the chart in its current state.</p> <div class="language-javascript extra-class"><pre class="language-javascript"><code>myLineChart<span class="token punctuation">.</span><span class="token function">toBase64Image</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token comment">// => returns png data url of the image on the canvas</span>
myLineChart<span class="token punctuation">.</span><span class="token function">toBase64Image</span><span class="token punctuation">(</span><span class="token string">'image/jpeg'</span><span class="token punctuation">,</span> <span class="token number">1</span><span class="token punctuation">)</span>
<span class="token comment">// => returns a jpeg data url in the highest quality of the canvas</span>
</code></pre></div><h2 id="getelementsateventformode-e-mode-options-usefinalposition"><a href="#getelementsateventformode-e-mode-options-usefinalposition" class="header-anchor">#</a> .getElementsAtEventForMode(e, mode, options, useFinalPosition)</h2> <p>Calling <code>getElementsAtEventForMode(e, mode, options, useFinalPosition)</code> on your Chart instance passing an event and a mode will return the elements that are found. The <code>options</code> and <code>useFinalPosition</code> arguments are passed through to the handlers.</p> <p>To get an item that was clicked on, <code>getElementsAtEventForMode</code> can be used.</p> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token keyword">function</span> <span class="token function">clickHandler</span><span class="token punctuation">(</span><span class="token parameter">evt</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
<span class="token keyword">const</span> points <span class="token operator">=</span> myChart<span class="token punctuation">.</span><span class="token function">getElementAtEventForMode</span><span class="token punctuation">(</span>evt<span class="token punctuation">,</span> <span class="token string">'nearest'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> intersect<span class="token operator">:</span> <span class="token boolean">true</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token boolean">true</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token keyword">if</span> <span class="token punctuation">(</span>points<span class="token punctuation">.</span>length<span class="token punctuation">)</span> <span class="token punctuation">{</span>
<span class="token keyword">const</span> firstPoint <span class="token operator">=</span> points<span class="token punctuation">[</span><span class="token number">0</span><span class="token punctuation">]</span><span class="token punctuation">;</span>
<span class="token keyword">var</span> label <span class="token operator">=</span> myChart<span class="token punctuation">.</span>data<span class="token punctuation">.</span>labels<span class="token punctuation">[</span>firstPoint<span class="token punctuation">.</span>index<span class="token punctuation">]</span><span class="token punctuation">;</span>
<span class="token keyword">var</span> value <span class="token operator">=</span> myChart<span class="token punctuation">.</span>data<span class="token punctuation">.</span>datasets<span class="token punctuation">[</span>firstPoint<span class="token punctuation">.</span>datasetIndex<span class="token punctuation">]</span><span class="token punctuation">.</span>data<span class="token punctuation">[</span>firstPoint<span class="token punctuation">.</span>index<span class="token punctuation">]</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
</code></pre></div><h2 id="getdatasetmeta-index"><a href="#getdatasetmeta-index" class="header-anchor">#</a> .getDatasetMeta(index)</h2> <p>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.</p> <p>The <code>data</code> property of the metadata will contain information about each point, bar, etc. depending on the chart type.</p> <p>Extensive examples of usage are available in the <a href="https://github.com/chartjs/Chart.js/tree/master/test" target="_blank" rel="noopener noreferrer">Chart.js tests<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a>.</p> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token keyword">var</span> meta <span class="token operator">=</span> myChart<span class="token punctuation">.</span><span class="token function">getDatasetMeta</span><span class="token punctuation">(</span><span class="token number">0</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token keyword">var</span> x <span class="token operator">=</span> meta<span class="token punctuation">.</span>data<span class="token punctuation">[</span><span class="token number">0</span><span class="token punctuation">]</span><span class="token punctuation">.</span>x<span class="token punctuation">;</span>
</code></pre></div><h2 id="setdatasetvisibility-datasetindex-visibility"><a href="#setdatasetvisibility-datasetindex-visibility" class="header-anchor">#</a> setDatasetVisibility(datasetIndex, visibility)</h2> <p>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 <code>setDatasetVisibility</code> to change the appropriate dataset.</p> <div class="language-javascript extra-class"><pre class="language-javascript"><code>chart<span class="token punctuation">.</span><span class="token function">setDatasetVisibility</span><span class="token punctuation">(</span><span class="token number">1</span><span class="token punctuation">,</span> <span class="token boolean">false</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// hides dataset at index 1</span>
chart<span class="token punctuation">.</span><span class="token function">update</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// chart now renders with dataset hidden</span>
</code></pre></div><h2 id="toggledatavisibility-index"><a href="#toggledatavisibility-index" class="header-anchor">#</a> toggleDataVisibility(index)</h2> <p>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.</p> <div class="language-javascript extra-class"><pre class="language-javascript"><code>chart<span class="token punctuation">.</span><span class="token function">toggleDataVisibility</span><span class="token punctuation">(</span><span class="token number">2</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// toggles the item in all datasets, at index 2</span>
chart<span class="token punctuation">.</span><span class="token function">update</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// chart now renders with item hidden</span>
</code></pre></div><h2 id="getdatavisibility-index"><a href="#getdatavisibility-index" class="header-anchor">#</a> getDataVisibility(index)</h2> <p>Returns the stored visibility state of an data index for all datasets. Set by <a href="#toggleDataVisibility">toggleDataVisibility</a>. A dataset controller should use this method to determine if an item should not be visible.</p> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token keyword">var</span> visible <span class="token operator">=</span> chart<span class="token punctuation">.</span><span class="token function">getDataVisibility</span><span class="token punctuation">(</span><span class="token number">2</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><h2 id="hide-datasetindex"><a href="#hide-datasetindex" class="header-anchor">#</a> hide(datasetIndex)</h2> <p>Sets the visibility for the given dataset to false. Updates the chart and animates the dataset with <code>'hide'</code> mode. This animation can be configured under the <code>hide</code> key in animation options. Please see <a href="/docs/3.1.0/configuration/animations.html">animations</a> docs for more details.</p> <div class="language-javascript extra-class"><pre class="language-javascript"><code>chart<span class="token punctuation">.</span><span class="token function">hide</span><span class="token punctuation">(</span><span class="token number">1</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// hides dataset at index 1 and does 'hide' animation.</span>
</code></pre></div><h2 id="show-datasetindex"><a href="#show-datasetindex" class="header-anchor">#</a> show(datasetIndex)</h2> <p>Sets the visibility for the given dataset to true. Updates the chart and animates the dataset with <code>'show'</code> mode. This animation can be configured under the <code>show</code> key in animation options. Please see <a href="/docs/3.1.0/configuration/animations.html">animations</a> docs for more details.</p> <div class="language-javascript extra-class"><pre class="language-javascript"><code>chart<span class="token punctuation">.</span><span class="token function">show</span><span class="token punctuation">(</span><span class="token number">1</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// shows dataset at index 1 and does 'show' animation.</span>
</code></pre></div><h2 id="setactiveelements-activeelements"><a href="#setactiveelements-activeelements" class="header-anchor">#</a> setActiveElements(activeElements)</h2> <p>Sets the active (hovered) elements for the chart. See the "Programmatic Events" sample file to see this in action.</p> <div class="language-javascript extra-class"><pre class="language-javascript"><code>chart<span class="token punctuation">.</span><span class="token function">setActiveElements</span><span class="token punctuation">(</span><span class="token punctuation">[</span>
<span class="token punctuation">{</span>datasetIndex<span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> index<span class="token operator">:</span> <span class="token number">1</span><span class="token punctuation">}</span><span class="token punctuation">,</span>
<span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><h2 id="static-getchart-key"><a href="#static-getchart-key" class="header-anchor">#</a> Static: getChart(key)</h2> <p>Finds the chart instance from the given key. If the key is a <code>string</code>, it is interpreted as the ID of the Canvas node for the Chart. The key can also be a <code>CanvasRenderingContext2D</code> or an <code>HTMLDOMElement</code>. This will return <code>undefined</code> if no Chart is found. To be found, the chart must have previously been created.</p> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token keyword">const</span> chart <span class="token operator">=</span> Chart<span class="token punctuation">.</span><span class="token function">getChart</span><span class="token punctuation">(</span><span class="token string">"canvas-id"</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div></div> <footer class="page-edit"><!----> <div class="last-updated"><span class="prefix">Last Updated:</span> <span class="time">4/3/2021, 2:16:26 PM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
←
<a href="/docs/3.1.0/developers/" class="prev router-link-active">
Developers
</a></span> <span class="next"><a href="/docs/3.1.0/api/">
TypeDoc
</a>
→
</span></p></div> </main></div><div class="global-ui"></div></div>
<script src="/docs/3.1.0/assets/js/app.0ddc5917.js" defer></script><script src="/docs/3.1.0/assets/js/2.47b832b0.js" defer></script><script src="/docs/3.1.0/assets/js/156.88c22218.js" defer></script>
</body>
</html>