mirror of
https://github.com/chartjs/Chart.js.git
synced 2026-03-04 07:24:02 +01:00
Tooltip Model documentation sounds not correct (#7592)
Tooltip Model documentation sounds not correct Fixed #7591
This commit is contained in:
committed by
Evert Timberg
parent
948355ef30
commit
73da99a136
@@ -291,8 +291,6 @@ The tooltip model contains parameters that can be used to render the tooltip.
|
||||
dataPoints: TooltipItem[],
|
||||
|
||||
// Positioning
|
||||
xPadding: number,
|
||||
yPadding: number,
|
||||
xAlign: string,
|
||||
yAlign: string,
|
||||
|
||||
@@ -316,31 +314,14 @@ The tooltip model contains parameters that can be used to render the tooltip.
|
||||
beforeBody: string[],
|
||||
// line of text that appear after the body and before the footer
|
||||
afterBody: string[],
|
||||
bodyFont: Font,
|
||||
_bodyAlign: string,
|
||||
bodySpacing: number,
|
||||
|
||||
// Title
|
||||
// lines of text that form the title
|
||||
title: string[],
|
||||
titleFont: Font,
|
||||
_titleAlign: string,
|
||||
titleSpacing: number,
|
||||
titleMarginBottom: number,
|
||||
|
||||
// Footer
|
||||
// lines of text that form the footer
|
||||
footer: string[],
|
||||
footerFont: Font,
|
||||
_footerAlign: string,
|
||||
footerSpacing: number,
|
||||
footerMarginTop: number,
|
||||
|
||||
// Appearance
|
||||
caretSize: number,
|
||||
caretPadding: number,
|
||||
cornerRadius: number,
|
||||
backgroundColor: Color,
|
||||
|
||||
// colors to render for each item in body[]. This is the color of the squares in the tooltip
|
||||
labelColors: Color[],
|
||||
@@ -348,9 +329,8 @@ The tooltip model contains parameters that can be used to render the tooltip.
|
||||
|
||||
// 0 opacity is a hidden tooltip
|
||||
opacity: number,
|
||||
multiKeyBackground: Color,
|
||||
displayColors: boolean,
|
||||
borderColor: Color,
|
||||
borderWidth: number
|
||||
|
||||
// tooltip options
|
||||
options : Object
|
||||
}
|
||||
```
|
||||
|
||||
@@ -188,6 +188,7 @@ Animation system was completely rewritten in Chart.js v3. Each property can now
|
||||
* `xLabel` and `yLabel` were removed. Please use `index` and `value`
|
||||
* The `filter` option will now be passed additional parameters when called and should have the method signature `function(tooltipItem, index, tooltipItems, data)`
|
||||
* The `custom` callback now takes a context object that has `tooltip` and `chart` properties
|
||||
* All properties of tooltip model related to the tooltip options have been moved to reside within the `options` property.
|
||||
|
||||
## Developer migration
|
||||
|
||||
|
||||
Reference in New Issue
Block a user