API / Series/Area / AreaSeries
Defined in: src/types/chart/area.ts:49
Extends
Type Parameters
| Type Parameter | Default type |
|---|---|
T |
MeaningfulAny |
Properties
| Property | Type | Description |
|---|---|---|
color? |
string |
The main color of the series (hex, rgba) |
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. |
data |
AreaSeriesData<T>[] |
- |
dataLabels? |
BaseDataLabels |
Options for the series data labels, appearing next to each data point. |
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? |
"zero" | "skip" | "connect" |
Specifies how null or undefined values should be handled in the series. - 'connect': Connect points across null values (skip nulls in rendering) - '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" Default undefined |
tooltip? |
object |
Options for the tooltip that appears when the user hovers over a series or point. |
tooltip.valueFormat? |
ValueFormat |
Formatting settings for tooltip value. |
type |
"area" |
- |
visible? |
boolean |
Initial visibility of the series |
yAxis? |
number |
Y-axis index (when using two axes) |
Previous
Next