]> git.ipfire.org Git - thirdparty/Chart.js.git/commitdiff
Document the no-parsing requirement of decimation (#8869)
authorJukka Kurkela <jukka.kurkela@gmail.com>
Sat, 10 Apr 2021 12:59:14 +0000 (15:59 +0300)
committerGitHub <noreply@github.com>
Sat, 10 Apr 2021 12:59:14 +0000 (08:59 -0400)
docs/configuration/decimation.md

index 2b828fc8a5862858d2c03f5145e792430456061c..9f3c286b459e65df328587d63ea0a3d80ff40243 100644 (file)
@@ -31,10 +31,11 @@ Decimation algorithm to use for data. Options are:
 
 To use the decimation plugin, the following requirements must be met:
 
-1. The dataset must have an `indexAxis` of `'x'`
+1. The dataset must have an [`indexAxis`](../charts/line.md#general) of `'x'`
 2. The dataset must be a line
-3. The X axis for the dataset must be either a `'linear'` or `'time'` type axis
-4. The dataset object must be mutable. The plugin stores the original data as `dataset._data` and then defines a new `data` property on the dataset.
+3. The X axis for the dataset must be either a [`'linear'`](../axes/cartesian/linear.md) or [`'time'`](../axes/cartesian/time.md) type axis
+4. Data must not need parsing, i.e. [`parsing`](../general/data-structures.md#dataset-configuration) must be `false`
+5. The dataset object must be mutable. The plugin stores the original data as `dataset._data` and then defines a new `data` property on the dataset.
 
 ## Related Samples