API / Series/Scatter / ScatterClusterData
Defined in: src/core/types/chart/scatter.ts:9
Extends
Type Parameters
| Type Parameter | Default type |
|---|---|
T |
MeaningfulAny |
Properties
| Property | Type | Description |
|---|---|---|
category? |
string |
Corresponding value of axis category. Deprecated use x or y instead |
cluster? |
object |
Derived metadata present only on cluster points returned to tooltip and click callbacks. |
cluster.points |
ScatterSeriesData<T>[] |
Original points with their coordinates and custom fields unchanged. |
cluster.size |
number |
Number of original points in the cluster; always equals points.length. |
color? |
string |
Individual color for the data chunk (point in scatter, segment in pie, bar etc) |
custom? |
T |
A reserved subspace to store options and values for customized functionality Here you can add additional data for your own event callbacks and formatter callbacks |
dataLabels? |
object |
Per-point overrides for the series data label. |
dataLabels.enabled? |
boolean |
Per-point override of series.dataLabels.enabled. The point-level value takes precedence: true shows the label even when series-level labels are disabled, false hides the label even when series-level labels are enabled. Default series.dataLabels.enabled |
label? |
string | number |
Data label value of the point. If not specified, the y value is used. |
opacity? |
number |
Individual opacity for the point. |
radius? |
number |
Individual radius for the point. |
tooltip? |
object |
Per-point overrides for the tooltip behavior. |
tooltip.enabled? |
boolean |
Per-point override of series.tooltip.enabled. The point-level value takes precedence: true shows the point in the tooltip even when the series is hidden from the tooltip, false hides the point even when the series is shown. Default series.tooltip.enabled |
x? |
null | string | number |
The x value of the point. Depending on the context , it may represents: - numeric value (for linear x axis) - timestamp value (for datetime x axis) - x axis category value (for category x axis). If the type is a string, then it is a category value itself. If the type is a number, then it is the index of an element in the array of categories described in xAxis.categories |
y? |
null | string | number |
The y value of the point. Depending on the context , it may represents: - numeric value (for linear y axis) - timestamp value (for datetime y axis) - y axis category value (for category y axis). If the type is a string, then it is a category value itself. If the type is a number, then it is the index of an element in the array of categories described in yAxis[0].categories |
Previous