docs/4.1.0/developers/plugins.html

<!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.7">
    <link rel="icon" href="/docs/4.1.0/favicon.ico">
    <meta name="description" content="Open source HTML5 Charts for your website">
    <link rel="preload" href="/docs/4.1.0/assets/css/0.styles.b07f9cc4.css" as="style"><link rel="preload" href="/docs/4.1.0/assets/js/app.23f15684.js" as="script"><link rel="preload" href="/docs/4.1.0/assets/js/2.861276ab.js" as="script"><link rel="preload" href="/docs/4.1.0/assets/js/5.4f0dea0c.js" as="script"><link rel="prefetch" href="/docs/4.1.0/assets/js/10.9fed78f4.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/100.42f8240f.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/101.b0147e79.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/102.0cdd1d64.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/103.24d3966c.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/104.2415b9d0.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/105.44985153.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/106.c5bd1f53.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/107.c220e025.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/108.54b6b1e5.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/109.8cf49065.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/11.f7bad5a0.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/110.3401019f.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/111.57bea290.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/112.373de2aa.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/113.24b73a0e.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/114.5bee1f5d.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/115.716954f6.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/116.c90faf11.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/117.c5f08d6b.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/118.a0681447.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/119.3290dce7.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/12.d1cd7535.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/120.07c2bea5.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/121.70b8509d.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/122.f5806e83.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/123.11922ee8.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/124.ce833c0d.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/125.e10a4f9a.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/126.4f9fe141.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/127.8c7bcb27.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/128.58509695.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/129.196f7c55.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/13.f5354cb1.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/130.0dbb661e.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/131.9d1a21a6.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/132.d2e92560.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/133.9a3b1c2e.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/134.904c6cf2.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/135.060a7375.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/136.3849ca1a.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/137.6b9f954f.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/138.86be75a3.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/139.dc78c6c9.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/14.912a0e5c.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/140.1c4d4a1b.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/141.61a3988c.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/142.75072126.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/143.41c6b642.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/144.6edafcc3.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/145.57007327.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/146.69f2f5e5.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/147.13b40912.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/148.27dc82cd.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/149.1ef9d1e6.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/15.cf8fca08.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/150.dad8ab1f.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/151.485a4ff9.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/152.40b16806.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/153.16cd7df9.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/154.8542aa38.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/155.daed796e.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/156.1a537bd0.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/157.aa83f4d8.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/158.21e098e5.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/159.fe339cd1.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/16.bc64e74e.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/160.7b5b9c4c.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/161.6bcfbc14.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/162.fc788691.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/163.a314f02f.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/164.52f687b2.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/165.cacf7508.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/166.5fb61b31.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/167.3f7ec546.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/168.4c4af271.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/169.dd3c6a98.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/17.3df70609.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/170.5f8d4bb3.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/171.f459b446.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/172.ee2ff8fe.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/173.e680c85f.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/174.16cb43c4.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/175.9dd033d4.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/176.d7827515.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/177.3c815f39.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/178.eceb64e1.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/179.3667de7e.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/18.eddad969.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/180.0e909568.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/181.68dede78.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/182.051224a9.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/183.4e09fa32.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/184.4f34c4bf.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/185.8ca0e6d9.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/186.43c7a8a7.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/187.64d9ce7b.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/188.f89da720.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/189.c46547b2.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/19.e2a0b269.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/190.647878dd.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/191.a354d366.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/192.e61a651b.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/193.a5a1faad.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/194.46baf28d.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/195.ce0bfeb7.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/196.d1a9e60c.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/197.54b6f6c8.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/198.3a3ee80f.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/199.0fd9b548.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/20.6ee3591d.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/200.99b23980.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/201.94c1daf1.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/202.2341d7f4.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/203.6ae7bd88.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/204.37cb642e.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/205.99194041.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/206.abdcc90f.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/207.0c092897.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/208.f9e984d7.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/209.333bf761.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/21.e407453c.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/210.63c3b3fc.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/211.d2ed2f86.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/212.91f9d72f.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/213.3757e24e.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/214.f4713883.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/215.f74b388b.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/216.4e54a2ae.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/217.f4239d9d.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/218.c99f1a5a.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/219.7b4825c3.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/22.52de3124.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/220.a53c4a5e.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/221.1e08bba0.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/222.3690521a.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/223.4ffdf276.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/224.26c06b5f.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/225.08f88647.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/226.df61be6e.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/227.a681b1e7.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/228.23b4788c.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/229.a5fc7901.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/23.f2ca6593.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/230.7bcb6877.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/231.b0751192.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/232.c98f831c.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/233.784f26cc.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/234.bf160226.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/235.ed3108cf.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/236.7dc19d2c.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/237.fdf97edc.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/238.c0929486.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/239.00ac9993.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/24.e17c2894.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/240.5275c19c.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/241.911b29d2.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/242.0a6889fc.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/243.c541ab5c.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/244.24465d45.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/245.5b25cbc0.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/246.3a77ff1f.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/247.1edd389e.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/248.d2b17c58.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/249.b7d8cc51.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/25.c859b292.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/250.b5c9e303.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/251.5a1fd2b3.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/252.64ef116d.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/253.0ce50394.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/254.fc4cbd2c.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/255.803f3453.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/256.a0afd895.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/257.5c597d15.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/258.d88e07ca.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/259.ff180495.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/26.fb774aa1.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/260.2975ad4f.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/261.0c5823a4.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/262.db4ef337.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/27.336298bf.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/28.f1f530dd.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/29.a4b4204a.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/3.6e775090.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/30.3d92987c.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/31.673bc19d.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/32.678d632b.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/33.e509e152.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/34.04484f3e.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/35.de6467be.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/36.4fee582d.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/37.3633ea4d.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/38.cd88f6bb.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/39.5259c8fd.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/4.97ecce63.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/40.eeabc42e.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/41.c175edf9.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/42.c4ad295f.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/43.fc80c8f1.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/44.2ecbcf3f.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/45.d302678e.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/46.11070afa.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/47.ab63184b.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/48.dcb78d20.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/49.d189d427.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/50.37e6660b.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/51.3b47e6a6.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/52.58c272e5.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/53.49bd0a29.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/54.7dede1b5.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/55.1c51759d.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/56.5f076f17.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/57.5779fe0f.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/58.37f1bfca.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/59.b9872cdd.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/6.d0ec61f2.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/60.37e50c03.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/61.69cb925d.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/62.5dbaf11a.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/63.c673924a.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/64.9aad5f2c.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/65.b11bf875.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/66.589ff530.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/67.ba687869.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/68.9972f3ab.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/69.b70c147a.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/7.4d1b3ed0.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/70.c195dbf7.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/71.f64ac86d.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/72.c20bae52.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/73.8909ebd9.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/74.213f0bc4.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/75.658a4297.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/76.906eae03.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/77.874158ee.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/78.a2dc18e2.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/79.a269d79a.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/8.d1642230.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/80.9d02a810.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/81.8e76a04d.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/82.19a178e5.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/83.aa25c024.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/84.e7be0614.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/85.d3f936d0.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/86.25c065f1.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/87.3cf4e93b.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/88.4509598f.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/89.162e29b3.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/9.6cd2720a.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/90.475c06fe.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/91.055f4472.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/92.748959da.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/93.ca805a29.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/94.7a1638c7.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/95.968e0341.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/96.5e97f8c9.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/97.5b4be278.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/98.e7e366c3.js"><link rel="prefetch" href="/docs/4.1.0/assets/js/99.f12dbb12.js">
    <link rel="stylesheet" href="/docs/4.1.0/assets/css/0.styles.b07f9cc4.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/4.1.0/" class="home-link router-link-active"><img src="/docs/4.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/4.1.0/" class="nav-link">
  Home
</a></div><div class="nav-item"><a href="/docs/4.1.0/api/" class="nav-link">
  API
</a></div><div class="nav-item"><a href="/docs/4.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://join.slack.com/t/chartjs/shared_invite/zt-1lo81skkk-AZk6ollhOdrjt9GzPeOsLw" 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/4.1.0/" class="nav-link">
  Home
</a></div><div class="nav-item"><a href="/docs/4.1.0/api/" class="nav-link">
  API
</a></div><div class="nav-item"><a href="/docs/4.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://join.slack.com/t/chartjs/shared_invite/zt-1lo81skkk-AZk6ollhOdrjt9GzPeOsLw" 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/4.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/4.1.0/developers/" aria-current="page" class="sidebar-link">Developers</a></li><li><a href="/docs/4.1.0/developers/api.html" class="sidebar-link">API</a></li><li><a href="/docs/4.1.0/developers/axes.html" class="sidebar-link">New Axes</a></li><li><a href="/docs/4.1.0/developers/charts.html" class="sidebar-link">New Charts</a></li><li><a href="/docs/4.1.0/developers/contributing.html" class="sidebar-link">Contributing</a></li><li><a href="/docs/4.1.0/developers/plugins.html" aria-current="page" class="active sidebar-link">Plugins</a></li><li><a href="/docs/4.1.0/developers/publishing.html" class="sidebar-link">Publishing an extension</a></li><li><a href="/docs/4.1.0/api/" class="sidebar-link">TypeDoc</a></li><li><a href="/docs/4.1.0/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 &quot;plugin&quot;</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 &quot;plugin&quot;</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">=&gt;</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/4.1.0/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/4.1.0/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/4.1.0/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/4.1.0/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/4.1.0/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/4.1.0/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 &quot;declaration merging&quot;.</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/4.1.0/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">&lt;</span>TType <span class="token keyword">extends</span> ChartType<span class="token operator">&gt;</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">12/16/2022, 6:36:14 AM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
      ←
      <a href="/docs/4.1.0/developers/contributing.html" class="prev">
        Contributing
      </a></span> <span class="next"><a href="/docs/4.1.0/developers/publishing.html">
        Publishing an extension
      </a>
      →
    </span></p></div> </main></div><div class="global-ui"></div></div>
    <script src="/docs/4.1.0/assets/js/app.23f15684.js" defer></script><script src="/docs/4.1.0/assets/js/2.861276ab.js" defer></script><script src="/docs/4.1.0/assets/js/5.4f0dea0c.js" defer></script>
  </body>
</html>