From c35bee1f4f852b131e56ba905102481989685d56 Mon Sep 17 00:00:00 2001 From: Jukka Kurkela Date: Sat, 10 Apr 2021 15:59:14 +0300 Subject: [PATCH] Document the no-parsing requirement of decimation (#8869) --- docs/configuration/decimation.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/configuration/decimation.md b/docs/configuration/decimation.md index 2b828fc8a58..9f3c286b459 100644 --- a/docs/configuration/decimation.md +++ b/docs/configuration/decimation.md @@ -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