From 9433a97ccb7250d8131a5a74aa6d3ee757fc1f37 Mon Sep 17 00:00:00 2001 From: Evert Timberg Date: Sun, 24 Oct 2021 11:06:33 -0400 Subject: [PATCH] Add warning about chart types overriding plugin defaults --- docs/configuration/legend.md | 4 ++++ docs/configuration/tooltip.md | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/docs/configuration/legend.md b/docs/configuration/legend.md index 10fa89cd32a..151a96911cb 100644 --- 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 index bac1a0b9407..527b15d99bc 100644 --- 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?