Skip to content

Commit

Permalink
Document the no-parsing requirement of decimation (#8869)
Browse files Browse the repository at this point in the history
  • Loading branch information
kurkle committed Apr 10, 2021
1 parent 1ffdecf commit c35bee1
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/configuration/decimation.md
Expand Up @@ -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

Expand Down

0 comments on commit c35bee1

Please sign in to comment.