From: stockiNail <stocki.nail@gmail.com>
Date: Wed, 8 Jul 2020 21:17:53 +0000 (+0200)
Subject: Tooltip Model documentation sounds not correct (#7592)
X-Git-Tag: v3.0.0-beta.2~54
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=69c8cc7e7b8965c63806091fb0861fd141f17126;p=thirdparty%2FChart.js.git

Tooltip Model documentation sounds not correct (#7592)

Tooltip Model documentation sounds not correct
Fixed #7591
---

diff --git a/docs/docs/configuration/tooltip.md b/docs/docs/configuration/tooltip.md
index 3fb37fc6c..85dc19a8a 100644
--- a/docs/docs/configuration/tooltip.md
+++ b/docs/docs/configuration/tooltip.md
@@ -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
 }
 ```
diff --git a/docs/docs/getting-started/v3-migration.md b/docs/docs/getting-started/v3-migration.md
index c3f3a929b..c264a1d62 100644
--- a/docs/docs/getting-started/v3-migration.md
+++ b/docs/docs/getting-started/v3-migration.md
@@ -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