2018-03-17 17:07:55 +00:00
<!DOCTYPE HTML>
< html lang = "" >
< head >
< meta charset = "UTF-8" >
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
2018-04-23 00:08:03 +00:00
< title > Modes · Chart.js documentation< / title >
2018-03-17 17:07:55 +00:00
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" / >
< meta name = "description" content = "" >
< meta name = "generator" content = "GitBook 3.2.2" >
< meta name = "author" content = "chartjs" >
< link rel = "stylesheet" href = "../../gitbook/style.css" >
< link rel = "stylesheet" href = "../../gitbook/gitbook-plugin-search-plus/search.css" >
< link rel = "stylesheet" href = "../../gitbook/gitbook-plugin-highlight/website.css" >
< link rel = "stylesheet" href = "../../gitbook/gitbook-plugin-fontsettings/website.css" >
< link rel = "stylesheet" href = "../../style.css" >
< meta name = "HandheldFriendly" content = "true" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1, user-scalable=no" >
< meta name = "apple-mobile-web-app-capable" content = "yes" >
< meta name = "apple-mobile-web-app-status-bar-style" content = "black" >
< link rel = "apple-touch-icon-precomposed" sizes = "152x152" href = "../../gitbook/images/apple-touch-icon-precomposed-152.png" >
< link rel = "shortcut icon" href = "../../gitbook/images/favicon.ico" type = "image/x-icon" >
< link rel = "next" href = "../options.html" / >
< link rel = "prev" href = "events.html" / >
< link rel = "stylesheet" href = "../../gitbook/gitbook-plugin-chartjs/style.css" >
< script src = "../../gitbook/gitbook-plugin-chartjs/Chart.bundle.js" > < / script >
< script src = "../../gitbook/gitbook-plugin-chartjs/chartjs-plugin-deferred.js" > < / script >
< / head >
< body >
< div class = "book" >
< div class = "book-summary" >
< div id = "book-search-input" role = "search" >
< input type = "text" placeholder = "Type to search" / >
< / div >
< nav role = "navigation" >
< ul class = "summary" >
< li class = "chapter " data-level = "1.1" data-path = "../../" >
< a href = "../../" >
Chart.js
< / a >
< / li >
< li class = "chapter " data-level = "1.2" data-path = "../../getting-started/" >
< a href = "../../getting-started/" >
Getting Started
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.2.1" data-path = "../../getting-started/installation.html" >
< a href = "../../getting-started/installation.html" >
Installation
< / a >
< / li >
< li class = "chapter " data-level = "1.2.2" data-path = "../../getting-started/integration.html" >
< a href = "../../getting-started/integration.html" >
Integration
< / a >
< / li >
< li class = "chapter " data-level = "1.2.3" data-path = "../../getting-started/usage.html" >
< a href = "../../getting-started/usage.html" >
Usage
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.3" data-path = "../" >
< a href = "../" >
General
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.3.1" data-path = "../responsive.html" >
< a href = "../responsive.html" >
Responsive
< / a >
< / li >
2018-04-23 00:08:03 +00:00
< li class = "chapter " data-level = "1.3.2" data-path = "../device-pixel-ratio.html" >
< a href = "../device-pixel-ratio.html" >
Pixel Ratio
< / a >
< / li >
< li class = "chapter " data-level = "1.3.3" data-path = "./" >
2018-03-17 17:07:55 +00:00
< a href = "./" >
Interactions
< / a >
< ul class = "articles" >
2018-04-23 00:08:03 +00:00
< li class = "chapter " data-level = "1.3.3.1" data-path = "events.html" >
2018-03-17 17:07:55 +00:00
< a href = "events.html" >
Events
< / a >
< / li >
2018-04-23 00:08:03 +00:00
< li class = "chapter active" data-level = "1.3.3.2" data-path = "modes.html" >
2018-03-17 17:07:55 +00:00
< a href = "modes.html" >
Modes
< / a >
< / li >
< / ul >
< / li >
2018-04-23 00:08:03 +00:00
< li class = "chapter " data-level = "1.3.4" data-path = "../options.html" >
2018-03-17 17:07:55 +00:00
< a href = "../options.html" >
Options
< / a >
< / li >
2018-04-23 00:08:03 +00:00
< li class = "chapter " data-level = "1.3.5" data-path = "../colors.html" >
2018-03-17 17:07:55 +00:00
< a href = "../colors.html" >
Colors
< / a >
< / li >
2018-04-23 00:08:03 +00:00
< li class = "chapter " data-level = "1.3.6" data-path = "../fonts.html" >
2018-03-17 17:07:55 +00:00
< a href = "../fonts.html" >
Fonts
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.4" data-path = "../../configuration/" >
< a href = "../../configuration/" >
Configuration
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.4.1" data-path = "../../configuration/animations.html" >
< a href = "../../configuration/animations.html" >
Animations
< / a >
< / li >
< li class = "chapter " data-level = "1.4.2" data-path = "../../configuration/layout.html" >
< a href = "../../configuration/layout.html" >
Layout
< / a >
< / li >
< li class = "chapter " data-level = "1.4.3" data-path = "../../configuration/legend.html" >
< a href = "../../configuration/legend.html" >
Legend
< / a >
< / li >
< li class = "chapter " data-level = "1.4.4" data-path = "../../configuration/title.html" >
< a href = "../../configuration/title.html" >
Title
< / a >
< / li >
< li class = "chapter " data-level = "1.4.5" data-path = "../../configuration/tooltip.html" >
< a href = "../../configuration/tooltip.html" >
Tooltip
< / a >
< / li >
< li class = "chapter " data-level = "1.4.6" data-path = "../../configuration/elements.html" >
< a href = "../../configuration/elements.html" >
Elements
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.5" data-path = "../../charts/" >
< a href = "../../charts/" >
Charts
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.5.1" data-path = "../../charts/line.html" >
< a href = "../../charts/line.html" >
Line
< / a >
< / li >
< li class = "chapter " data-level = "1.5.2" data-path = "../../charts/bar.html" >
< a href = "../../charts/bar.html" >
Bar
< / a >
< / li >
< li class = "chapter " data-level = "1.5.3" data-path = "../../charts/radar.html" >
< a href = "../../charts/radar.html" >
Radar
< / a >
< / li >
< li class = "chapter " data-level = "1.5.4" data-path = "../../charts/doughnut.html" >
< a href = "../../charts/doughnut.html" >
Doughnut & Pie
< / a >
< / li >
< li class = "chapter " data-level = "1.5.5" data-path = "../../charts/polar.html" >
< a href = "../../charts/polar.html" >
Polar Area
< / a >
< / li >
< li class = "chapter " data-level = "1.5.6" data-path = "../../charts/bubble.html" >
< a href = "../../charts/bubble.html" >
Bubble
< / a >
< / li >
< li class = "chapter " data-level = "1.5.7" data-path = "../../charts/scatter.html" >
< a href = "../../charts/scatter.html" >
Scatter
< / a >
< / li >
< li class = "chapter " data-level = "1.5.8" data-path = "../../charts/area.html" >
< a href = "../../charts/area.html" >
Area
< / a >
< / li >
< li class = "chapter " data-level = "1.5.9" data-path = "../../charts/mixed.html" >
< a href = "../../charts/mixed.html" >
Mixed
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.6" data-path = "../../axes/" >
< a href = "../../axes/" >
Axes
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.6.1" data-path = "../../axes/cartesian/" >
< a href = "../../axes/cartesian/" >
Cartesian
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.6.1.1" data-path = "../../axes/cartesian/category.html" >
< a href = "../../axes/cartesian/category.html" >
Category
< / a >
< / li >
< li class = "chapter " data-level = "1.6.1.2" data-path = "../../axes/cartesian/linear.html" >
< a href = "../../axes/cartesian/linear.html" >
Linear
< / a >
< / li >
< li class = "chapter " data-level = "1.6.1.3" data-path = "../../axes/cartesian/logarithmic.html" >
< a href = "../../axes/cartesian/logarithmic.html" >
Logarithmic
< / a >
< / li >
< li class = "chapter " data-level = "1.6.1.4" data-path = "../../axes/cartesian/time.html" >
< a href = "../../axes/cartesian/time.html" >
Time
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.6.2" data-path = "../../axes/radial/" >
< a href = "../../axes/radial/" >
Radial
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.6.2.1" data-path = "../../axes/radial/linear.html" >
< a href = "../../axes/radial/linear.html" >
Linear
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.6.3" data-path = "../../axes/labelling.html" >
< a href = "../../axes/labelling.html" >
Labelling
< / a >
< / li >
< li class = "chapter " data-level = "1.6.4" data-path = "../../axes/styling.html" >
< a href = "../../axes/styling.html" >
Styling
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.7" data-path = "../../developers/" >
< a href = "../../developers/" >
Developers
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.7.1" data-path = "../../developers/api.html" >
< a href = "../../developers/api.html" >
Chart.js API
< / a >
< / li >
< li class = "chapter " data-level = "1.7.2" data-path = "../../developers/updates.html" >
< a href = "../../developers/updates.html" >
Updating Charts
< / a >
< / li >
< li class = "chapter " data-level = "1.7.3" data-path = "../../developers/plugins.html" >
< a href = "../../developers/plugins.html" >
Plugins
< / a >
< / li >
< li class = "chapter " data-level = "1.7.4" data-path = "../../developers/charts.html" >
< a href = "../../developers/charts.html" >
New Charts
< / a >
< / li >
< li class = "chapter " data-level = "1.7.5" data-path = "../../developers/axes.html" >
< a href = "../../developers/axes.html" >
New Axes
< / a >
< / li >
< li class = "chapter " data-level = "1.7.6" data-path = "../../developers/contributing.html" >
< a href = "../../developers/contributing.html" >
Contributing
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.8" data-path = "../../notes/" >
< a href = "../../notes/" >
Additional Notes
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.8.1" data-path = "../../notes/comparison.html" >
< a href = "../../notes/comparison.html" >
Comparison Table
< / a >
< / li >
< li class = "chapter " data-level = "1.8.2" data-path = "../../notes/extensions.html" >
< a href = "../../notes/extensions.html" >
Popular Extensions
< / a >
< / li >
< li class = "chapter " data-level = "1.8.3" data-path = "../../notes/license.html" >
< a href = "../../notes/license.html" >
License
< / a >
< / li >
< / ul >
< / li >
< li class = "divider" > < / li >
< li >
< a href = "https://www.gitbook.com" target = "blank" class = "gitbook-link" >
Published with GitBook
< / a >
< / li >
< / ul >
< / nav >
< / div >
< div class = "book-body" >
< div class = "body-inner" >
< div class = "book-header" role = "navigation" >
<!-- Title -->
< h1 >
< i class = "fa fa-circle-o-notch fa-spin" > < / i >
< a href = "../.." > Modes< / a >
< / h1 >
< / div >
< div class = "page-wrapper" tabindex = "-1" role = "main" >
< div class = "page-inner" >
< div class = "search-plus" id = "book-search-results" >
< div class = "search-noresults" >
< section class = "normal markdown-section" >
< h1 id = "interaction-modes" > Interaction Modes< / h1 >
< p > When configuring interaction with the graph via hover or tooltips, a number of different modes are available.< / p >
< p > The modes are detailed below and how they behave in conjunction with the < code > intersect< / code > setting.< / p >
< h2 id = "point" > point< / h2 >
< p > Finds all of the items that intersect the point.< / p >
< pre > < code class = "lang-javascript" > < span class = "hljs-keyword" > var< / span > chart = < span class = "hljs-keyword" > new< / span > Chart(ctx, {
type: < span class = "hljs-string" > ' line' < / span > ,
data: data,
options: {
tooltips: {
mode: < span class = "hljs-string" > ' point' < / span >
}
}
})
< / code > < / pre >
< h2 id = "nearest" > nearest< / h2 >
< p > Gets the item that is nearest to the point. The nearest item is determined based on the distance to the center of the chart item (point, bar). If 2 or more items are at the same distance, the one with the smallest area is used. If < code > intersect< / code > is true, this is only triggered when the mouse position intersects an item in the graph. This is very useful for combo charts where points are hidden behind bars.< / p >
< pre > < code class = "lang-javascript" > < span class = "hljs-keyword" > var< / span > chart = < span class = "hljs-keyword" > new< / span > Chart(ctx, {
type: < span class = "hljs-string" > ' line' < / span > ,
data: data,
options: {
tooltips: {
mode: < span class = "hljs-string" > ' nearest' < / span >
}
}
})
< / code > < / pre >
< h2 id = "single-deprecated" > single (deprecated)< / h2 >
< p > Finds the first item that intersects the point and returns it. Behaves like ' nearest' mode with intersect = true.< / p >
< h2 id = "label-deprecated" > label (deprecated)< / h2 >
< p > See < code > ' index' < / code > mode< / p >
< h2 id = "index" > index< / h2 >
2018-04-23 00:08:03 +00:00
< p > Finds item at the same index. If the < code > intersect< / code > setting is true, the first intersecting item is used to determine the index in the data. If < code > intersect< / code > false the nearest item, in the x direction, is used to determine the index.< / p >
2018-03-17 17:07:55 +00:00
< pre > < code class = "lang-javascript" > < span class = "hljs-keyword" > var< / span > chart = < span class = "hljs-keyword" > new< / span > Chart(ctx, {
type: < span class = "hljs-string" > ' line' < / span > ,
data: data,
options: {
tooltips: {
mode: < span class = "hljs-string" > ' index' < / span >
}
}
})
< / code > < / pre >
< p > To use index mode in a chart like the horizontal bar chart, where we search along the y direction, you can use the < code > axis< / code > setting introduced in v2.7.0. By setting this value to < code > ' y' < / code > on the y direction is used.< / p >
< pre > < code class = "lang-javascript" > < span class = "hljs-keyword" > var< / span > chart = < span class = "hljs-keyword" > new< / span > Chart(ctx, {
type: < span class = "hljs-string" > ' horizontalBar' < / span > ,
data: data,
options: {
tooltips: {
mode: < span class = "hljs-string" > ' index' < / span > ,
axis: < span class = "hljs-string" > ' y' < / span >
}
}
})
< / code > < / pre >
< h2 id = "x-axis-deprecated" > x-axis (deprecated)< / h2 >
< p > Behaves like < code > ' index' < / code > mode with < code > intersect = false< / code > .< / p >
< h2 id = "dataset" > dataset< / h2 >
< p > Finds items in the same dataset. If the < code > intersect< / code > setting is true, the first intersecting item is used to determine the index in the data. If < code > intersect< / code > false the nearest item is used to determine the index.< / p >
< pre > < code class = "lang-javascript" > < span class = "hljs-keyword" > var< / span > chart = < span class = "hljs-keyword" > new< / span > Chart(ctx, {
type: < span class = "hljs-string" > ' line' < / span > ,
data: data,
options: {
tooltips: {
mode: < span class = "hljs-string" > ' dataset' < / span >
}
}
})
< / code > < / pre >
< h2 id = "x" > x< / h2 >
< p > Returns all items that would intersect based on the < code > X< / code > coordinate of the position only. Would be useful for a vertical cursor implementation. Note that this only applies to cartesian charts< / p >
< pre > < code class = "lang-javascript" > < span class = "hljs-keyword" > var< / span > chart = < span class = "hljs-keyword" > new< / span > Chart(ctx, {
type: < span class = "hljs-string" > ' line' < / span > ,
data: data,
options: {
tooltips: {
mode: < span class = "hljs-string" > ' x' < / span >
}
}
})
< / code > < / pre >
< h2 id = "y" > y< / h2 >
< p > Returns all items that would intersect based on the < code > Y< / code > coordinate of the position. This would be useful for a horizontal cursor implementation. Note that this only applies to cartesian charts.< / p >
< pre > < code class = "lang-javascript" > < span class = "hljs-keyword" > var< / span > chart = < span class = "hljs-keyword" > new< / span > Chart(ctx, {
type: < span class = "hljs-string" > ' line' < / span > ,
data: data,
options: {
tooltips: {
mode: < span class = "hljs-string" > ' y' < / span >
}
}
})
< / code > < / pre >
< / section >
< / div >
< div class = "search-results" >
< div class = "has-results" >
< h1 class = "search-results-title" > < span class = 'search-results-count' > < / span > results matching "< span class = 'search-query' > < / span > "< / h1 >
< ul class = "search-results-list" > < / ul >
< / div >
< div class = "no-results" >
< h1 class = "search-results-title" > No results matching "< span class = 'search-query' > < / span > "< / h1 >
< / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< a href = "events.html" class = "navigation navigation-prev " aria-label = "Previous page: Events" >
< i class = "fa fa-angle-left" > < / i >
< / a >
< a href = "../options.html" class = "navigation navigation-next " aria-label = "Next page: Options" >
< i class = "fa fa-angle-right" > < / i >
< / a >
< / div >
< script >
var gitbook = gitbook || [];
gitbook.push(function() {
2018-04-23 00:08:03 +00:00
gitbook.page.hasChanged({"page":{"title":"Modes","level":"1.3.3.2","depth":3,"next":{"title":"Options","level":"1.3.4","depth":2,"path":"general/options.md","ref":"general/options.md","articles":[]},"previous":{"title":"Events","level":"1.3.3.1","depth":3,"path":"general/interactions/events.md","ref":"general/interactions/events.md","articles":[]},"dir":"ltr"},"config":{"plugins":["-lunr","-search","search-plus","anchorjs","chartjs","ga"],"root":"./docs","styles":{"website":"style.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"anchorjs":{"icon":"#","placement":"left","visible":"always"},"ga":{"configuration":"auto","token":"UA-28909194-3"},"theme-default":{"styles":{"website":"style.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"search-plus":{},"chartjs":{"defaults":null},"highlight":{},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2}},"theme":"default","author":"chartjs","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Chart.js documentation","gitbook":"3.2.2"},"file":{"path":"general/interactions/modes.md","mtime":"2018-03-01T21:46:31.679Z","type":"markdown"},"gitbook":{"version":"3.2.2","time":"2018-03-01T21:50:47.970Z"},"basePath":"../..","book":{"language":""}});
2018-03-17 17:07:55 +00:00
});
< / script >
< / div >
< script src = "../../gitbook/gitbook.js" > < / script >
< script src = "../../gitbook/theme.js" > < / script >
< script src = "../../gitbook/gitbook-plugin-search-plus/jquery.mark.min.js" > < / script >
< script src = "../../gitbook/gitbook-plugin-search-plus/search.js" > < / script >
2018-04-23 00:08:03 +00:00
< script src = "https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.1.0/anchor.min.js" > < / script >
2018-03-17 17:07:55 +00:00
< script src = "../../gitbook/gitbook-plugin-anchorjs/anchor-style.js" > < / script >
< script src = "../../gitbook/gitbook-plugin-ga/plugin.js" > < / script >
< script src = "../../gitbook/gitbook-plugin-sharing/buttons.js" > < / script >
< script src = "../../gitbook/gitbook-plugin-fontsettings/fontsettings.js" > < / script >
< / body >
< / html >
