Chart.js/docs/samples/tooltip/position.md
Evert Timberg 66ee0fecaf
Vuepress samples (#8756)
* Generate API docs with vuepress-plugin-typedoc

* Links, fixes, cleanup

* Convert bar samples to Vuepress

* Some line chart samples moved over

* Fix lint issues

* Derived axis type sample

* LineAreaStacked chart created in vuepress

* added radar area axample

* Line dataset added sample

* final area example added

* Add derived-chart-type

* Bar scriptable sample

* Scriptable samples

* Clean lint errors

* added linear axis samples to vuepress

* change tab to spaces to fix lint error

* Convert the rest of the scale samples

* Scale option samples

* Fix typo

* Fixes

* Legend samples

* Title samples

* Change the title of the tip block to Note (#8758)

* Convert bar samples to Vuepress

* Some line chart samples moved over

* Fix lint issues

* Derived axis type sample

* LineAreaStacked chart created in vuepress

* added radar area axample

* Line dataset added sample

* final area example added

* Add derived-chart-type

* Bar scriptable sample

* Scriptable samples

* Clean lint errors

* added linear axis samples to vuepress

* change tab to spaces to fix lint error

* Convert the rest of the scale samples

* Scale option samples

* Fix typo

* Fixes

* Legend samples

* Advanced samples

* Remove extra section

* Animation samples

* Hide legend from progressive line

* Add a comment on what `from` does

* Tooltip samples

* Ädd other charts to vuepress samples

* enable plugin again since all samples have been converted

* fix skip radar example, middle skip was not calculated correctly

* lint error

* Progressive-line: add 2nd line

* Fix lint errors

Co-authored-by: Jukka Kurkela <jukka.kurkela@gmail.com>
Co-authored-by: Jacco van den Berg <jaccoberg2281@gmail.com>
Co-authored-by: Jacco van den Berg <39033624+LeeLenaleee@users.noreply.github.com>
2021-04-02 08:04:39 -04:00

93 lines
1.9 KiB
Markdown

# Position
This sample shows how to use the tooltip position mode setting.
```js chart-editor
// <block:actions:3>
const actions = [
{
name: 'Position: average',
handler(chart) {
chart.options.plugins.tooltip.position = 'average';
chart.update();
}
},
{
name: 'Position: nearest',
handler(chart) {
chart.options.plugins.tooltip.position = 'nearest';
chart.update();
}
},
{
name: 'Position: bottom (custom)',
handler(chart) {
chart.options.plugins.tooltip.position = 'bottom';
chart.update();
}
},
];
// </block:actions>
// <block:setup:2>
const DATA_COUNT = 7;
const NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};
const data = {
labels: Utils.months({count: DATA_COUNT}),
datasets: [
{
label: 'Dataset 1',
data: Utils.numbers(NUMBER_CFG),
fill: false,
borderColor: Utils.CHART_COLORS.red,
backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),
},
{
label: 'Dataset 2',
data: Utils.numbers(NUMBER_CFG),
fill: false,
borderColor: Utils.CHART_COLORS.blue,
backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),
},
]
};
// </block:setup>
// <block:positioner:1>
// Create a custom tooltip positioner to put at the bottom of the chart area
components.Tooltip.positioners.bottom = function(items) {
const pos = components.Tooltip.positioners.average(items);
const chart = this._chart;
return {
x: pos.x,
y: chart.chartArea.bottom,
};
};
// </block:positioner>
// <block:config:0>
const config = {
type: 'line',
data: data,
options: {
interaction: {
intersect: false,
mode: 'index',
},
plugins: {
title: {
display: true,
text: (ctx) => 'Tooltip position mode: ' + ctx.chart.options.plugins.tooltip.position,
},
}
}
};
// </block:config>
module.exports = {
actions: actions,
config: config,
};
```