]> git.ipfire.org Git - thirdparty/Chart.js.git/commitdiff
Add warning about chart types overriding plugin defaults (#9787)
authorEvert Timberg <evert.timberg+github@gmail.com>
Sun, 24 Oct 2021 16:14:37 +0000 (12:14 -0400)
committerGitHub <noreply@github.com>
Sun, 24 Oct 2021 16:14:37 +0000 (12:14 -0400)
docs/configuration/legend.md
docs/configuration/tooltip.md

index 10fa89cd32a61b36fd0066597f7ad73a8b721b6c..151a96911cb01895ef453d39ad036ce30a3cb757 100644 (file)
@@ -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?
index bac1a0b94078905d123e812a793ca3327b6db12b..527b15d99bc83ffd94cbb26655952614a8bdae12 100644 (file)
@@ -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?