Skip to content

Commit 2f4962f

Browse files
authored
Add warning about chart types overriding plugin defaults (#9787)
1 parent 40e88ba commit 2f4962f

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

docs/configuration/legend.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ The chart legend displays data about the datasets that are appearing on the char
66

77
Namespace: `options.plugins.legend`, the global options for the chart legend is defined in `Chart.defaults.plugins.legend`.
88

9+
:::warning
10+
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`.
11+
:::
12+
913
| Name | Type | Default | Description
1014
| ---- | ---- | ------- | -----------
1115
| `display` | `boolean` | `true` | Is the legend shown?

docs/configuration/tooltip.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44

55
Namespace: `options.plugins.tooltip`, the global options for the chart tooltips is defined in `Chart.defaults.plugins.tooltip`.
66

7+
:::warning
8+
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`.
9+
:::
10+
711
| Name | Type | Default | Description
812
| ---- | ---- | ------- | -----------
913
| `enabled` | `boolean` | `true` | Are on-canvas tooltips enabled?

0 commit comments

Comments
 (0)