docs/next/configuration/tooltip.html

<!DOCTYPE html>
<html lang="en-US">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width,initial-scale=1">
    <title>Tooltip | Chart.js</title>
    <meta name="generator" content="VuePress 1.9.7">
    <link rel="icon" href="/docs/next/favicon.ico">
    <meta name="description" content="Open source HTML5 Charts for your website">
    <link rel="preload" href="/docs/next/assets/css/0.styles.32b47955.css" as="style"><link rel="preload" href="/docs/next/assets/js/app.79ca5bdb.js" as="script"><link rel="preload" href="/docs/next/assets/js/2.5288603d.js" as="script"><link rel="preload" href="/docs/next/assets/js/166.81f1fd29.js" as="script"><link rel="prefetch" href="/docs/next/assets/js/10.fb5e13f1.js"><link rel="prefetch" href="/docs/next/assets/js/100.29d79c56.js"><link rel="prefetch" href="/docs/next/assets/js/101.9684e51f.js"><link rel="prefetch" href="/docs/next/assets/js/102.0d12d2f7.js"><link rel="prefetch" href="/docs/next/assets/js/103.100effdb.js"><link rel="prefetch" href="/docs/next/assets/js/104.24a8af70.js"><link rel="prefetch" href="/docs/next/assets/js/105.2c90bfa6.js"><link rel="prefetch" href="/docs/next/assets/js/106.35728af1.js"><link rel="prefetch" href="/docs/next/assets/js/107.0b85f7c5.js"><link rel="prefetch" href="/docs/next/assets/js/108.445273e7.js"><link rel="prefetch" href="/docs/next/assets/js/109.0b503640.js"><link rel="prefetch" href="/docs/next/assets/js/11.7083b42b.js"><link rel="prefetch" href="/docs/next/assets/js/110.284b9fef.js"><link rel="prefetch" href="/docs/next/assets/js/111.2aaeed25.js"><link rel="prefetch" href="/docs/next/assets/js/112.6307ce4c.js"><link rel="prefetch" href="/docs/next/assets/js/113.ecc135a0.js"><link rel="prefetch" href="/docs/next/assets/js/114.f3e18022.js"><link rel="prefetch" href="/docs/next/assets/js/115.b9b878a5.js"><link rel="prefetch" href="/docs/next/assets/js/116.8a5413c9.js"><link rel="prefetch" href="/docs/next/assets/js/117.b6a3f725.js"><link rel="prefetch" href="/docs/next/assets/js/118.638ca772.js"><link rel="prefetch" href="/docs/next/assets/js/119.3a6c7f58.js"><link rel="prefetch" href="/docs/next/assets/js/12.26a4a094.js"><link rel="prefetch" href="/docs/next/assets/js/120.133613bd.js"><link rel="prefetch" href="/docs/next/assets/js/121.38879b52.js"><link rel="prefetch" href="/docs/next/assets/js/122.e70efb25.js"><link rel="prefetch" href="/docs/next/assets/js/123.ecf4e45b.js"><link rel="prefetch" href="/docs/next/assets/js/124.3c22d3b7.js"><link rel="prefetch" href="/docs/next/assets/js/125.bcb07e8e.js"><link rel="prefetch" href="/docs/next/assets/js/126.780108e9.js"><link rel="prefetch" href="/docs/next/assets/js/127.0c43adf3.js"><link rel="prefetch" href="/docs/next/assets/js/128.b1e5c392.js"><link rel="prefetch" href="/docs/next/assets/js/129.722d462a.js"><link rel="prefetch" href="/docs/next/assets/js/13.366ee7a8.js"><link rel="prefetch" href="/docs/next/assets/js/130.d8a5df29.js"><link rel="prefetch" href="/docs/next/assets/js/131.f6874f18.js"><link rel="prefetch" href="/docs/next/assets/js/132.9696793d.js"><link rel="prefetch" href="/docs/next/assets/js/133.99b10526.js"><link rel="prefetch" href="/docs/next/assets/js/134.863416f6.js"><link rel="prefetch" href="/docs/next/assets/js/135.8adfc484.js"><link rel="prefetch" href="/docs/next/assets/js/136.00065c13.js"><link rel="prefetch" href="/docs/next/assets/js/137.4979ab54.js"><link rel="prefetch" href="/docs/next/assets/js/138.af5623db.js"><link rel="prefetch" href="/docs/next/assets/js/139.bb089116.js"><link rel="prefetch" href="/docs/next/assets/js/14.d5249207.js"><link rel="prefetch" href="/docs/next/assets/js/140.053942e3.js"><link rel="prefetch" href="/docs/next/assets/js/141.a610217a.js"><link rel="prefetch" href="/docs/next/assets/js/142.048c867e.js"><link rel="prefetch" href="/docs/next/assets/js/143.ff135b00.js"><link rel="prefetch" href="/docs/next/assets/js/144.cb3e808c.js"><link rel="prefetch" href="/docs/next/assets/js/145.0330bb10.js"><link rel="prefetch" href="/docs/next/assets/js/146.b9aa19ba.js"><link rel="prefetch" href="/docs/next/assets/js/147.88f18081.js"><link rel="prefetch" href="/docs/next/assets/js/148.7260d909.js"><link rel="prefetch" href="/docs/next/assets/js/149.049ebc71.js"><link rel="prefetch" href="/docs/next/assets/js/15.6e9e863d.js"><link rel="prefetch" href="/docs/next/assets/js/150.72de6801.js"><link rel="prefetch" href="/docs/next/assets/js/151.9a1222f4.js"><link rel="prefetch" href="/docs/next/assets/js/152.e4ef640c.js"><link rel="prefetch" href="/docs/next/assets/js/153.842b37f8.js"><link rel="prefetch" href="/docs/next/assets/js/154.dcc1bf83.js"><link rel="prefetch" href="/docs/next/assets/js/155.808f1186.js"><link rel="prefetch" href="/docs/next/assets/js/156.4950bea1.js"><link rel="prefetch" href="/docs/next/assets/js/157.3e45bbac.js"><link rel="prefetch" href="/docs/next/assets/js/158.c21206a1.js"><link rel="prefetch" href="/docs/next/assets/js/159.3a4b3de1.js"><link rel="prefetch" href="/docs/next/assets/js/16.620ac2aa.js"><link rel="prefetch" href="/docs/next/assets/js/160.cbd9a6fd.js"><link rel="prefetch" href="/docs/next/assets/js/161.b755d895.js"><link rel="prefetch" href="/docs/next/assets/js/162.6faf871b.js"><link rel="prefetch" href="/docs/next/assets/js/163.49a712af.js"><link rel="prefetch" href="/docs/next/assets/js/164.e19eefad.js"><link rel="prefetch" href="/docs/next/assets/js/165.db7347fa.js"><link rel="prefetch" href="/docs/next/assets/js/167.e534233d.js"><link rel="prefetch" href="/docs/next/assets/js/168.03442a9b.js"><link rel="prefetch" href="/docs/next/assets/js/169.6811b2e2.js"><link rel="prefetch" href="/docs/next/assets/js/17.f9d4794b.js"><link rel="prefetch" href="/docs/next/assets/js/170.94c8dda0.js"><link rel="prefetch" href="/docs/next/assets/js/171.93191d1c.js"><link rel="prefetch" href="/docs/next/assets/js/172.7c6be1c4.js"><link rel="prefetch" href="/docs/next/assets/js/173.e74991cf.js"><link rel="prefetch" href="/docs/next/assets/js/174.b4506ab4.js"><link rel="prefetch" href="/docs/next/assets/js/175.dd0055c2.js"><link rel="prefetch" href="/docs/next/assets/js/176.ba30e45c.js"><link rel="prefetch" href="/docs/next/assets/js/177.6c95ad89.js"><link rel="prefetch" href="/docs/next/assets/js/178.3643eab4.js"><link rel="prefetch" href="/docs/next/assets/js/179.4ebe3d02.js"><link rel="prefetch" href="/docs/next/assets/js/18.3f871121.js"><link rel="prefetch" href="/docs/next/assets/js/180.3734648f.js"><link rel="prefetch" href="/docs/next/assets/js/181.32f6af14.js"><link rel="prefetch" href="/docs/next/assets/js/182.0d1dc780.js"><link rel="prefetch" href="/docs/next/assets/js/183.6cb28f4f.js"><link rel="prefetch" href="/docs/next/assets/js/184.2e06acee.js"><link rel="prefetch" href="/docs/next/assets/js/185.b48c9559.js"><link rel="prefetch" href="/docs/next/assets/js/186.581b5457.js"><link rel="prefetch" href="/docs/next/assets/js/187.378d638b.js"><link rel="prefetch" href="/docs/next/assets/js/188.3638c48e.js"><link rel="prefetch" href="/docs/next/assets/js/189.22440fc9.js"><link rel="prefetch" href="/docs/next/assets/js/19.d4506b63.js"><link rel="prefetch" href="/docs/next/assets/js/190.e44737e3.js"><link rel="prefetch" href="/docs/next/assets/js/191.3ea32821.js"><link rel="prefetch" href="/docs/next/assets/js/192.b3b8859a.js"><link rel="prefetch" href="/docs/next/assets/js/193.96c5c443.js"><link rel="prefetch" href="/docs/next/assets/js/194.8e737951.js"><link rel="prefetch" href="/docs/next/assets/js/195.ec106947.js"><link rel="prefetch" href="/docs/next/assets/js/196.e05df418.js"><link rel="prefetch" href="/docs/next/assets/js/197.b607bf8b.js"><link rel="prefetch" href="/docs/next/assets/js/198.012643a1.js"><link rel="prefetch" href="/docs/next/assets/js/199.d3bd5339.js"><link rel="prefetch" href="/docs/next/assets/js/20.3ec0ad7f.js"><link rel="prefetch" href="/docs/next/assets/js/200.beca8001.js"><link rel="prefetch" href="/docs/next/assets/js/201.ffb93323.js"><link rel="prefetch" href="/docs/next/assets/js/202.93e30a8c.js"><link rel="prefetch" href="/docs/next/assets/js/203.2b1c70de.js"><link rel="prefetch" href="/docs/next/assets/js/204.13e158bc.js"><link rel="prefetch" href="/docs/next/assets/js/205.073b94a1.js"><link rel="prefetch" href="/docs/next/assets/js/206.edf16331.js"><link rel="prefetch" href="/docs/next/assets/js/207.bd1ef1bf.js"><link rel="prefetch" href="/docs/next/assets/js/208.78ba2dba.js"><link rel="prefetch" href="/docs/next/assets/js/209.ed3eb7b2.js"><link rel="prefetch" href="/docs/next/assets/js/21.492881f9.js"><link rel="prefetch" href="/docs/next/assets/js/210.909f0fb0.js"><link rel="prefetch" href="/docs/next/assets/js/211.280caeca.js"><link rel="prefetch" href="/docs/next/assets/js/212.782948b6.js"><link rel="prefetch" href="/docs/next/assets/js/213.2bbda299.js"><link rel="prefetch" href="/docs/next/assets/js/214.20e42842.js"><link rel="prefetch" href="/docs/next/assets/js/215.24b3bd89.js"><link rel="prefetch" href="/docs/next/assets/js/216.bc1e098a.js"><link rel="prefetch" href="/docs/next/assets/js/217.d63d8f79.js"><link rel="prefetch" href="/docs/next/assets/js/218.3c6dc5d5.js"><link rel="prefetch" href="/docs/next/assets/js/219.7af47c97.js"><link rel="prefetch" href="/docs/next/assets/js/22.19b1ef88.js"><link rel="prefetch" href="/docs/next/assets/js/220.c09d14b9.js"><link rel="prefetch" href="/docs/next/assets/js/221.c7e033ab.js"><link rel="prefetch" href="/docs/next/assets/js/222.105acb37.js"><link rel="prefetch" href="/docs/next/assets/js/223.1a8bbb8c.js"><link rel="prefetch" href="/docs/next/assets/js/224.a62aa6de.js"><link rel="prefetch" href="/docs/next/assets/js/225.ce55392d.js"><link rel="prefetch" href="/docs/next/assets/js/226.fb27cdb4.js"><link rel="prefetch" href="/docs/next/assets/js/227.9959b8a2.js"><link rel="prefetch" href="/docs/next/assets/js/228.3d216901.js"><link rel="prefetch" href="/docs/next/assets/js/229.5a942b8c.js"><link rel="prefetch" href="/docs/next/assets/js/23.bd5eb474.js"><link rel="prefetch" href="/docs/next/assets/js/230.672ccc4d.js"><link rel="prefetch" href="/docs/next/assets/js/231.e0c505f2.js"><link rel="prefetch" href="/docs/next/assets/js/232.70f4212f.js"><link rel="prefetch" href="/docs/next/assets/js/233.89747115.js"><link rel="prefetch" href="/docs/next/assets/js/234.10d4f748.js"><link rel="prefetch" href="/docs/next/assets/js/235.00cba1d0.js"><link rel="prefetch" href="/docs/next/assets/js/236.27ed9b91.js"><link rel="prefetch" href="/docs/next/assets/js/237.96407852.js"><link rel="prefetch" href="/docs/next/assets/js/238.1afcee34.js"><link rel="prefetch" href="/docs/next/assets/js/239.0e1729c8.js"><link rel="prefetch" href="/docs/next/assets/js/24.74e1cdb1.js"><link rel="prefetch" href="/docs/next/assets/js/240.0a2b169c.js"><link rel="prefetch" href="/docs/next/assets/js/241.aa13395e.js"><link rel="prefetch" href="/docs/next/assets/js/242.8f8eccc9.js"><link rel="prefetch" href="/docs/next/assets/js/243.48012e71.js"><link rel="prefetch" href="/docs/next/assets/js/244.cc7e5f71.js"><link rel="prefetch" href="/docs/next/assets/js/245.6596ac5d.js"><link rel="prefetch" href="/docs/next/assets/js/246.d35395a0.js"><link rel="prefetch" href="/docs/next/assets/js/247.0b0373ff.js"><link rel="prefetch" href="/docs/next/assets/js/248.37fa605a.js"><link rel="prefetch" href="/docs/next/assets/js/249.18983e35.js"><link rel="prefetch" href="/docs/next/assets/js/25.1ec18ce8.js"><link rel="prefetch" href="/docs/next/assets/js/250.01c032f1.js"><link rel="prefetch" href="/docs/next/assets/js/251.a9f45647.js"><link rel="prefetch" href="/docs/next/assets/js/252.fdda4827.js"><link rel="prefetch" href="/docs/next/assets/js/253.3d26ab69.js"><link rel="prefetch" href="/docs/next/assets/js/254.a1f8b18d.js"><link rel="prefetch" href="/docs/next/assets/js/255.bde6fa8f.js"><link rel="prefetch" href="/docs/next/assets/js/256.d62b2908.js"><link rel="prefetch" href="/docs/next/assets/js/257.9158249b.js"><link rel="prefetch" href="/docs/next/assets/js/258.75bbfb48.js"><link rel="prefetch" href="/docs/next/assets/js/259.f9cb463a.js"><link rel="prefetch" href="/docs/next/assets/js/26.fd6b425f.js"><link rel="prefetch" href="/docs/next/assets/js/260.c74ab442.js"><link rel="prefetch" href="/docs/next/assets/js/261.ef5a63c2.js"><link rel="prefetch" href="/docs/next/assets/js/27.bb21a5ac.js"><link rel="prefetch" href="/docs/next/assets/js/28.324bfce6.js"><link rel="prefetch" href="/docs/next/assets/js/29.23fe84aa.js"><link rel="prefetch" href="/docs/next/assets/js/3.231e388d.js"><link rel="prefetch" href="/docs/next/assets/js/30.01f4c09f.js"><link rel="prefetch" href="/docs/next/assets/js/31.875081a0.js"><link rel="prefetch" href="/docs/next/assets/js/32.dcd3ceca.js"><link rel="prefetch" href="/docs/next/assets/js/33.5e63cad5.js"><link rel="prefetch" href="/docs/next/assets/js/34.bceed015.js"><link rel="prefetch" href="/docs/next/assets/js/35.2415aafe.js"><link rel="prefetch" href="/docs/next/assets/js/36.6098ab9b.js"><link rel="prefetch" href="/docs/next/assets/js/37.68a3e72f.js"><link rel="prefetch" href="/docs/next/assets/js/38.000173ad.js"><link rel="prefetch" href="/docs/next/assets/js/39.32d13090.js"><link rel="prefetch" href="/docs/next/assets/js/4.7b1ba515.js"><link rel="prefetch" href="/docs/next/assets/js/40.2608d554.js"><link rel="prefetch" href="/docs/next/assets/js/41.532fe939.js"><link rel="prefetch" href="/docs/next/assets/js/42.480061d6.js"><link rel="prefetch" href="/docs/next/assets/js/43.2062f710.js"><link rel="prefetch" href="/docs/next/assets/js/44.e58d0498.js"><link rel="prefetch" href="/docs/next/assets/js/45.5131ac54.js"><link rel="prefetch" href="/docs/next/assets/js/46.bb1886c3.js"><link rel="prefetch" href="/docs/next/assets/js/47.bcfee47e.js"><link rel="prefetch" href="/docs/next/assets/js/48.8d8d26ab.js"><link rel="prefetch" href="/docs/next/assets/js/49.417b73cb.js"><link rel="prefetch" href="/docs/next/assets/js/5.5f1e37ab.js"><link rel="prefetch" href="/docs/next/assets/js/50.77867f04.js"><link rel="prefetch" href="/docs/next/assets/js/51.132570ed.js"><link rel="prefetch" href="/docs/next/assets/js/52.39656457.js"><link rel="prefetch" href="/docs/next/assets/js/53.f401b7bf.js"><link rel="prefetch" href="/docs/next/assets/js/54.b99461aa.js"><link rel="prefetch" href="/docs/next/assets/js/55.884e9434.js"><link rel="prefetch" href="/docs/next/assets/js/56.d74cdeab.js"><link rel="prefetch" href="/docs/next/assets/js/57.86bebdef.js"><link rel="prefetch" href="/docs/next/assets/js/58.bb14488f.js"><link rel="prefetch" href="/docs/next/assets/js/59.48115ecf.js"><link rel="prefetch" href="/docs/next/assets/js/6.fded0504.js"><link rel="prefetch" href="/docs/next/assets/js/60.a45f22c2.js"><link rel="prefetch" href="/docs/next/assets/js/61.4ec02286.js"><link rel="prefetch" href="/docs/next/assets/js/62.fc0046b0.js"><link rel="prefetch" href="/docs/next/assets/js/63.f606a653.js"><link rel="prefetch" href="/docs/next/assets/js/64.7afdac3e.js"><link rel="prefetch" href="/docs/next/assets/js/65.63eb447e.js"><link rel="prefetch" href="/docs/next/assets/js/66.27668122.js"><link rel="prefetch" href="/docs/next/assets/js/67.585f2fc7.js"><link rel="prefetch" href="/docs/next/assets/js/68.99cd4fab.js"><link rel="prefetch" href="/docs/next/assets/js/69.31dc4728.js"><link rel="prefetch" href="/docs/next/assets/js/7.7f7e29fb.js"><link rel="prefetch" href="/docs/next/assets/js/70.62172d1b.js"><link rel="prefetch" href="/docs/next/assets/js/71.8e905e6d.js"><link rel="prefetch" href="/docs/next/assets/js/72.0e7ece27.js"><link rel="prefetch" href="/docs/next/assets/js/73.8e4354c0.js"><link rel="prefetch" href="/docs/next/assets/js/74.e622ba99.js"><link rel="prefetch" href="/docs/next/assets/js/75.cd884781.js"><link rel="prefetch" href="/docs/next/assets/js/76.d51b9168.js"><link rel="prefetch" href="/docs/next/assets/js/77.eda9ccc1.js"><link rel="prefetch" href="/docs/next/assets/js/78.ae4cafc3.js"><link rel="prefetch" href="/docs/next/assets/js/79.8904295a.js"><link rel="prefetch" href="/docs/next/assets/js/8.b36085f7.js"><link rel="prefetch" href="/docs/next/assets/js/80.a68f1097.js"><link rel="prefetch" href="/docs/next/assets/js/81.08840d97.js"><link rel="prefetch" href="/docs/next/assets/js/82.f808225e.js"><link rel="prefetch" href="/docs/next/assets/js/83.d0175ebd.js"><link rel="prefetch" href="/docs/next/assets/js/84.4584216a.js"><link rel="prefetch" href="/docs/next/assets/js/85.42fee9fd.js"><link rel="prefetch" href="/docs/next/assets/js/86.aa2074f4.js"><link rel="prefetch" href="/docs/next/assets/js/87.11751fe1.js"><link rel="prefetch" href="/docs/next/assets/js/88.24f73489.js"><link rel="prefetch" href="/docs/next/assets/js/89.a9f679a2.js"><link rel="prefetch" href="/docs/next/assets/js/9.5bb8c761.js"><link rel="prefetch" href="/docs/next/assets/js/90.4f5526cd.js"><link rel="prefetch" href="/docs/next/assets/js/91.69b70c8d.js"><link rel="prefetch" href="/docs/next/assets/js/92.36a9a9f5.js"><link rel="prefetch" href="/docs/next/assets/js/93.2b39c149.js"><link rel="prefetch" href="/docs/next/assets/js/94.00b482e7.js"><link rel="prefetch" href="/docs/next/assets/js/95.ee8c57df.js"><link rel="prefetch" href="/docs/next/assets/js/96.fc54ce86.js"><link rel="prefetch" href="/docs/next/assets/js/97.2bab6d5b.js"><link rel="prefetch" href="/docs/next/assets/js/98.c38195cf.js"><link rel="prefetch" href="/docs/next/assets/js/99.009853cb.js">
    <link rel="stylesheet" href="/docs/next/assets/css/0.styles.32b47955.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/next/" class="home-link router-link-active"><img src="/docs/next/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/next/" class="nav-link">
  Home
</a></div><div class="nav-item"><a href="/docs/next/api/" class="nav-link">
  API
</a></div><div class="nav-item"><a href="/docs/next/samples/" class="nav-link">
  Samples
</a></div><div class="nav-item"><div class="dropdown-wrapper"><button type="button" aria-label="Community Menu" class="dropdown-title"><span class="title">Ecosystem</span> <span class="arrow down"></span></button> <button type="button" aria-label="Community Menu" class="mobile-dropdown-title"><span class="title">Ecosystem</span> <span class="arrow right"></span></button> <ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><!----> <a href="https://github.com/chartjs/awesome" target="_blank" rel="noopener noreferrer" class="nav-link external">
  Awesome
  <span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></li><li class="dropdown-item"><!----> <a href="https://chartjs-slack.herokuapp.com/" target="_blank" rel="noopener noreferrer" class="nav-link external">
  Slack
  <span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></li><li class="dropdown-item"><!----> <a href="https://stackoverflow.com/questions/tagged/chart.js" target="_blank" rel="noopener noreferrer" class="nav-link external">
  Stack Overflow
  <span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></li></ul></div></div> <a href="https://github.com/chartjs/Chart.js" target="_blank" rel="noopener noreferrer" class="repo-link">
    GitHub
    <span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></nav></div></header> <div class="sidebar-mask"></div> <aside class="sidebar"><nav class="nav-links"><div class="nav-item"><a href="/docs/next/" class="nav-link">
  Home
</a></div><div class="nav-item"><a href="/docs/next/api/" class="nav-link">
  API
</a></div><div class="nav-item"><a href="/docs/next/samples/" class="nav-link">
  Samples
</a></div><div class="nav-item"><div class="dropdown-wrapper"><button type="button" aria-label="Community Menu" class="dropdown-title"><span class="title">Ecosystem</span> <span class="arrow down"></span></button> <button type="button" aria-label="Community Menu" class="mobile-dropdown-title"><span class="title">Ecosystem</span> <span class="arrow right"></span></button> <ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><!----> <a href="https://github.com/chartjs/awesome" target="_blank" rel="noopener noreferrer" class="nav-link external">
  Awesome
  <span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></li><li class="dropdown-item"><!----> <a href="https://chartjs-slack.herokuapp.com/" target="_blank" rel="noopener noreferrer" class="nav-link external">
  Slack
  <span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></li><li class="dropdown-item"><!----> <a href="https://stackoverflow.com/questions/tagged/chart.js" target="_blank" rel="noopener noreferrer" class="nav-link external">
  Stack Overflow
  <span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></li></ul></div></div> <a href="https://github.com/chartjs/Chart.js" target="_blank" rel="noopener noreferrer" class="repo-link">
    GitHub
    <span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></nav>  <ul class="sidebar-links"><li><a href="/docs/next/" 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 open"><span>Configuration</span> <span class="arrow down"></span></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/docs/next/configuration/" aria-current="page" class="sidebar-link">Configuration</a></li><li><a href="/docs/next/configuration/animations.html" class="sidebar-link">Animations</a></li><li><a href="/docs/next/configuration/canvas-background.html" class="sidebar-link">Canvas background</a></li><li><a href="/docs/next/configuration/decimation.html" class="sidebar-link">Data Decimation</a></li><li><a href="/docs/next/configuration/device-pixel-ratio.html" class="sidebar-link">Device Pixel Ratio</a></li><li><a href="/docs/next/configuration/elements.html" class="sidebar-link">Elements</a></li><li><a href="/docs/next/configuration/interactions.html" class="sidebar-link">Interactions</a></li><li><a href="/docs/next/configuration/layout.html" class="sidebar-link">Layout</a></li><li><a href="/docs/next/configuration/legend.html" class="sidebar-link">Legend</a></li><li><a href="/docs/next/configuration/locale.html" class="sidebar-link">Locale</a></li><li><a href="/docs/next/configuration/responsive.html" class="sidebar-link">Responsive Charts</a></li><li><a href="/docs/next/configuration/subtitle.html" class="sidebar-link">Subtitle</a></li><li><a href="/docs/next/configuration/title.html" class="sidebar-link">Title</a></li><li><a href="/docs/next/configuration/tooltip.html" aria-current="page" class="active sidebar-link">Tooltip</a></li></ul></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"><span>Developers</span> <span class="arrow right"></span></p> <!----></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="tooltip"><a href="#tooltip" class="header-anchor">#</a> Tooltip</h1> <h2 id="tooltip-configuration"><a href="#tooltip-configuration" class="header-anchor">#</a> Tooltip Configuration</h2> <p>Namespace: <code>options.plugins.tooltip</code>, the global options for the chart tooltips is defined in <code>Chart.defaults.plugins.tooltip</code>.</p> <div class="custom-block warning"><p class="custom-block-title">WARNING</p> <p>The bubble, doughnut, pie, polar area, and scatter charts override the tooltip defaults. To change the overrides for those chart types, the options are defined in <code>Chart.overrides[type].plugins.tooltip</code>.</p></div> <table><thead><tr><th>Name</th> <th>Type</th> <th>Default</th> <th>Description</th></tr></thead> <tbody><tr><td><code>enabled</code></td> <td><code>boolean</code></td> <td><code>true</code></td> <td>Are on-canvas tooltips enabled?</td></tr> <tr><td><code>external</code></td> <td><code>function</code></td> <td><code>null</code></td> <td>See <a href="#external-custom-tooltips">external tooltip</a> section.</td></tr> <tr><td><code>mode</code></td> <td><code>string</code></td> <td><code>interaction.mode</code></td> <td>Sets which elements appear in the tooltip. <a href="/docs/next/configuration/interactions.html#modes">more...</a>.</td></tr> <tr><td><code>intersect</code></td> <td><code>boolean</code></td> <td><code>interaction.intersect</code></td> <td>If true, the tooltip mode applies only when the mouse position intersects with an element. If false, the mode will be applied at all times.</td></tr> <tr><td><code>position</code></td> <td><code>string</code></td> <td><code>'average'</code></td> <td>The mode for positioning the tooltip. <a href="#position-modes">more...</a></td></tr> <tr><td><code>callbacks</code></td> <td><code>object</code></td> <td></td> <td>See the <a href="#tooltip-callbacks">callbacks section</a>.</td></tr> <tr><td><code>itemSort</code></td> <td><code>function</code></td> <td></td> <td>Sort tooltip items. <a href="#sort-callback">more...</a></td></tr> <tr><td><code>filter</code></td> <td><code>function</code></td> <td></td> <td>Filter tooltip items. <a href="#filter-callback">more...</a></td></tr> <tr><td><code>backgroundColor</code></td> <td><a href="/docs/next/general/colors.html"><code>Color</code></a></td> <td><code>'rgba(0, 0, 0, 0.8)'</code></td> <td>Background color of the tooltip.</td></tr> <tr><td><code>titleColor</code></td> <td><a href="/docs/next/general/colors.html"><code>Color</code></a></td> <td><code>'#fff'</code></td> <td>Color of title text.</td></tr> <tr><td><code>titleFont</code></td> <td><code>Font</code></td> <td><code>{weight: 'bold'}</code></td> <td>See <a href="/docs/next/general/fonts.html">Fonts</a>.</td></tr> <tr><td><code>titleAlign</code></td> <td><code>string</code></td> <td><code>'left'</code></td> <td>Horizontal alignment of the title text lines. <a href="#text-alignment">more...</a></td></tr> <tr><td><code>titleSpacing</code></td> <td><code>number</code></td> <td><code>2</code></td> <td>Spacing to add to top and bottom of each title line.</td></tr> <tr><td><code>titleMarginBottom</code></td> <td><code>number</code></td> <td><code>6</code></td> <td>Margin to add on bottom of title section.</td></tr> <tr><td><code>bodyColor</code></td> <td><a href="/docs/next/general/colors.html"><code>Color</code></a></td> <td><code>'#fff'</code></td> <td>Color of body text.</td></tr> <tr><td><code>bodyFont</code></td> <td><code>Font</code></td> <td><code>{}</code></td> <td>See <a href="/docs/next/general/fonts.html">Fonts</a>.</td></tr> <tr><td><code>bodyAlign</code></td> <td><code>string</code></td> <td><code>'left'</code></td> <td>Horizontal alignment of the body text lines. <a href="#text-alignment">more...</a></td></tr> <tr><td><code>bodySpacing</code></td> <td><code>number</code></td> <td><code>2</code></td> <td>Spacing to add to top and bottom of each tooltip item.</td></tr> <tr><td><code>footerColor</code></td> <td><a href="/docs/next/general/colors.html"><code>Color</code></a></td> <td><code>'#fff'</code></td> <td>Color of footer text.</td></tr> <tr><td><code>footerFont</code></td> <td><code>Font</code></td> <td><code>{weight: 'bold'}</code></td> <td>See <a href="/docs/next/general/fonts.html">Fonts</a>.</td></tr> <tr><td><code>footerAlign</code></td> <td><code>string</code></td> <td><code>'left'</code></td> <td>Horizontal alignment of the footer text lines. <a href="#text-alignment">more...</a></td></tr> <tr><td><code>footerSpacing</code></td> <td><code>number</code></td> <td><code>2</code></td> <td>Spacing to add to top and bottom of each footer line.</td></tr> <tr><td><code>footerMarginTop</code></td> <td><code>number</code></td> <td><code>6</code></td> <td>Margin to add before drawing the footer.</td></tr> <tr><td><code>padding</code></td> <td><a href="/docs/next/general/padding.html"><code>Padding</code></a></td> <td><code>6</code></td> <td>Padding inside the tooltip.</td></tr> <tr><td><code>caretPadding</code></td> <td><code>number</code></td> <td><code>2</code></td> <td>Extra distance to move the end of the tooltip arrow away from the tooltip point.</td></tr> <tr><td><code>caretSize</code></td> <td><code>number</code></td> <td><code>5</code></td> <td>Size, in px, of the tooltip arrow.</td></tr> <tr><td><code>cornerRadius</code></td> <td><code>number</code>|<code>object</code></td> <td><code>6</code></td> <td>Radius of tooltip corner curves.</td></tr> <tr><td><code>multiKeyBackground</code></td> <td><a href="/docs/next/general/colors.html"><code>Color</code></a></td> <td><code>'#fff'</code></td> <td>Color to draw behind the colored boxes when multiple items are in the tooltip.</td></tr> <tr><td><code>displayColors</code></td> <td><code>boolean</code></td> <td><code>true</code></td> <td>If true, color boxes are shown in the tooltip.</td></tr> <tr><td><code>boxWidth</code></td> <td><code>number</code></td> <td><code>bodyFont.size</code></td> <td>Width of the color box if displayColors is true.</td></tr> <tr><td><code>boxHeight</code></td> <td><code>number</code></td> <td><code>bodyFont.size</code></td> <td>Height of the color box if displayColors is true.</td></tr> <tr><td><code>boxPadding</code></td> <td><code>number</code></td> <td><code>1</code></td> <td>Padding between the color box and the text.</td></tr> <tr><td><code>usePointStyle</code></td> <td><code>boolean</code></td> <td><code>false</code></td> <td>Use the corresponding point style (from dataset options) instead of color boxes, ex: star, triangle etc. (size is based on the minimum value between boxWidth and boxHeight).</td></tr> <tr><td><code>borderColor</code></td> <td><a href="/docs/next/general/colors.html"><code>Color</code></a></td> <td><code>'rgba(0, 0, 0, 0)'</code></td> <td>Color of the border.</td></tr> <tr><td><code>borderWidth</code></td> <td><code>number</code></td> <td><code>0</code></td> <td>Size of the border.</td></tr> <tr><td><code>rtl</code></td> <td><code>boolean</code></td> <td></td> <td><code>true</code> for rendering the tooltip from right to left.</td></tr> <tr><td><code>textDirection</code></td> <td><code>string</code></td> <td>canvas' default</td> <td>This will force the text direction <code>'rtl' or 'ltr</code> on the canvas for rendering the tooltips, regardless of the css specified on the canvas</td></tr> <tr><td><code>xAlign</code></td> <td><code>string</code></td> <td><code>undefined</code></td> <td>Position of the tooltip caret in the X direction. <a href="#tooltip-alignment">more</a></td></tr> <tr><td><code>yAlign</code></td> <td><code>string</code></td> <td><code>undefined</code></td> <td>Position of the tooltip caret in the Y direction. <a href="#tooltip-alignment">more</a></td></tr></tbody></table> <div class="custom-block tip"><p class="custom-block-title">Note</p> <p>If you need more visual customizations, please use an <a href="/docs/next/samples/tooltip/html.html">HTML tooltip</a>.</p></div> <h3 id="position-modes"><a href="#position-modes" class="header-anchor">#</a> Position Modes</h3> <p>Possible modes are:</p> <ul><li><code>'average'</code></li> <li><code>'nearest'</code></li></ul> <p><code>'average'</code> mode will place the tooltip at the average position of the items displayed in the tooltip. <code>'nearest'</code> will place the tooltip at the position of the element closest to the event position.</p> <p>You can also define <a href="#custom-position-modes">custom position modes</a>.</p> <h3 id="tooltip-alignment"><a href="#tooltip-alignment" class="header-anchor">#</a> Tooltip Alignment</h3> <p>The <code>xAlign</code> and <code>yAlign</code> options define the position of the tooltip caret. If these parameters are unset, the optimal caret position is determined.</p> <p>The following values for the <code>xAlign</code> setting are supported.</p> <ul><li><code>'left'</code></li> <li><code>'center'</code></li> <li><code>'right'</code></li></ul> <p>The following values for the <code>yAlign</code> setting are supported.</p> <ul><li><code>'top'</code></li> <li><code>'center'</code></li> <li><code>'bottom'</code></li></ul> <h3 id="text-alignment"><a href="#text-alignment" class="header-anchor">#</a> Text Alignment</h3> <p>The <code>titleAlign</code>, <code>bodyAlign</code> and <code>footerAlign</code> options define the horizontal position of the text lines with respect to the tooltip box. The following values are supported.</p> <ul><li><code>'left'</code> (default)</li> <li><code>'right'</code></li> <li><code>'center'</code></li></ul> <p>These options are only applied to text lines. Color boxes are always aligned to the left edge.</p> <h3 id="sort-callback"><a href="#sort-callback" class="header-anchor">#</a> Sort Callback</h3> <p>Allows sorting of <a href="#tooltip-item-context">tooltip items</a>. Must implement at minimum a function that can be passed to <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort" target="_blank" rel="noopener noreferrer">Array.prototype.sort<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>. This function can also accept a third parameter that is the data object passed to the chart.</p> <h3 id="filter-callback"><a href="#filter-callback" class="header-anchor">#</a> Filter Callback</h3> <p>Allows filtering of <a href="#tooltip-item-context">tooltip items</a>. Must implement at minimum a function that can be passed to <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/filter" target="_blank" rel="noopener noreferrer">Array.prototype.filter<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>. This function can also accept a fourth parameter that is the data object passed to the chart.</p> <h2 id="tooltip-callbacks"><a href="#tooltip-callbacks" class="header-anchor">#</a> Tooltip Callbacks</h2> <p>Namespace: <code>options.plugins.tooltip.callbacks</code>, the tooltip has the following callbacks for providing text. For all functions, <code>this</code> will be the tooltip object created from the <code>Tooltip</code> constructor. If the callback returns <code>undefined</code>, then the default callback will be used. To remove things from the tooltip callback should return an empty string.</p> <p>Namespace: <code>data.datasets[].tooltip.callbacks</code>, items marked with <code>Yes</code> in the column <code>Dataset override</code> can be overridden per dataset.</p> <p>A <a href="#tooltip-item-context">tooltip item context</a> is generated for each item that appears in the tooltip. This is the primary model that the callback methods interact with. For functions that return text, arrays of strings are treated as multiple lines of text.</p> <table><thead><tr><th>Name</th> <th>Arguments</th> <th>Return Type</th> <th>Dataset override</th> <th>Description</th></tr></thead> <tbody><tr><td><code>beforeTitle</code></td> <td><code>TooltipItem[]</code></td> <td><code>string | string[] | undefined</code></td> <td></td> <td>Returns the text to render before the title.</td></tr> <tr><td><code>title</code></td> <td><code>TooltipItem[]</code></td> <td><code>string | string[] | undefined</code></td> <td></td> <td>Returns text to render as the title of the tooltip.</td></tr> <tr><td><code>afterTitle</code></td> <td><code>TooltipItem[]</code></td> <td><code>string | string[] | undefined</code></td> <td></td> <td>Returns text to render after the title.</td></tr> <tr><td><code>beforeBody</code></td> <td><code>TooltipItem[]</code></td> <td><code>string | string[] | undefined</code></td> <td></td> <td>Returns text to render before the body section.</td></tr> <tr><td><code>beforeLabel</code></td> <td><code>TooltipItem</code></td> <td><code>string | string[] | undefined</code></td> <td>Yes</td> <td>Returns text to render before an individual label. This will be called for each item in the tooltip.</td></tr> <tr><td><code>label</code></td> <td><code>TooltipItem</code></td> <td><code>string | string[] | undefined</code></td> <td>Yes</td> <td>Returns text to render for an individual item in the tooltip. <a href="#label-callback">more...</a></td></tr> <tr><td><code>labelColor</code></td> <td><code>TooltipItem</code></td> <td><code>object | undefined</code></td> <td>Yes</td> <td>Returns the colors to render for the tooltip item. <a href="#label-color-callback">more...</a></td></tr> <tr><td><code>labelTextColor</code></td> <td><code>TooltipItem</code></td> <td><code>Color | undefined</code></td> <td>Yes</td> <td>Returns the colors for the text of the label for the tooltip item.</td></tr> <tr><td><code>labelPointStyle</code></td> <td><code>TooltipItem</code></td> <td><code>object | undefined</code></td> <td>Yes</td> <td>Returns the point style to use instead of color boxes if usePointStyle is true (object with values <code>pointStyle</code> and <code>rotation</code>). Default implementation uses the point style from the dataset points. <a href="#label-point-style-callback">more...</a></td></tr> <tr><td><code>afterLabel</code></td> <td><code>TooltipItem</code></td> <td><code>string | string[] | undefined</code></td> <td>Yes</td> <td>Returns text to render after an individual label.</td></tr> <tr><td><code>afterBody</code></td> <td><code>TooltipItem[]</code></td> <td><code>string | string[] | undefined</code></td> <td></td> <td>Returns text to render after the body section.</td></tr> <tr><td><code>beforeFooter</code></td> <td><code>TooltipItem[]</code></td> <td><code>string | string[] | undefined</code></td> <td></td> <td>Returns text to render before the footer section.</td></tr> <tr><td><code>footer</code></td> <td><code>TooltipItem[]</code></td> <td><code>string | string[] | undefined</code></td> <td></td> <td>Returns text to render as the footer of the tooltip.</td></tr> <tr><td><code>afterFooter</code></td> <td><code>TooltipItem[]</code></td> <td><code>string | string[] | undefined</code></td> <td></td> <td>Text to render after the footer section.</td></tr></tbody></table> <h3 id="label-callback"><a href="#label-callback" class="header-anchor">#</a> Label Callback</h3> <p>The <code>label</code> callback can change the text that displays for a given data point. A common example to show a unit. The example below puts a <code>'$'</code> before every row.</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">type</span><span class="token operator">:</span> <span class="token string">'line'</span><span class="token punctuation">,</span>
    <span class="token literal-property property">data</span><span class="token operator">:</span> data<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">tooltip</span><span class="token operator">:</span> <span class="token punctuation">{</span>
                <span class="token literal-property property">callbacks</span><span class="token operator">:</span> <span class="token punctuation">{</span>
                    <span class="token function-variable function">label</span><span class="token operator">:</span> <span class="token keyword">function</span><span class="token punctuation">(</span><span class="token parameter">context</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
                        <span class="token keyword">let</span> label <span class="token operator">=</span> context<span class="token punctuation">.</span>dataset<span class="token punctuation">.</span>label <span class="token operator">||</span> <span class="token string">''</span><span class="token punctuation">;</span>
                        <span class="token keyword">if</span> <span class="token punctuation">(</span>label<span class="token punctuation">)</span> <span class="token punctuation">{</span>
                            label <span class="token operator">+=</span> <span class="token string">': '</span><span class="token punctuation">;</span>
                        <span class="token punctuation">}</span>
                        <span class="token keyword">if</span> <span class="token punctuation">(</span>context<span class="token punctuation">.</span>parsed<span class="token punctuation">.</span>y <span class="token operator">!==</span> <span class="token keyword">null</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
                            label <span class="token operator">+=</span> <span class="token keyword">new</span> <span class="token class-name">Intl<span class="token punctuation">.</span>NumberFormat</span><span class="token punctuation">(</span><span class="token string">'en-US'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token literal-property property">style</span><span class="token operator">:</span> <span class="token string">'currency'</span><span class="token punctuation">,</span> <span class="token literal-property property">currency</span><span class="token operator">:</span> <span class="token string">'USD'</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">format</span><span class="token punctuation">(</span>context<span class="token punctuation">.</span>parsed<span class="token punctuation">.</span>y<span class="token punctuation">)</span><span class="token punctuation">;</span>
                        <span class="token punctuation">}</span>
                        <span class="token keyword">return</span> label<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><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><h3 id="label-color-callback"><a href="#label-color-callback" class="header-anchor">#</a> Label Color Callback</h3> <p>For example, to return a red box with a blue dashed border that has a border radius for each item in the tooltip you could do:</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">type</span><span class="token operator">:</span> <span class="token string">'line'</span><span class="token punctuation">,</span>
    <span class="token literal-property property">data</span><span class="token operator">:</span> data<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">tooltip</span><span class="token operator">:</span> <span class="token punctuation">{</span>
                <span class="token literal-property property">callbacks</span><span class="token operator">:</span> <span class="token punctuation">{</span>
                    <span class="token function-variable function">labelColor</span><span class="token operator">:</span> <span class="token keyword">function</span><span class="token punctuation">(</span><span class="token parameter">context</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
                        <span class="token keyword">return</span> <span class="token punctuation">{</span>
                            <span class="token literal-property property">borderColor</span><span class="token operator">:</span> <span class="token string">'rgb(0, 0, 255)'</span><span class="token punctuation">,</span>
                            <span class="token literal-property property">backgroundColor</span><span class="token operator">:</span> <span class="token string">'rgb(255, 0, 0)'</span><span class="token punctuation">,</span>
                            <span class="token literal-property property">borderWidth</span><span class="token operator">:</span> <span class="token number">2</span><span class="token punctuation">,</span>
                            <span class="token literal-property property">borderDash</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token number">2</span><span class="token punctuation">,</span> <span class="token number">2</span><span class="token punctuation">]</span><span class="token punctuation">,</span>
                            <span class="token literal-property property">borderRadius</span><span class="token operator">:</span> <span class="token number">2</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 function-variable function">labelTextColor</span><span class="token operator">:</span> <span class="token keyword">function</span><span class="token punctuation">(</span><span class="token parameter">context</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
                        <span class="token keyword">return</span> <span class="token string">'#543453'</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><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><h3 id="label-point-style-callback"><a href="#label-point-style-callback" class="header-anchor">#</a> Label Point Style Callback</h3> <p>For example, to draw triangles instead of the regular color box for each item in the tooltip you could do:</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">type</span><span class="token operator">:</span> <span class="token string">'line'</span><span class="token punctuation">,</span>
    <span class="token literal-property property">data</span><span class="token operator">:</span> data<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">tooltip</span><span class="token operator">:</span> <span class="token punctuation">{</span>
                <span class="token literal-property property">usePointStyle</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span>
                <span class="token literal-property property">callbacks</span><span class="token operator">:</span> <span class="token punctuation">{</span>
                    <span class="token function-variable function">labelPointStyle</span><span class="token operator">:</span> <span class="token keyword">function</span><span class="token punctuation">(</span><span class="token parameter">context</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
                        <span class="token keyword">return</span> <span class="token punctuation">{</span>
                            <span class="token literal-property property">pointStyle</span><span class="token operator">:</span> <span class="token string">'triangle'</span><span class="token punctuation">,</span>
                            <span class="token literal-property property">rotation</span><span class="token operator">:</span> <span class="token number">0</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>
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><h3 id="tooltip-item-context"><a href="#tooltip-item-context" class="header-anchor">#</a> Tooltip Item Context</h3> <p>The tooltip items passed to the tooltip callbacks implement the following interface.</p> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token punctuation">{</span>
    <span class="token comment">// The chart the tooltip is being shown on</span>
    <span class="token literal-property property">chart</span><span class="token operator">:</span> Chart
    <span class="token comment">// Label for the tooltip</span>
    <span class="token literal-property property">label</span><span class="token operator">:</span> string<span class="token punctuation">,</span>
    <span class="token comment">// Parsed data values for the given `dataIndex` and `datasetIndex`</span>
    <span class="token literal-property property">parsed</span><span class="token operator">:</span> object<span class="token punctuation">,</span>
    <span class="token comment">// Raw data values for the given `dataIndex` and `datasetIndex`</span>
    <span class="token literal-property property">raw</span><span class="token operator">:</span> object<span class="token punctuation">,</span>
    <span class="token comment">// Formatted value for the tooltip</span>
    <span class="token literal-property property">formattedValue</span><span class="token operator">:</span> string<span class="token punctuation">,</span>
    <span class="token comment">// The dataset the item comes from</span>
    <span class="token literal-property property">dataset</span><span class="token operator">:</span> object
    <span class="token comment">// Index of the dataset the item comes from</span>
    <span class="token literal-property property">datasetIndex</span><span class="token operator">:</span> number<span class="token punctuation">,</span>
    <span class="token comment">// Index of this data item in the dataset</span>
    <span class="token literal-property property">dataIndex</span><span class="token operator">:</span> number<span class="token punctuation">,</span>
    <span class="token comment">// The chart element (point, arc, bar, etc.) for this tooltip item</span>
    <span class="token literal-property property">element</span><span class="token operator">:</span> Element<span class="token punctuation">,</span>
<span class="token punctuation">}</span>
</code></pre></div><h2 id="external-custom-tooltips"><a href="#external-custom-tooltips" class="header-anchor">#</a> External (Custom) Tooltips</h2> <p>External tooltips allow you to hook into the tooltip rendering process so that you can render the tooltip in your own custom way. Generally this is used to create an HTML tooltip instead of an on-canvas tooltip. The <code>external</code> option takes a function which is passed a context parameter containing the <code>chart</code> and <code>tooltip</code>. You can enable external tooltips in the global or chart configuration like so:</p> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token keyword">const</span> myPieChart <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">type</span><span class="token operator">:</span> <span class="token string">'pie'</span><span class="token punctuation">,</span>
    <span class="token literal-property property">data</span><span class="token operator">:</span> data<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">tooltip</span><span class="token operator">:</span> <span class="token punctuation">{</span>
                <span class="token comment">// Disable the on-canvas tooltip</span>
                <span class="token literal-property property">enabled</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span>
                <span class="token function-variable function">external</span><span class="token operator">:</span> <span class="token keyword">function</span><span class="token punctuation">(</span><span class="token parameter">context</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
                    <span class="token comment">// Tooltip Element</span>
                    <span class="token keyword">let</span> tooltipEl <span class="token operator">=</span> document<span class="token punctuation">.</span><span class="token function">getElementById</span><span class="token punctuation">(</span><span class="token string">'chartjs-tooltip'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
                    <span class="token comment">// Create element on first render</span>
                    <span class="token keyword">if</span> <span class="token punctuation">(</span><span class="token operator">!</span>tooltipEl<span class="token punctuation">)</span> <span class="token punctuation">{</span>
                        tooltipEl <span class="token operator">=</span> document<span class="token punctuation">.</span><span class="token function">createElement</span><span class="token punctuation">(</span><span class="token string">'div'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
                        tooltipEl<span class="token punctuation">.</span>id <span class="token operator">=</span> <span class="token string">'chartjs-tooltip'</span><span class="token punctuation">;</span>
                        tooltipEl<span class="token punctuation">.</span>innerHTML <span class="token operator">=</span> <span class="token string">'&lt;table&gt;&lt;/table&gt;'</span><span class="token punctuation">;</span>
                        document<span class="token punctuation">.</span>body<span class="token punctuation">.</span><span class="token function">appendChild</span><span class="token punctuation">(</span>tooltipEl<span class="token punctuation">)</span><span class="token punctuation">;</span>
                    <span class="token punctuation">}</span>
                    <span class="token comment">// Hide if no tooltip</span>
                    <span class="token keyword">const</span> tooltipModel <span class="token operator">=</span> context<span class="token punctuation">.</span>tooltip<span class="token punctuation">;</span>
                    <span class="token keyword">if</span> <span class="token punctuation">(</span>tooltipModel<span class="token punctuation">.</span>opacity <span class="token operator">===</span> <span class="token number">0</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
                        tooltipEl<span class="token punctuation">.</span>style<span class="token punctuation">.</span>opacity <span class="token operator">=</span> <span class="token number">0</span><span class="token punctuation">;</span>
                        <span class="token keyword">return</span><span class="token punctuation">;</span>
                    <span class="token punctuation">}</span>
                    <span class="token comment">// Set caret Position</span>
                    tooltipEl<span class="token punctuation">.</span>classList<span class="token punctuation">.</span><span class="token function">remove</span><span class="token punctuation">(</span><span class="token string">'above'</span><span class="token punctuation">,</span> <span class="token string">'below'</span><span class="token punctuation">,</span> <span class="token string">'no-transform'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
                    <span class="token keyword">if</span> <span class="token punctuation">(</span>tooltipModel<span class="token punctuation">.</span>yAlign<span class="token punctuation">)</span> <span class="token punctuation">{</span>
                        tooltipEl<span class="token punctuation">.</span>classList<span class="token punctuation">.</span><span class="token function">add</span><span class="token punctuation">(</span>tooltipModel<span class="token punctuation">.</span>yAlign<span class="token punctuation">)</span><span class="token punctuation">;</span>
                    <span class="token punctuation">}</span> <span class="token keyword">else</span> <span class="token punctuation">{</span>
                        tooltipEl<span class="token punctuation">.</span>classList<span class="token punctuation">.</span><span class="token function">add</span><span class="token punctuation">(</span><span class="token string">'no-transform'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
                    <span class="token punctuation">}</span>
                    <span class="token keyword">function</span> <span class="token function">getBody</span><span class="token punctuation">(</span><span class="token parameter">bodyItem</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
                        <span class="token keyword">return</span> bodyItem<span class="token punctuation">.</span>lines<span class="token punctuation">;</span>
                    <span class="token punctuation">}</span>
                    <span class="token comment">// Set Text</span>
                    <span class="token keyword">if</span> <span class="token punctuation">(</span>tooltipModel<span class="token punctuation">.</span>body<span class="token punctuation">)</span> <span class="token punctuation">{</span>
                        <span class="token keyword">const</span> titleLines <span class="token operator">=</span> tooltipModel<span class="token punctuation">.</span>title <span class="token operator">||</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span>
                        <span class="token keyword">const</span> bodyLines <span class="token operator">=</span> tooltipModel<span class="token punctuation">.</span>body<span class="token punctuation">.</span><span class="token function">map</span><span class="token punctuation">(</span>getBody<span class="token punctuation">)</span><span class="token punctuation">;</span>
                        <span class="token keyword">let</span> innerHtml <span class="token operator">=</span> <span class="token string">'&lt;thead&gt;'</span><span class="token punctuation">;</span>
                        titleLines<span class="token punctuation">.</span><span class="token function">forEach</span><span class="token punctuation">(</span><span class="token keyword">function</span><span class="token punctuation">(</span><span class="token parameter">title</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
                            innerHtml <span class="token operator">+=</span> <span class="token string">'&lt;tr&gt;&lt;th&gt;'</span> <span class="token operator">+</span> title <span class="token operator">+</span> <span class="token string">'&lt;/th&gt;&lt;/tr&gt;'</span><span class="token punctuation">;</span>
                        <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
                        innerHtml <span class="token operator">+=</span> <span class="token string">'&lt;/thead&gt;&lt;tbody&gt;'</span><span class="token punctuation">;</span>
                        bodyLines<span class="token punctuation">.</span><span class="token function">forEach</span><span class="token punctuation">(</span><span class="token keyword">function</span><span class="token punctuation">(</span><span class="token parameter">body<span class="token punctuation">,</span> i</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
                            <span class="token keyword">const</span> colors <span class="token operator">=</span> tooltipModel<span class="token punctuation">.</span>labelColors<span class="token punctuation">[</span>i<span class="token punctuation">]</span><span class="token punctuation">;</span>
                            <span class="token keyword">let</span> style <span class="token operator">=</span> <span class="token string">'background:'</span> <span class="token operator">+</span> colors<span class="token punctuation">.</span>backgroundColor<span class="token punctuation">;</span>
                            style <span class="token operator">+=</span> <span class="token string">'; border-color:'</span> <span class="token operator">+</span> colors<span class="token punctuation">.</span>borderColor<span class="token punctuation">;</span>
                            style <span class="token operator">+=</span> <span class="token string">'; border-width: 2px'</span><span class="token punctuation">;</span>
                            <span class="token keyword">const</span> span <span class="token operator">=</span> <span class="token string">'&lt;span style=&quot;'</span> <span class="token operator">+</span> style <span class="token operator">+</span> <span class="token string">'&quot;&gt;'</span> <span class="token operator">+</span> body <span class="token operator">+</span> <span class="token string">'&lt;/span&gt;'</span><span class="token punctuation">;</span>
                            innerHtml <span class="token operator">+=</span> <span class="token string">'&lt;tr&gt;&lt;td&gt;'</span> <span class="token operator">+</span> span <span class="token operator">+</span> <span class="token string">'&lt;/td&gt;&lt;/tr&gt;'</span><span class="token punctuation">;</span>
                        <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
                        innerHtml <span class="token operator">+=</span> <span class="token string">'&lt;/tbody&gt;'</span><span class="token punctuation">;</span>
                        <span class="token keyword">let</span> tableRoot <span class="token operator">=</span> tooltipEl<span class="token punctuation">.</span><span class="token function">querySelector</span><span class="token punctuation">(</span><span class="token string">'table'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
                        tableRoot<span class="token punctuation">.</span>innerHTML <span class="token operator">=</span> innerHtml<span class="token punctuation">;</span>
                    <span class="token punctuation">}</span>
                    <span class="token keyword">const</span> position <span class="token operator">=</span> context<span class="token punctuation">.</span>chart<span class="token punctuation">.</span>canvas<span class="token punctuation">.</span><span class="token function">getBoundingClientRect</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
                    <span class="token keyword">const</span> bodyFont <span class="token operator">=</span> Chart<span class="token punctuation">.</span>helpers<span class="token punctuation">.</span><span class="token function">toFont</span><span class="token punctuation">(</span>tooltipModel<span class="token punctuation">.</span>options<span class="token punctuation">.</span>bodyFont<span class="token punctuation">)</span><span class="token punctuation">;</span>
                    <span class="token comment">// Display, position, and set styles for font</span>
                    tooltipEl<span class="token punctuation">.</span>style<span class="token punctuation">.</span>opacity <span class="token operator">=</span> <span class="token number">1</span><span class="token punctuation">;</span>
                    tooltipEl<span class="token punctuation">.</span>style<span class="token punctuation">.</span>position <span class="token operator">=</span> <span class="token string">'absolute'</span><span class="token punctuation">;</span>
                    tooltipEl<span class="token punctuation">.</span>style<span class="token punctuation">.</span>left <span class="token operator">=</span> position<span class="token punctuation">.</span>left <span class="token operator">+</span> window<span class="token punctuation">.</span>pageXOffset <span class="token operator">+</span> tooltipModel<span class="token punctuation">.</span>caretX <span class="token operator">+</span> <span class="token string">'px'</span><span class="token punctuation">;</span>
                    tooltipEl<span class="token punctuation">.</span>style<span class="token punctuation">.</span>top <span class="token operator">=</span> position<span class="token punctuation">.</span>top <span class="token operator">+</span> window<span class="token punctuation">.</span>pageYOffset <span class="token operator">+</span> tooltipModel<span class="token punctuation">.</span>caretY <span class="token operator">+</span> <span class="token string">'px'</span><span class="token punctuation">;</span>
                    tooltipEl<span class="token punctuation">.</span>style<span class="token punctuation">.</span>font <span class="token operator">=</span> bodyFont<span class="token punctuation">.</span>string<span class="token punctuation">;</span>
                    tooltipEl<span class="token punctuation">.</span>style<span class="token punctuation">.</span>padding <span class="token operator">=</span> tooltipModel<span class="token punctuation">.</span>padding <span class="token operator">+</span> <span class="token string">'px '</span> <span class="token operator">+</span> tooltipModel<span class="token punctuation">.</span>padding <span class="token operator">+</span> <span class="token string">'px'</span><span class="token punctuation">;</span>
                    tooltipEl<span class="token punctuation">.</span>style<span class="token punctuation">.</span>pointerEvents <span class="token operator">=</span> <span class="token string">'none'</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><span class="token punctuation">;</span>
</code></pre></div><p>See <a href="/docs/next/samples/tooltip/html.html">samples</a> for examples on how to get started with external tooltips.</p> <h2 id="tooltip-model"><a href="#tooltip-model" class="header-anchor">#</a> Tooltip Model</h2> <p>The tooltip model contains parameters that can be used to render the tooltip.</p> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token punctuation">{</span>
    <span class="token literal-property property">chart</span><span class="token operator">:</span> Chart<span class="token punctuation">,</span>
    <span class="token comment">// The items that we are rendering in the tooltip. See Tooltip Item Interface section</span>
    <span class="token literal-property property">dataPoints</span><span class="token operator">:</span> TooltipItem<span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">,</span>
    <span class="token comment">// Positioning</span>
    <span class="token literal-property property">xAlign</span><span class="token operator">:</span> string<span class="token punctuation">,</span>
    <span class="token literal-property property">yAlign</span><span class="token operator">:</span> string<span class="token punctuation">,</span>
    <span class="token comment">// X and Y properties are the top left of the tooltip</span>
    <span class="token literal-property property">x</span><span class="token operator">:</span> number<span class="token punctuation">,</span>
    <span class="token literal-property property">y</span><span class="token operator">:</span> number<span class="token punctuation">,</span>
    <span class="token literal-property property">width</span><span class="token operator">:</span> number<span class="token punctuation">,</span>
    <span class="token literal-property property">height</span><span class="token operator">:</span> number<span class="token punctuation">,</span>
    <span class="token comment">// Where the tooltip points to</span>
    <span class="token literal-property property">caretX</span><span class="token operator">:</span> number<span class="token punctuation">,</span>
    <span class="token literal-property property">caretY</span><span class="token operator">:</span> number<span class="token punctuation">,</span>
    <span class="token comment">// Body</span>
    <span class="token comment">// The body lines that need to be rendered</span>
    <span class="token comment">// Each object contains 3 parameters</span>
    <span class="token comment">// before: string[] // lines of text before the line with the color square</span>
    <span class="token comment">// lines: string[], // lines of text to render as the main item with color square</span>
    <span class="token comment">// after: string[], // lines of text to render after the main lines</span>
    <span class="token literal-property property">body</span><span class="token operator">:</span> object<span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">,</span>
    <span class="token comment">// lines of text that appear after the title but before the body</span>
    <span class="token literal-property property">beforeBody</span><span class="token operator">:</span> string<span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">,</span>
    <span class="token comment">// line of text that appear after the body and before the footer</span>
    <span class="token literal-property property">afterBody</span><span class="token operator">:</span> string<span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">,</span>
    <span class="token comment">// Title</span>
    <span class="token comment">// lines of text that form the title</span>
    <span class="token literal-property property">title</span><span class="token operator">:</span> string<span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">,</span>
    <span class="token comment">// Footer</span>
    <span class="token comment">// lines of text that form the footer</span>
    <span class="token literal-property property">footer</span><span class="token operator">:</span> string<span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">,</span>
    <span class="token comment">// colors to render for each item in body[]. This is the color of the squares in the tooltip</span>
    <span class="token literal-property property">labelColors</span><span class="token operator">:</span> Color<span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">,</span>
    <span class="token literal-property property">labelTextColors</span><span class="token operator">:</span> Color<span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">,</span>
    <span class="token comment">// 0 opacity is a hidden tooltip</span>
    <span class="token literal-property property">opacity</span><span class="token operator">:</span> number<span class="token punctuation">,</span>
    <span class="token comment">// tooltip options</span>
    <span class="token literal-property property">options</span><span class="token operator">:</span> Object
<span class="token punctuation">}</span>
</code></pre></div><h2 id="custom-position-modes"><a href="#custom-position-modes" class="header-anchor">#</a> Custom Position Modes</h2> <p>New modes can be defined by adding functions to the <code>Chart.Tooltip.positioners</code> map.</p> <p>Example:</p> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token keyword">import</span> <span class="token punctuation">{</span> Tooltip <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 comment">/**
 * Custom positioner
 * @function Tooltip.positioners.myCustomPositioner
 * @param elements {Chart.Element[]} the tooltip elements
 * @param eventPosition {Point} the position of the event in canvas coordinates
 * @returns {TooltipPosition} the tooltip position
 */</span>
Tooltip<span class="token punctuation">.</span>positioners<span class="token punctuation">.</span><span class="token function-variable function">myCustomPositioner</span> <span class="token operator">=</span> <span class="token keyword">function</span><span class="token punctuation">(</span><span class="token parameter">elements<span class="token punctuation">,</span> eventPosition</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
    <span class="token comment">// A reference to the tooltip model</span>
    <span class="token keyword">const</span> tooltip <span class="token operator">=</span> <span class="token keyword">this</span><span class="token punctuation">;</span>
    <span class="token comment">/* ... */</span>
    <span class="token keyword">return</span> <span class="token punctuation">{</span>
        <span class="token literal-property property">x</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span>
        <span class="token literal-property property">y</span><span class="token operator">:</span> <span class="token number">0</span>
        <span class="token comment">// You may also include xAlign and yAlign to override those tooltip options.</span>
    <span class="token punctuation">}</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span><span class="token punctuation">;</span>
<span class="token comment">// Then, to use it...</span>
<span class="token keyword">new</span> <span class="token class-name">Chart<span class="token punctuation">.</span>js</span><span class="token punctuation">(</span>ctx<span class="token punctuation">,</span> <span class="token punctuation">{</span>
    data<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">tooltip</span><span class="token operator">:</span> <span class="token punctuation">{</span>
                <span class="token literal-property property">position</span><span class="token operator">:</span> <span class="token string">'myCustomPositioner'</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>See <a href="/docs/next/samples/tooltip/position.html">samples</a> for a more detailed example.</p> <p>If you're using TypeScript, you'll also need to register the new mode:</p> <div class="language-typescript extra-class"><pre class="language-typescript"><code><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">TooltipPositionerMap</span> <span class="token punctuation">{</span>
    myCustomPositioner<span class="token operator">:</span> TooltipPositionerFunction<span class="token operator">&lt;</span>ChartType<span class="token operator">&gt;</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">11/13/2022, 8:16:32 PM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
      ←
      <a href="/docs/next/configuration/title.html" class="prev">
        Title
      </a></span> <span class="next"><a href="/docs/next/charts/area.html">
        Area Chart
      </a>
      →
    </span></p></div> </main></div><div class="global-ui"></div></div>
    <script src="/docs/next/assets/js/app.79ca5bdb.js" defer></script><script src="/docs/next/assets/js/2.5288603d.js" defer></script><script src="/docs/next/assets/js/166.81f1fd29.js" defer></script>
  </body>
</html>