From: Jacco van den Berg <39033624+LeeLenaleee@users.noreply.github.com> Date: Sun, 8 Aug 2021 20:52:09 +0000 (+0200) Subject: fix 2 broken links, clarify order property (#9516) X-Git-Tag: v3.5.1~9 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=bc6ef16f31050bba9003c1fc8350ea81edb509cc;p=thirdparty%2FChart.js.git fix 2 broken links, clarify order property (#9516) --- diff --git a/docs/charts/bar.md b/docs/charts/bar.md index 0543fed64..c7ef6670e 100644 --- a/docs/charts/bar.md +++ b/docs/charts/bar.md @@ -121,9 +121,9 @@ data: { | `grouped` | Should the bars be grouped on index axis. When `true`, all the datasets at same index value will be placed next to each other centering on that index value. When `false`, each bar is placed on its actual index-axis value. | `indexAxis` | The base axis of the dataset. `'x'` for vertical bars and `'y'` for horizontal bars. | `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. +| `order` | The drawing order of dataset. Also affects order for stacking, tooltip and legend. [more](mixed.md#drawing-order) | `skipNull` | If `true`, null or undefined values will not be used for spacing calculations when determining bar size. -| `stack` | The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack). [more](#stacked-bar-charts) +| `stack` | The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack). [more](#stacked-bar-chart) | `xAxisID` | The ID of the x-axis to plot this dataset on. | `yAxisID` | The ID of the y-axis to plot this dataset on. diff --git a/docs/charts/bubble.md b/docs/charts/bubble.md index 44bd9bf2b..61710badf 100644 --- a/docs/charts/bubble.md +++ b/docs/charts/bubble.md @@ -72,7 +72,7 @@ All these values, if `undefined`, fallback to the scopes described in [option re | ---- | ---- | `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}` | `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. +| `order` | The drawing order of dataset. Also affects order for tooltip and legend. [more](mixed.md#drawing-order) ### Styling diff --git a/docs/charts/line.md b/docs/charts/line.md index a41d79d18..fd674a519 100644 --- a/docs/charts/line.md +++ b/docs/charts/line.md @@ -94,8 +94,8 @@ All these values, if `undefined`, fallback to the scopes described in [option re | `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}` | `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. -| `stack` | The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack). [more](#stacked-area-charts) +| `order` | The drawing order of dataset. Also affects order for stacking, tooltip and legend. [more](mixed.md#drawing-order) +| `stack` | The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack). [more](#stacked-area-chart) | `xAxisID` | The ID of the x-axis to plot this dataset on. | `yAxisID` | The ID of the y-axis to plot this dataset on. diff --git a/docs/charts/mixed.md b/docs/charts/mixed.md index 75acae12a..84f42f130 100644 --- a/docs/charts/mixed.md +++ b/docs/charts/mixed.md @@ -73,6 +73,8 @@ module.exports = { By default, datasets are drawn such that the first one is top-most. This can be altered by specifying `order` option to datasets. `order` defaults to `0`. Note that this also affects stacking, legend, and tooltip. So it's essentially the same as reordering the datasets. +The `order` property behaves like a weight instead of a specific order, so the higher the number, the sooner that dataset is drawn on the canvas and thus other datasets with a lower order number will get drawn over it. + ```javascript var mixedChart = new Chart(ctx, { type: 'bar', diff --git a/docs/charts/radar.md b/docs/charts/radar.md index 5281a73f7..47e2a8887 100644 --- a/docs/charts/radar.md +++ b/docs/charts/radar.md @@ -115,7 +115,7 @@ All these values, if `undefined`, fallback to the scopes described in [option re | ---- | ---- | `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}` | `label` | The label for the dataset which appears in the legend and tooltips. -| `order` | The drawing order of dataset. +| `order` | The drawing order of dataset. Also affects order for tooltip and legend. [more](mixed.md#drawing-order) ### Point Styling