-
Notifications
You must be signed in to change notification settings - Fork 16
/
Copy pathplugins.html
127 lines (127 loc) · 50.5 KB
/
plugins.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
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
<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Plugins | Chart.js</title>
<meta name="generator" content="VuePress 1.9.9">
<link rel="icon" href="/docs/latest/favicon.ico">
<meta name="description" content="Open source HTML5 Charts for your website">
<link rel="preload" href="/docs/latest/assets/css/0.styles.6dc2f403.css" as="style"><link rel="preload" href="/docs/latest/assets/js/app.1775731d.js" as="script"><link rel="preload" href="/docs/latest/assets/js/2.2c2b1036.js" as="script"><link rel="preload" href="/docs/latest/assets/js/5.ed1eea17.js" as="script"><link rel="prefetch" href="/docs/latest/assets/js/10.ba172174.js"><link rel="prefetch" href="/docs/latest/assets/js/100.559bdb31.js"><link rel="prefetch" href="/docs/latest/assets/js/101.734a357a.js"><link rel="prefetch" href="/docs/latest/assets/js/102.e53ce872.js"><link rel="prefetch" href="/docs/latest/assets/js/103.9940e4fa.js"><link rel="prefetch" href="/docs/latest/assets/js/104.469f66c7.js"><link rel="prefetch" href="/docs/latest/assets/js/105.5ae465af.js"><link rel="prefetch" href="/docs/latest/assets/js/106.716d6eac.js"><link rel="prefetch" href="/docs/latest/assets/js/107.0833c00c.js"><link rel="prefetch" href="/docs/latest/assets/js/108.d33f5d8a.js"><link rel="prefetch" href="/docs/latest/assets/js/109.ea3e6d92.js"><link rel="prefetch" href="/docs/latest/assets/js/11.d1a995d1.js"><link rel="prefetch" href="/docs/latest/assets/js/110.0e4a266d.js"><link rel="prefetch" href="/docs/latest/assets/js/111.c9c05ded.js"><link rel="prefetch" href="/docs/latest/assets/js/112.9016026c.js"><link rel="prefetch" href="/docs/latest/assets/js/113.a23a9546.js"><link rel="prefetch" href="/docs/latest/assets/js/114.d891a2d6.js"><link rel="prefetch" href="/docs/latest/assets/js/115.cdcc4368.js"><link rel="prefetch" href="/docs/latest/assets/js/116.251f2223.js"><link rel="prefetch" href="/docs/latest/assets/js/117.7eb3b50a.js"><link rel="prefetch" href="/docs/latest/assets/js/118.adac9d3d.js"><link rel="prefetch" href="/docs/latest/assets/js/119.d911cbbc.js"><link rel="prefetch" href="/docs/latest/assets/js/12.fa9e2b79.js"><link rel="prefetch" href="/docs/latest/assets/js/120.0a1625d8.js"><link rel="prefetch" href="/docs/latest/assets/js/121.64e65c08.js"><link rel="prefetch" href="/docs/latest/assets/js/122.ea83d994.js"><link rel="prefetch" href="/docs/latest/assets/js/123.43345e7d.js"><link rel="prefetch" href="/docs/latest/assets/js/124.9ef914cc.js"><link rel="prefetch" href="/docs/latest/assets/js/125.ba02abb0.js"><link rel="prefetch" href="/docs/latest/assets/js/126.0e7f9dce.js"><link rel="prefetch" href="/docs/latest/assets/js/127.b8d32dad.js"><link rel="prefetch" href="/docs/latest/assets/js/128.7ac6e558.js"><link rel="prefetch" href="/docs/latest/assets/js/129.d20213cd.js"><link rel="prefetch" href="/docs/latest/assets/js/13.40942fa2.js"><link rel="prefetch" href="/docs/latest/assets/js/130.81a05cd4.js"><link rel="prefetch" href="/docs/latest/assets/js/131.daed6849.js"><link rel="prefetch" href="/docs/latest/assets/js/132.4d47b2eb.js"><link rel="prefetch" href="/docs/latest/assets/js/133.05ab502f.js"><link rel="prefetch" href="/docs/latest/assets/js/134.83827ecd.js"><link rel="prefetch" href="/docs/latest/assets/js/135.7bff0bd7.js"><link rel="prefetch" href="/docs/latest/assets/js/136.98f8440e.js"><link rel="prefetch" href="/docs/latest/assets/js/137.aaec3459.js"><link rel="prefetch" href="/docs/latest/assets/js/138.c192277e.js"><link rel="prefetch" href="/docs/latest/assets/js/139.22d54ea6.js"><link rel="prefetch" href="/docs/latest/assets/js/14.5de42ba2.js"><link rel="prefetch" href="/docs/latest/assets/js/140.386704e4.js"><link rel="prefetch" href="/docs/latest/assets/js/141.a9195816.js"><link rel="prefetch" href="/docs/latest/assets/js/142.b78395bb.js"><link rel="prefetch" href="/docs/latest/assets/js/143.170ad88b.js"><link rel="prefetch" href="/docs/latest/assets/js/144.76e219db.js"><link rel="prefetch" href="/docs/latest/assets/js/145.191861d0.js"><link rel="prefetch" href="/docs/latest/assets/js/146.e78f7eab.js"><link rel="prefetch" href="/docs/latest/assets/js/147.aed576b7.js"><link rel="prefetch" href="/docs/latest/assets/js/148.51a28e75.js"><link rel="prefetch" href="/docs/latest/assets/js/149.bacf0bd4.js"><link rel="prefetch" href="/docs/latest/assets/js/15.012e7206.js"><link rel="prefetch" href="/docs/latest/assets/js/150.fe20362f.js"><link rel="prefetch" href="/docs/latest/assets/js/151.c05dbf6f.js"><link rel="prefetch" href="/docs/latest/assets/js/152.f99236fb.js"><link rel="prefetch" href="/docs/latest/assets/js/153.ef68597f.js"><link rel="prefetch" href="/docs/latest/assets/js/154.c023b64b.js"><link rel="prefetch" href="/docs/latest/assets/js/155.3f68a1be.js"><link rel="prefetch" href="/docs/latest/assets/js/156.66b7693f.js"><link rel="prefetch" href="/docs/latest/assets/js/157.3c0180a1.js"><link rel="prefetch" href="/docs/latest/assets/js/158.cf525578.js"><link rel="prefetch" href="/docs/latest/assets/js/159.4b37336f.js"><link rel="prefetch" href="/docs/latest/assets/js/16.a464ca3c.js"><link rel="prefetch" href="/docs/latest/assets/js/160.e108118b.js"><link rel="prefetch" href="/docs/latest/assets/js/161.aa5bb701.js"><link rel="prefetch" href="/docs/latest/assets/js/162.d16c9512.js"><link rel="prefetch" href="/docs/latest/assets/js/163.f2f33424.js"><link rel="prefetch" href="/docs/latest/assets/js/164.2d008c84.js"><link rel="prefetch" href="/docs/latest/assets/js/165.3e4e7c11.js"><link rel="prefetch" href="/docs/latest/assets/js/166.57daa7ea.js"><link rel="prefetch" href="/docs/latest/assets/js/167.f8e315e4.js"><link rel="prefetch" href="/docs/latest/assets/js/168.fdb7618a.js"><link rel="prefetch" href="/docs/latest/assets/js/169.c7aab3a9.js"><link rel="prefetch" href="/docs/latest/assets/js/17.ed55170f.js"><link rel="prefetch" href="/docs/latest/assets/js/170.d26e2242.js"><link rel="prefetch" href="/docs/latest/assets/js/171.c5b6f4a1.js"><link rel="prefetch" href="/docs/latest/assets/js/172.b564ffcb.js"><link rel="prefetch" href="/docs/latest/assets/js/173.abeba639.js"><link rel="prefetch" href="/docs/latest/assets/js/174.f93bd291.js"><link rel="prefetch" href="/docs/latest/assets/js/175.5d366e3d.js"><link rel="prefetch" href="/docs/latest/assets/js/176.e54efab4.js"><link rel="prefetch" href="/docs/latest/assets/js/177.496ceef2.js"><link rel="prefetch" href="/docs/latest/assets/js/178.12804673.js"><link rel="prefetch" href="/docs/latest/assets/js/179.32bf04c8.js"><link rel="prefetch" href="/docs/latest/assets/js/18.ba4debdf.js"><link rel="prefetch" href="/docs/latest/assets/js/180.e8f6ed27.js"><link rel="prefetch" href="/docs/latest/assets/js/181.c8978a79.js"><link rel="prefetch" href="/docs/latest/assets/js/182.63d7af06.js"><link rel="prefetch" href="/docs/latest/assets/js/183.55db8d56.js"><link rel="prefetch" href="/docs/latest/assets/js/184.18a07965.js"><link rel="prefetch" href="/docs/latest/assets/js/185.3a061aeb.js"><link rel="prefetch" href="/docs/latest/assets/js/186.a0e4fc7f.js"><link rel="prefetch" href="/docs/latest/assets/js/187.4955b620.js"><link rel="prefetch" href="/docs/latest/assets/js/188.c1eef544.js"><link rel="prefetch" href="/docs/latest/assets/js/189.a6ac08c5.js"><link rel="prefetch" href="/docs/latest/assets/js/19.5a1c7f07.js"><link rel="prefetch" href="/docs/latest/assets/js/190.02c0bd04.js"><link rel="prefetch" href="/docs/latest/assets/js/191.35859b30.js"><link rel="prefetch" href="/docs/latest/assets/js/192.605a899d.js"><link rel="prefetch" href="/docs/latest/assets/js/193.9873a5b3.js"><link rel="prefetch" href="/docs/latest/assets/js/194.f2b24cdc.js"><link rel="prefetch" href="/docs/latest/assets/js/195.24641d51.js"><link rel="prefetch" href="/docs/latest/assets/js/196.7b3fce99.js"><link rel="prefetch" href="/docs/latest/assets/js/197.f4fe5075.js"><link rel="prefetch" href="/docs/latest/assets/js/198.7361b0f4.js"><link rel="prefetch" href="/docs/latest/assets/js/199.9a52b08a.js"><link rel="prefetch" href="/docs/latest/assets/js/20.befb3878.js"><link rel="prefetch" href="/docs/latest/assets/js/200.96e5f1ed.js"><link rel="prefetch" href="/docs/latest/assets/js/201.8fb753af.js"><link rel="prefetch" href="/docs/latest/assets/js/202.546fb27c.js"><link rel="prefetch" href="/docs/latest/assets/js/203.c0a58e57.js"><link rel="prefetch" href="/docs/latest/assets/js/204.f3dcd08d.js"><link rel="prefetch" href="/docs/latest/assets/js/205.e39e6cc0.js"><link rel="prefetch" href="/docs/latest/assets/js/206.2040b423.js"><link rel="prefetch" href="/docs/latest/assets/js/207.d3de4a57.js"><link rel="prefetch" href="/docs/latest/assets/js/208.28fe0256.js"><link rel="prefetch" href="/docs/latest/assets/js/209.9be0ffc2.js"><link rel="prefetch" href="/docs/latest/assets/js/21.e052604d.js"><link rel="prefetch" href="/docs/latest/assets/js/210.4a57137a.js"><link rel="prefetch" href="/docs/latest/assets/js/211.17e55bd6.js"><link rel="prefetch" href="/docs/latest/assets/js/212.1c8d2acd.js"><link rel="prefetch" href="/docs/latest/assets/js/213.2dbf6c1c.js"><link rel="prefetch" href="/docs/latest/assets/js/214.2f1440f9.js"><link rel="prefetch" href="/docs/latest/assets/js/215.11ed947f.js"><link rel="prefetch" href="/docs/latest/assets/js/216.74863e9d.js"><link rel="prefetch" href="/docs/latest/assets/js/217.a8419f14.js"><link rel="prefetch" href="/docs/latest/assets/js/218.6bf9fc78.js"><link rel="prefetch" href="/docs/latest/assets/js/219.0169da15.js"><link rel="prefetch" href="/docs/latest/assets/js/22.28f307d4.js"><link rel="prefetch" href="/docs/latest/assets/js/220.c575f379.js"><link rel="prefetch" href="/docs/latest/assets/js/221.2947993e.js"><link rel="prefetch" href="/docs/latest/assets/js/222.2afa8e58.js"><link rel="prefetch" href="/docs/latest/assets/js/223.123abe52.js"><link rel="prefetch" href="/docs/latest/assets/js/224.93f4958f.js"><link rel="prefetch" href="/docs/latest/assets/js/225.a679632e.js"><link rel="prefetch" href="/docs/latest/assets/js/226.1f372629.js"><link rel="prefetch" href="/docs/latest/assets/js/227.01f26922.js"><link rel="prefetch" href="/docs/latest/assets/js/228.5b8a33de.js"><link rel="prefetch" href="/docs/latest/assets/js/229.2c43b3bd.js"><link rel="prefetch" href="/docs/latest/assets/js/23.2c1803cf.js"><link rel="prefetch" href="/docs/latest/assets/js/230.f6aef453.js"><link rel="prefetch" href="/docs/latest/assets/js/231.cb4e528d.js"><link rel="prefetch" href="/docs/latest/assets/js/232.ff3c6c5a.js"><link rel="prefetch" href="/docs/latest/assets/js/233.a09dfb10.js"><link rel="prefetch" href="/docs/latest/assets/js/234.16f55136.js"><link rel="prefetch" href="/docs/latest/assets/js/235.96d6441a.js"><link rel="prefetch" href="/docs/latest/assets/js/236.48813a68.js"><link rel="prefetch" href="/docs/latest/assets/js/237.f990a1ec.js"><link rel="prefetch" href="/docs/latest/assets/js/238.e5b4f649.js"><link rel="prefetch" href="/docs/latest/assets/js/239.291dc9f2.js"><link rel="prefetch" href="/docs/latest/assets/js/24.77df6298.js"><link rel="prefetch" href="/docs/latest/assets/js/240.8103995d.js"><link rel="prefetch" href="/docs/latest/assets/js/241.77f1ef6d.js"><link rel="prefetch" href="/docs/latest/assets/js/242.ec2780d4.js"><link rel="prefetch" href="/docs/latest/assets/js/243.37cf3af4.js"><link rel="prefetch" href="/docs/latest/assets/js/244.8dd0e249.js"><link rel="prefetch" href="/docs/latest/assets/js/245.6be09f0f.js"><link rel="prefetch" href="/docs/latest/assets/js/246.f8d4fa7a.js"><link rel="prefetch" href="/docs/latest/assets/js/247.42420fdd.js"><link rel="prefetch" href="/docs/latest/assets/js/248.c23ee98d.js"><link rel="prefetch" href="/docs/latest/assets/js/249.ab477af3.js"><link rel="prefetch" href="/docs/latest/assets/js/25.c7de846b.js"><link rel="prefetch" href="/docs/latest/assets/js/250.6e8d2ba3.js"><link rel="prefetch" href="/docs/latest/assets/js/251.b6b2f974.js"><link rel="prefetch" href="/docs/latest/assets/js/252.8ff946bc.js"><link rel="prefetch" href="/docs/latest/assets/js/253.16fcc019.js"><link rel="prefetch" href="/docs/latest/assets/js/254.b8ab3153.js"><link rel="prefetch" href="/docs/latest/assets/js/255.c6168ca8.js"><link rel="prefetch" href="/docs/latest/assets/js/256.8f91fc92.js"><link rel="prefetch" href="/docs/latest/assets/js/257.9d3758c5.js"><link rel="prefetch" href="/docs/latest/assets/js/258.cd89cf43.js"><link rel="prefetch" href="/docs/latest/assets/js/259.61dbc16e.js"><link rel="prefetch" href="/docs/latest/assets/js/26.03fea601.js"><link rel="prefetch" href="/docs/latest/assets/js/260.59b86bdc.js"><link rel="prefetch" href="/docs/latest/assets/js/261.e678254e.js"><link rel="prefetch" href="/docs/latest/assets/js/262.ce0c9d58.js"><link rel="prefetch" href="/docs/latest/assets/js/263.02a09c3e.js"><link rel="prefetch" href="/docs/latest/assets/js/264.9e7aa5e6.js"><link rel="prefetch" href="/docs/latest/assets/js/265.caa756fe.js"><link rel="prefetch" href="/docs/latest/assets/js/266.6e310b52.js"><link rel="prefetch" href="/docs/latest/assets/js/267.c48b8214.js"><link rel="prefetch" href="/docs/latest/assets/js/268.77c31416.js"><link rel="prefetch" href="/docs/latest/assets/js/27.a0d9661b.js"><link rel="prefetch" href="/docs/latest/assets/js/28.c2bbd22e.js"><link rel="prefetch" href="/docs/latest/assets/js/29.edc6cdb1.js"><link rel="prefetch" href="/docs/latest/assets/js/3.bb127fce.js"><link rel="prefetch" href="/docs/latest/assets/js/30.58943817.js"><link rel="prefetch" href="/docs/latest/assets/js/31.05bf300d.js"><link rel="prefetch" href="/docs/latest/assets/js/32.86c21b69.js"><link rel="prefetch" href="/docs/latest/assets/js/33.a04bc030.js"><link rel="prefetch" href="/docs/latest/assets/js/34.9261e152.js"><link rel="prefetch" href="/docs/latest/assets/js/35.9f137c62.js"><link rel="prefetch" href="/docs/latest/assets/js/36.b63af66d.js"><link rel="prefetch" href="/docs/latest/assets/js/37.f571e398.js"><link rel="prefetch" href="/docs/latest/assets/js/38.e0ccae6b.js"><link rel="prefetch" href="/docs/latest/assets/js/39.6686479c.js"><link rel="prefetch" href="/docs/latest/assets/js/4.5897c077.js"><link rel="prefetch" href="/docs/latest/assets/js/40.d2ea3899.js"><link rel="prefetch" href="/docs/latest/assets/js/41.70418b50.js"><link rel="prefetch" href="/docs/latest/assets/js/42.4ff9f3d5.js"><link rel="prefetch" href="/docs/latest/assets/js/43.bf702a0d.js"><link rel="prefetch" href="/docs/latest/assets/js/44.c9410168.js"><link rel="prefetch" href="/docs/latest/assets/js/45.a3605880.js"><link rel="prefetch" href="/docs/latest/assets/js/46.23692797.js"><link rel="prefetch" href="/docs/latest/assets/js/47.6078eee1.js"><link rel="prefetch" href="/docs/latest/assets/js/48.a071f769.js"><link rel="prefetch" href="/docs/latest/assets/js/49.211def19.js"><link rel="prefetch" href="/docs/latest/assets/js/50.0c989648.js"><link rel="prefetch" href="/docs/latest/assets/js/51.57b0568d.js"><link rel="prefetch" href="/docs/latest/assets/js/52.821bc064.js"><link rel="prefetch" href="/docs/latest/assets/js/53.a10f3570.js"><link rel="prefetch" href="/docs/latest/assets/js/54.e364607e.js"><link rel="prefetch" href="/docs/latest/assets/js/55.74f20f58.js"><link rel="prefetch" href="/docs/latest/assets/js/56.9bb69bd9.js"><link rel="prefetch" href="/docs/latest/assets/js/57.d13e1f2c.js"><link rel="prefetch" href="/docs/latest/assets/js/58.ae64ef04.js"><link rel="prefetch" href="/docs/latest/assets/js/59.18fb0daf.js"><link rel="prefetch" href="/docs/latest/assets/js/6.6a7a006f.js"><link rel="prefetch" href="/docs/latest/assets/js/60.e1b75e7e.js"><link rel="prefetch" href="/docs/latest/assets/js/61.6e22e73d.js"><link rel="prefetch" href="/docs/latest/assets/js/62.2c43dacd.js"><link rel="prefetch" href="/docs/latest/assets/js/63.3e5c59ef.js"><link rel="prefetch" href="/docs/latest/assets/js/64.7e7d10cb.js"><link rel="prefetch" href="/docs/latest/assets/js/65.6d7b327c.js"><link rel="prefetch" href="/docs/latest/assets/js/66.47306b72.js"><link rel="prefetch" href="/docs/latest/assets/js/67.ef802daf.js"><link rel="prefetch" href="/docs/latest/assets/js/68.4c36f508.js"><link rel="prefetch" href="/docs/latest/assets/js/69.6884afc3.js"><link rel="prefetch" href="/docs/latest/assets/js/7.2b9bb0cc.js"><link rel="prefetch" href="/docs/latest/assets/js/70.753aeeeb.js"><link rel="prefetch" href="/docs/latest/assets/js/71.02132ae7.js"><link rel="prefetch" href="/docs/latest/assets/js/72.93a262fa.js"><link rel="prefetch" href="/docs/latest/assets/js/73.63823760.js"><link rel="prefetch" href="/docs/latest/assets/js/74.8bbf353a.js"><link rel="prefetch" href="/docs/latest/assets/js/75.4b40b642.js"><link rel="prefetch" href="/docs/latest/assets/js/76.87207961.js"><link rel="prefetch" href="/docs/latest/assets/js/77.74919e96.js"><link rel="prefetch" href="/docs/latest/assets/js/78.7690f014.js"><link rel="prefetch" href="/docs/latest/assets/js/79.e269897b.js"><link rel="prefetch" href="/docs/latest/assets/js/8.e267e498.js"><link rel="prefetch" href="/docs/latest/assets/js/80.e6365a67.js"><link rel="prefetch" href="/docs/latest/assets/js/81.333a82f2.js"><link rel="prefetch" href="/docs/latest/assets/js/82.d944b8b9.js"><link rel="prefetch" href="/docs/latest/assets/js/83.c27c28df.js"><link rel="prefetch" href="/docs/latest/assets/js/84.9e1ca72d.js"><link rel="prefetch" href="/docs/latest/assets/js/85.8aed2510.js"><link rel="prefetch" href="/docs/latest/assets/js/86.13b36328.js"><link rel="prefetch" href="/docs/latest/assets/js/87.a66620db.js"><link rel="prefetch" href="/docs/latest/assets/js/88.d2527a78.js"><link rel="prefetch" href="/docs/latest/assets/js/89.45cfdeb3.js"><link rel="prefetch" href="/docs/latest/assets/js/9.3427a556.js"><link rel="prefetch" href="/docs/latest/assets/js/90.5793b0b0.js"><link rel="prefetch" href="/docs/latest/assets/js/91.292294a6.js"><link rel="prefetch" href="/docs/latest/assets/js/92.26377cb3.js"><link rel="prefetch" href="/docs/latest/assets/js/93.b98fe0e9.js"><link rel="prefetch" href="/docs/latest/assets/js/94.d98598be.js"><link rel="prefetch" href="/docs/latest/assets/js/95.e241010d.js"><link rel="prefetch" href="/docs/latest/assets/js/96.e2a1f228.js"><link rel="prefetch" href="/docs/latest/assets/js/97.383a3a23.js"><link rel="prefetch" href="/docs/latest/assets/js/98.ad06bcf6.js"><link rel="prefetch" href="/docs/latest/assets/js/99.809adbec.js">
<link rel="stylesheet" href="/docs/latest/assets/css/0.styles.6dc2f403.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/latest/" class="home-link router-link-active"><img src="/docs/latest/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/latest/" class="nav-link">
Home
</a></div><div class="nav-item"><a href="/docs/latest/api/" class="nav-link">
API
</a></div><div class="nav-item"><a href="/docs/latest/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://discord.gg/HxEguTK6av" target="_blank" rel="noopener noreferrer" class="nav-link external">
Discord
<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/latest/" class="nav-link">
Home
</a></div><div class="nav-item"><a href="/docs/latest/api/" class="nav-link">
API
</a></div><div class="nav-item"><a href="/docs/latest/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://discord.gg/HxEguTK6av" target="_blank" rel="noopener noreferrer" class="nav-link external">
Discord
<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/latest/" 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/latest/developers/" aria-current="page" class="sidebar-link">Developers</a></li><li><a href="/docs/latest/developers/api.html" class="sidebar-link">API</a></li><li><a href="/docs/latest/developers/axes.html" class="sidebar-link">New Axes</a></li><li><a href="/docs/latest/developers/charts.html" class="sidebar-link">New Charts</a></li><li><a href="/docs/latest/developers/contributing.html" class="sidebar-link">Contributing</a></li><li><a href="/docs/latest/developers/plugins.html" aria-current="page" class="active sidebar-link">Plugins</a></li><li><a href="/docs/latest/developers/publishing.html" class="sidebar-link">Publishing an extension</a></li><li><a href="/docs/latest/api/" class="sidebar-link">TypeDoc</a></li><li><a href="/docs/latest/developers/updates.html" class="sidebar-link">Updating Charts</a></li></ul></section></li><li><section class="sidebar-group collapsable depth-0"><p class="sidebar-heading"><span>Migration</span> <span class="arrow right"></span></p> <!----></section></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h1 id="plugins"><a href="#plugins" class="header-anchor">#</a> Plugins</h1> <p>Plugins are the most efficient way to customize or change the default behavior of a chart. They have been introduced at <a href="https://github.com/chartjs/Chart.js/releases/tag/2.1.0" target="_blank" rel="noopener noreferrer">version 2.1.0<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> (global plugins only) and extended at <a href="https://github.com/chartjs/Chart.js/releases/tag/v2.5.0" target="_blank" rel="noopener noreferrer">version 2.5.0<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> (per chart plugins and options).</p> <h2 id="using-plugins"><a href="#using-plugins" class="header-anchor">#</a> Using plugins</h2> <p>Plugins can be shared between chart instances:</p> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token keyword">const</span> plugin <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token comment">/* plugin implementation */</span> <span class="token punctuation">}</span><span class="token punctuation">;</span>
<span class="token comment">// chart1 and chart2 use "plugin"</span>
<span class="token keyword">const</span> chart1 <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> <span class="token punctuation">{</span>
<span class="token literal-property property">plugins</span><span class="token operator">:</span> <span class="token punctuation">[</span>plugin<span class="token punctuation">]</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token keyword">const</span> chart2 <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> <span class="token punctuation">{</span>
<span class="token literal-property property">plugins</span><span class="token operator">:</span> <span class="token punctuation">[</span>plugin<span class="token punctuation">]</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token comment">// chart3 doesn't use "plugin"</span>
<span class="token keyword">const</span> chart3 <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> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><p>Plugins can also be defined directly in the chart <code>plugins</code> config (a.k.a. <em>inline plugins</em>):</p> <div class="custom-block warning"><p class="custom-block-title">WARNING</p> <p><em>inline</em> plugins are not registered. Some plugins require registering, i.e. can't be used <em>inline</em>.</p></div> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token keyword">const</span> chart <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> <span class="token punctuation">{</span>
<span class="token literal-property property">plugins</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token punctuation">{</span>
<span class="token function-variable function">beforeInit</span><span class="token operator">:</span> <span class="token keyword">function</span><span class="token punctuation">(</span><span class="token parameter">chart<span class="token punctuation">,</span> args<span class="token punctuation">,</span> options</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
<span class="token comment">//..</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><span class="token punctuation">;</span>
</code></pre></div><p>However, this approach is not ideal when the customization needs to apply to many charts.</p> <h2 id="global-plugins"><a href="#global-plugins" class="header-anchor">#</a> Global plugins</h2> <p>Plugins can be registered globally to be applied on all charts (a.k.a. <em>global plugins</em>):</p> <div class="language-javascript extra-class"><pre class="language-javascript"><code>Chart<span class="token punctuation">.</span><span class="token function">register</span><span class="token punctuation">(</span><span class="token punctuation">{</span>
<span class="token comment">// plugin implementation</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><div class="custom-block warning"><p class="custom-block-title">WARNING</p> <p><em>inline</em> plugins can't be registered globally.</p></div> <h2 id="configuration"><a href="#configuration" class="header-anchor">#</a> Configuration</h2> <h3 id="plugin-id"><a href="#plugin-id" class="header-anchor">#</a> Plugin ID</h3> <p>Plugins must define a unique id in order to be configurable.</p> <p>This id should follow the <a href="https://docs.npmjs.com/files/package.json#name" target="_blank" rel="noopener noreferrer">npm package name convention<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> <ul><li>can't start with a dot or an underscore</li> <li>can't contain any non-URL-safe characters</li> <li>can't contain uppercase letters</li> <li>should be something short, but also reasonably descriptive</li></ul> <p>If a plugin is intended to be released publicly, you may want to check the <a href="https://www.npmjs.com/search?q=chartjs-plugin-" target="_blank" rel="noopener noreferrer">registry<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> to see if there's something by that name already. Note that in this case, the package name should be prefixed by <code>chartjs-plugin-</code> to appear in Chart.js plugin registry.</p> <h3 id="plugin-options"><a href="#plugin-options" class="header-anchor">#</a> Plugin options</h3> <p>Plugin options are located under the <code>options.plugins</code> config and are scoped by the plugin ID: <code>options.plugins.{plugin-id}</code>.</p> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token keyword">const</span> chart <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> <span class="token punctuation">{</span>
<span class="token literal-property property">options</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token literal-property property">foo</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token operator">...</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token comment">// chart 'foo' option</span>
<span class="token literal-property property">plugins</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token literal-property property">p1</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token literal-property property">foo</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token operator">...</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token comment">// p1 plugin 'foo' option</span>
<span class="token literal-property property">bar</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token operator">...</span> <span class="token punctuation">}</span>
<span class="token punctuation">}</span><span class="token punctuation">,</span>
<span class="token literal-property property">p2</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token literal-property property">foo</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token operator">...</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token comment">// p2 plugin 'foo' option</span>
<span class="token literal-property property">bla</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token operator">...</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><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><h4 id="disable-plugins"><a href="#disable-plugins" class="header-anchor">#</a> Disable plugins</h4> <p>To disable a global plugin for a specific chart instance, the plugin options must be set to <code>false</code>:</p> <div class="language-javascript extra-class"><pre class="language-javascript"><code>Chart<span class="token punctuation">.</span><span class="token function">register</span><span class="token punctuation">(</span><span class="token punctuation">{</span>
<span class="token literal-property property">id</span><span class="token operator">:</span> <span class="token string">'p1'</span><span class="token punctuation">,</span>
<span class="token comment">// ...</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token keyword">const</span> chart <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> <span class="token punctuation">{</span>
<span class="token literal-property property">options</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token literal-property property">plugins</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token literal-property property">p1</span><span class="token operator">:</span> <span class="token boolean">false</span> <span class="token comment">// disable plugin 'p1' for this instance</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><p>To disable all plugins for a specific chart instance, set <code>options.plugins</code> to <code>false</code>:</p> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token keyword">const</span> chart <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> <span class="token punctuation">{</span>
<span class="token literal-property property">options</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token literal-property property">plugins</span><span class="token operator">:</span> <span class="token boolean">false</span> <span class="token comment">// all plugins are disabled for this instance</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><h4 id="plugin-defaults"><a href="#plugin-defaults" class="header-anchor">#</a> Plugin defaults</h4> <p>You can set default values for your plugin options in the <code>defaults</code> entry of your plugin object. In the example below the canvas will always have a lightgreen backgroundColor unless the user overrides this option in <code>options.plugins.custom_canvas_background_color.color</code>.</p> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token keyword">const</span> plugin <span class="token operator">=</span> <span class="token punctuation">{</span>
<span class="token literal-property property">id</span><span class="token operator">:</span> <span class="token string">'custom_canvas_background_color'</span><span class="token punctuation">,</span>
<span class="token function-variable function">beforeDraw</span><span class="token operator">:</span> <span class="token punctuation">(</span><span class="token parameter">chart<span class="token punctuation">,</span> args<span class="token punctuation">,</span> options</span><span class="token punctuation">)</span> <span class="token operator">=></span> <span class="token punctuation">{</span>
<span class="token keyword">const</span> <span class="token punctuation">{</span>ctx<span class="token punctuation">}</span> <span class="token operator">=</span> chart<span class="token punctuation">;</span>
ctx<span class="token punctuation">.</span><span class="token function">save</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
ctx<span class="token punctuation">.</span>globalCompositeOperation <span class="token operator">=</span> <span class="token string">'destination-over'</span><span class="token punctuation">;</span>
ctx<span class="token punctuation">.</span>fillStyle <span class="token operator">=</span> options<span class="token punctuation">.</span>color<span class="token punctuation">;</span>
ctx<span class="token punctuation">.</span><span class="token function">fillRect</span><span class="token punctuation">(</span><span class="token number">0</span><span class="token punctuation">,</span> <span class="token number">0</span><span class="token punctuation">,</span> chart<span class="token punctuation">.</span>width<span class="token punctuation">,</span> chart<span class="token punctuation">.</span>height<span class="token punctuation">)</span><span class="token punctuation">;</span>
ctx<span class="token punctuation">.</span><span class="token function">restore</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>
<span class="token literal-property property">defaults</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token literal-property property">color</span><span class="token operator">:</span> <span class="token string">'lightGreen'</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
</code></pre></div><h2 id="plugin-core-api"><a href="#plugin-core-api" class="header-anchor">#</a> Plugin Core API</h2> <p>Read more about the <a href="../api/interfaces/Plugin">existing plugin extension hooks</a>.</p> <h3 id="chart-initialization"><a href="#chart-initialization" class="header-anchor">#</a> Chart Initialization</h3> <p>Plugins are notified during the initialization process. These hooks can be used to set up data needed for the plugin to operate.</p> <p><img src="/docs/latest/assets/img/init_flowchart.eb121648.png" alt="Chart.js init flowchart"></p> <h3 id="chart-update"><a href="#chart-update" class="header-anchor">#</a> Chart Update</h3> <p>Plugins are notified throughout the update process.</p> <p><img src="/docs/latest/assets/img/update_flowchart.1b5eb647.png" alt="Chart.js update flowchart"></p> <h3 id="scale-update"><a href="#scale-update" class="header-anchor">#</a> Scale Update</h3> <p>Plugins are notified throughout the scale update process.</p> <p><img src="/docs/latest/assets/img/scale_flowchart.4706a651.png" alt="Chart.js scale update flowchart"></p> <h3 id="rendering"><a href="#rendering" class="header-anchor">#</a> Rendering</h3> <p>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 <code>false</code> from a hook. Not all hooks are cancelable, however, in general most <code>before*</code> hooks can be cancelled.</p> <p><img src="/docs/latest/assets/img/render_flowchart.807adfd0.png" alt="Chart.js render pipeline flowchart"></p> <h3 id="event-handling"><a href="#event-handling" class="header-anchor">#</a> Event Handling</h3> <p>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 <code>args.changed</code> to <code>true</code> to indicate that a render is needed. The built-in tooltip plugin uses this method to indicate when the tooltip has changed.</p> <p><img src="/docs/latest/assets/img/event_flowchart.69e972a2.png" alt="Chart.js event handling flowchart"></p> <h3 id="chart-destroy"><a href="#chart-destroy" class="header-anchor">#</a> Chart destroy</h3> <p>Plugins are notified during the destroy process. These hooks can be used to destroy things that the plugin made and used during its life.
The <code>destroy</code> hook has been deprecated since Chart.js version 3.7.0, use the <code>afterDestroy</code> hook instead.</p> <p><img src="/docs/latest/assets/img/destroy_flowchart.ab27c949.png" alt="Chart.js destroy flowchart"></p> <h2 id="typescript-typings"><a href="#typescript-typings" class="header-anchor">#</a> TypeScript Typings</h2> <p>If you want your plugin to be statically typed, you must provide a <code>.d.ts</code> TypeScript declaration file. Chart.js provides a way to augment built-in types with user-defined ones, by using the concept of "declaration merging".</p> <p>When adding a plugin, <code>PluginOptionsByType</code> must contain the declarations for the plugin.</p> <p>For example, to provide typings for the <a href="/docs/latest/configuration/canvas-background.html"><code>canvas backgroundColor plugin</code></a>, you would add a <code>.d.ts</code> containing:</p> <div class="language-ts extra-class"><pre class="language-ts"><code><span class="token keyword">import</span> <span class="token punctuation">{</span>ChartType<span class="token punctuation">,</span> Plugin<span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'chart.js'</span><span class="token punctuation">;</span>
<span class="token keyword">declare</span> <span class="token keyword">module</span> <span class="token string">'chart.js'</span> <span class="token punctuation">{</span>
<span class="token keyword">interface</span> <span class="token class-name">PluginOptionsByType<span class="token operator"><</span>TType <span class="token keyword">extends</span> ChartType<span class="token operator">></span></span> <span class="token punctuation">{</span>
customCanvasBackgroundColor<span class="token operator">?</span><span class="token operator">:</span> <span class="token punctuation">{</span>
color<span class="token operator">?</span><span class="token operator">:</span> <span class="token builtin">string</span>
<span class="token punctuation">}</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/15/2025, 1:19:05 PM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
←
<a href="/docs/latest/developers/contributing.html" class="prev">
Contributing
</a></span> <span class="next"><a href="/docs/latest/developers/publishing.html">
Publishing an extension
</a>
→
</span></p></div> </main></div><div class="global-ui"></div></div>
<script src="/docs/latest/assets/js/app.1775731d.js" defer></script><script src="/docs/latest/assets/js/2.2c2b1036.js" defer></script><script src="/docs/latest/assets/js/5.ed1eea17.js" defer></script>
</body>
</html>