ScatterDecimator class

Bases: Decimator

A decimator designed for scatter charts.

This algorithm fits the data points into a grid. If multiple points are in the same grid cell, depending on the chart configuration, some points are removed to reduce the number points being displayed.

This class can only be used with scatter charts.

Methods

__init__()

__init__(
    binning_ratio: Optional[float] = None,
    max_overlap_points: Optional[int] = None,
    threshold: Optional[int] = None,
    zoom: Optional[bool] = True,
)

Initialize a new ScatterDecimator.

Parameters:

Name	Type	Description	Default
binning_ratio	Optional[float]	the size of the data grid for the algorithm. The higher the value, the smaller the grid size.	None
max_overlap_points	Optional(int	the maximum number of points for a single cell within the data grid within the algorithm. This dictates how dense a single grid cell can be.	None
threshold	Optional[int]	The minimum amount of data points before the decimation is applied.	None
zoom	Optional[bool]	set to True to reapply the decimation when zoom or re-layout events are triggered.	True