From 56661e448d8478e7cbce0f30d70d0bf1d2a2da8c Mon Sep 17 00:00:00 2001 From: stockiNail Date: Tue, 1 Feb 2022 13:50:19 +0100 Subject: [PATCH] Sort line and bubble dataset options alphabetically (#10100) * Sort line and bubble dataset options alphabetically * moves drawActiveElementsOnTop to general section --- docs/charts/bubble.md | 6 +++--- docs/charts/line.md | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/charts/bubble.md b/docs/charts/bubble.md index 32861272945..510df195676 100644 --- a/docs/charts/bubble.md +++ b/docs/charts/bubble.md @@ -53,6 +53,7 @@ The bubble chart allows a number of properties to be specified for each dataset. | [`borderWidth`](#styling) | `number` | Yes | Yes | `3` | [`clip`](#general) | `number`\|`object` | - | - | `undefined` | [`data`](#data-structure) | `object[]` | - | - | **required** +| [`drawActiveElementsOnTop`](#general) | `boolean` | Yes | Yes | `true` | [`hoverBackgroundColor`](#interactions) | [`Color`](../general/colors.md) | Yes | Yes | `undefined` | [`hoverBorderColor`](#interactions) | [`Color`](../general/colors.md) | Yes | Yes | `undefined` | [`hoverBorderWidth`](#interactions) | `number` | Yes | Yes | `1` @@ -63,7 +64,6 @@ The bubble chart allows a number of properties to be specified for each dataset. | [`pointStyle`](#styling) | [`pointStyle`](../configuration/elements.md#types) | Yes | Yes | `'circle'` | [`rotation`](#styling) | `number` | Yes | Yes | `0` | [`radius`](#styling) | `number` | Yes | Yes | `3` -| [`drawActiveElementsOnTop`](#styling) | `boolean` | Yes | Yes | `true` All these values, if `undefined`, fallback to the scopes described in [option resolution](../general/options) @@ -72,6 +72,7 @@ All these values, if `undefined`, fallback to the scopes described in [option re | Name | Description | ---- | ---- | `clip` | How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. `0` = clip at chartArea. Clipping can also be configured per side: `clip: {left: 5, top: false, right: -2, bottom: 0}` +| `drawActiveElementsOnTop` | Draw the active bubbles of a dataset over the other bubbles of the dataset | `label` | The label for the dataset which appears in the legend and tooltips. | `order` | The drawing order of dataset. Also affects order for tooltip and legend. [more](mixed.md#drawing-order) @@ -87,7 +88,6 @@ The style of each bubble can be controlled with the following properties: | `pointStyle` | bubble [shape style](../configuration/elements.md#point-styles). | `rotation` | bubble rotation (in degrees). | `radius` | bubble radius (in pixels). -| `drawActiveElementsOnTop` | Draw the active bubbles of a dataset over the other bubbles of the dataset All these values, if `undefined`, fallback to the associated [`elements.point.*`](../configuration/elements.md#point-configuration) options. @@ -97,11 +97,11 @@ The interaction with each bubble can be controlled with the following properties | Name | Description | ---- | ----------- +| `hitRadius` | bubble **additional** radius for hit detection (in pixels). | `hoverBackgroundColor` | bubble background color when hovered. | `hoverBorderColor` | bubble border color when hovered. | `hoverBorderWidth` | bubble border width when hovered (in pixels). | `hoverRadius` | bubble **additional** radius when hovered (in pixels). -| `hitRadius` | bubble **additional** radius for hit detection (in pixels). All these values, if `undefined`, fallback to the associated [`elements.point.*`](../configuration/elements.md#point-configuration) options. diff --git a/docs/charts/line.md b/docs/charts/line.md index cf0787b9fe1..22a7a349d74 100644 --- a/docs/charts/line.md +++ b/docs/charts/line.md @@ -54,6 +54,7 @@ The line chart allows a number of properties to be specified for each dataset. T | [`clip`](#general) | `number`\|`object` | - | - | `undefined` | [`cubicInterpolationMode`](#cubicinterpolationmode) | `string` | Yes | - | `'default'` | [`data`](#data-structure) | `object`\|`object[]`\| `number[]`\|`string[]` | - | - | **required** +| [`drawActiveElementsOnTop`](#general) | `boolean` | Yes | Yes | `true` | [`fill`](#line-styling) | `boolean`\|`string` | Yes | - | `false` | [`hoverBackgroundColor`](#line-styling) | [`Color`](../general/colors.md) | Yes | - | `undefined` | [`hoverBorderCapStyle`](#line-styling) | `string` | Yes | - | `undefined` @@ -84,7 +85,6 @@ The line chart allows a number of properties to be specified for each dataset. T | [`tension`](#line-styling) | `number` | - | - | `0` | [`xAxisID`](#general) | `string` | - | - | first x axis | [`yAxisID`](#general) | `string` | - | - | first y axis -| [`drawActiveElementsOnTop`](#point-styling) | `boolean` | Yes | Yes | `true` All these values, if `undefined`, fallback to the scopes described in [option resolution](../general/options) @@ -93,6 +93,7 @@ All these values, if `undefined`, fallback to the scopes described in [option re | Name | Description | ---- | ---- | `clip` | How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. `0` = clip at chartArea. Clipping can also be configured per side: `clip: {left: 5, top: false, right: -2, bottom: 0}` +| `drawActiveElementsOnTop` | Draw the active points of a dataset over the other points of the dataset | `indexAxis` | The base axis of the dataset. `'x'` for horizontal lines and `'y'` for vertical lines. | `label` | The label for the dataset which appears in the legend and tooltips. | `order` | The drawing order of dataset. Also affects order for stacking, tooltip and legend. [more](mixed.md#drawing-order) @@ -113,7 +114,6 @@ The style of each point can be controlled with the following properties: | `pointRadius` | The radius of the point shape. If set to 0, the point is not rendered. | `pointRotation` | The rotation of the point in degrees. | `pointStyle` | Style of the point. [more...](../configuration/elements.md#point-styles) -| `drawActiveElementsOnTop` | Draw the active points of a dataset over the other points of the dataset All these values, if `undefined`, fallback first to the dataset options then to the associated [`elements.point.*`](../configuration/elements.md#point-configuration) options.