From: Evert Timberg Date: Sun, 28 Feb 2021 00:46:58 +0000 (-0500) Subject: Clarify interaction docs to indicate they apply to all interactions (#8537) X-Git-Tag: v3.0.0-beta.13~25 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d08eb147fc6228f010141ddf3c50937d9d477bb0;p=thirdparty%2FChart.js.git Clarify interaction docs to indicate they apply to all interactions (#8537) * Clarify interaction docs to indicate they apply to all interactions * Update note on modes documentation to indicate interaction options exist * Fix ytpo --- diff --git a/docs/docs/configuration/interactions/index.md b/docs/docs/configuration/interactions/index.md index 7e37780b1..6b94f168e 100644 --- a/docs/docs/configuration/interactions/index.md +++ b/docs/docs/configuration/interactions/index.md @@ -6,8 +6,8 @@ Namespace: `options.interaction`, the global interaction configuration is at `Ch | Name | Type | Default | Description | ---- | ---- | ------- | ----------- -| `mode` | `string` | `'nearest'` | Sets which elements appear in the tooltip. See [Interaction Modes](modes.md#interaction-modes) for details. -| `intersect` | `boolean` | `true` | if true, the hover mode only applies when the mouse position intersects an item on the chart. +| `mode` | `string` | `'nearest'` | Sets which elements appear in the interaction. See [Interaction Modes](modes.md#interaction-modes) for details. +| `intersect` | `boolean` | `true` | if true, the interaction mode only applies when the mouse position intersects an item on the chart. | `axis` | `string` | `'x'` | Can be set to `'x'`, `'y'`, or `'xy'` to define which directions are used in calculating distances. Defaults to `'x'` for `'index'` mode and `'xy'` in `dataset` and `'nearest'` modes. -The same options can be set into the `options.hover` namespace, in which case they will only affect the hover effect and the tooltip configuration will be kept independent. +By default, these options apply to both the hover and tooltip interactions. The same options can be set in the `options.hover` namespace, in which case they will only affect the hover interaction. Similarly, the options can be set in the `options.plugins.tooltip` namespace to independently configure the tooltip interactions. diff --git a/docs/docs/configuration/interactions/modes.md b/docs/docs/configuration/interactions/modes.md index fe7e21fcf..bfd989f25 100644 --- a/docs/docs/configuration/interactions/modes.md +++ b/docs/docs/configuration/interactions/modes.md @@ -2,7 +2,7 @@ title: Interaction Modes --- -When configuring interaction with the graph via hover or tooltips, a number of different modes are available. +When configuring the interaction with the graph via `interaction`, `hover` or `tooltips`, a number of different modes are available. `options.hover` and `options.plugins.tooltip` extend from `options.interaction`. So if `mode`, `intersect` or any other common settings are configured only in `options.interaction`, both hover and tooltips obey that.