Add warning about chart types overriding plugin defaults (#9787)

chartjs · Oct 24, 2021 · 2f4962f · 2f4962f
1 parent 40e88ba
commit 2f4962f
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/docs/configuration/legend.md b/docs/configuration/legend.md
@@ -6,6 +6,10 @@ The chart legend displays data about the datasets that are appearing on the char
 
 Namespace: `options.plugins.legend`, the global options for the chart legend is defined in `Chart.defaults.plugins.legend`.
 
+:::warning
+The bubble, doughnut, pie, and polar area charts override the tooltip defaults. To change the overrides for those chart types, the options are defined in `Chart.overrides[type].plugins.tooltip`. 
+:::
+
 | Name | Type | Default | Description
 | ---- | ---- | ------- | -----------
 | `display` | `boolean` | `true` | Is the legend shown?

diff --git a/docs/configuration/tooltip.md b/docs/configuration/tooltip.md
@@ -4,6 +4,10 @@
 
 Namespace: `options.plugins.tooltip`, the global options for the chart tooltips is defined in `Chart.defaults.plugins.tooltip`.
 
+:::warning
+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 `Chart.overrides[type].plugins.tooltip`. 
+:::
+
 | Name | Type | Default | Description
 | ---- | ---- | ------- | -----------
 | `enabled` | `boolean` | `true` | Are on-canvas tooltips enabled?