API / Series/Scatter / ScatterClusterOptions
Defined in: src/core/types/chart/scatter.ts:42
Properties
| Property | Type | Description |
|---|---|---|
dataLabels? |
ScatterClusterDataLabelsOptions |
Centered count label options. Enabled by default; allowOverlap defaults to true. |
enabled? |
boolean |
Whether to cluster visible points. Existing scatter behavior is unchanged when disabled. Default false |
layoutAlgorithm? |
ScatterClusterLayoutAlgorithmOptions |
Grid layout settings; only the grid algorithm is supported. |
marker? |
PointMarkerOptions |
Marker appearance, using PointMarkerOptions; the default cluster radius is 8 pixels. |
minimumClusterSize? |
number |
Minimum number of points required to form a cluster; must be an integer of at least 2. Default 2 Minimum 2 Multiple Of 1 |
overlapMode? |
"shift" | "allow" |
Placement of cluster markers that overlap other clusters or single points in the same series. Only cluster markers can move, and only within their original grid cells; source coordinates and membership remain unchanged. Separation is best-effort. - 'allow': Leave cluster markers at their centroids. - 'shift': Move overlapping cluster markers within their cells when space permits. Default 'allow' |