API / Series/Area / AreaSeries
Defined in: src/core/types/chart/area.ts:76
Extends
Type Parameters
| Type Parameter | Default type |
|---|---|
T |
MeaningfulAny |
Properties
| Property | Type | Description |
|---|---|---|
color? |
SeriesColor |
The solid or linear-gradient color of the line and the default color of the area fill. |
cursor? |
string |
You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked. |
custom? |
any |
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 |
data |
AreaSeriesData<T>[] |
- |
dataLabels? |
Omit<BaseDataLabels, "format"> & object |
Options for the series data labels, appearing next to each data point. |
fillColor? |
SeriesColor |
An optional solid or linear-gradient override for the area fill. When omitted, the area fill inherits color. |
legend? |
BaseSeriesLegend & object |
Individual series legend options. Has higher priority than legend options in widget data |
lineWidth? |
number |
Pixel width of the graph line. Default 1 |
marker? |
AreaMarkerOptions |
Options for the point markers of line in area series |
name |
string |
The name of the series (used in legend, tooltip etc) |
nullMode? |
"connect" | "skip" | "zero" |
Specifies how null or undefined values should be handled in the series. - 'connect': Connect points across null values (skip nulls in rendering). Not supported with stacking. - 'zero': Treat null values as zero - 'skip': Omit the data point (creates gap in area) Default 'skip' |
opacity? |
number |
Fill opacity for the area Default 0.75 |
rangeSlider? |
ChartSeriesRangeSliderOptions |
Options to configure how this series appears and behaves in the Range Slider component. |
stackId? |
string |
This option allows grouping series in a stacked chart |
stacking? |
"percent" | "normal" |
Whether to stack the values of each series on top of each other. Possible values are undefined to disable, "normal" to stack by value or "percent" Percent stacking supports only non-negative values. |
stackLabels? |
StackLabelsOptions |
Override plugin stack label options. Only enabled series contribute to totals. |
tooltip? |
Omit<{ enabled: boolean; valueFormat: ValueFormat<CustomFormatContext>; }, "valueFormat"> & object |
Options for the tooltip that appears when the user hovers over a series or point. |
type |
"area" |
Area series: a line with the region below it filled. |
visible? |
boolean |
Initial visibility of the series |
yAxis? |
number |
Y-axis index (when using two axes) |
Previous
Next