API / Series/Area / AreaSeriesData

Defined in: src/core/types/chart/area.ts:10

Extends

Type Parameters

Type Parameter Default type
T MeaningfulAny

Properties

Property Type Description
annotation? ChartPointAnnotation Annotation displayed near this data point as a bubble with text label and optional marker. Useful for highlighting specific values, events, or adding contextual notes.
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.
marker? object Individual marker options for the point.
marker.color? string Fill color of the marker for this point
marker.states? object States for a single point marker.
marker.states.normal? object The normal state of a single point marker.
marker.states.normal.enabled boolean Enable or disable the point marker. Default false
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? 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
AreaSeries
Next
Overview