archive-gh-me/Chart.js
1
0
Fork 0
mirror of https://github.com/chartjs/Chart.js.git synced 2025-12-08 20:36:08 +00:00
Code Issues Projects Releases Wiki Activity
Chart.js/docs/docs/configuration/decimation.md
LeeLenaleee 4219001280
Clarify options placement (#8427) 
* improve clarity of docs by showing party qualified names in table and place of the namespace above

* add missing line

* remove partial qualified names, made some tables unusable and made it overall bit unclear. Added the namespace above each table

* fix sidebars tabs to spaces

* implement kurkles feedback
2021-02-19 11:44:05 -05:00

1.4 KiB
Raw Blame History

title
Data Decimation

The decimation plugin can be used with line charts to automatically decimate data at the start of the chart lifecycle. Before enabling this plugin, review the requirements to ensure that it will work with the chart you want to create.

Configuration Options

Namespace: options.plugins.decimation, the global options for the plugin are defined in Chart.defaults.plugins.decimation.

Name Type Default Description
enabled boolean true Is decimation enabled?
algorithm string 'min-max' Decimation algorithm to use. See the more...

Decimation Algorithms

Decimation algorithm to use for data. Options are:

  • 'min-max'

Min/Max Decimation

Min/max decimation will preserve peaks in your data but could require up to 4 points for each pixel. This type of decimation would work well for a very noisy signal where you need to see data peaks.

Requirements

To use the decimation plugin, the following requirements must be met:

  1. The dataset must have an indexAxis 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.