API / Series/Area-Range / AreaRangeSeries

Defined in: src/core/types/chart/area-range.ts:24

A band between two Y values at each X position. Incomplete points do not contribute to the Y domain.

Extends

Type Parameters

Type Parameter Default type
T MeaningfulAny

Properties

Property Type Description
color? SeriesColor Solid or gradient boundary color, also used for the fill unless fillColor is provided.
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? 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
data AreaRangeSeriesData<T>[] -
dataLabels? BaseDataLabels Options for the series data labels, appearing next to each data point.
fillColor? SeriesColor Optional solid or gradient fill override. Defaults to color.
legend? BaseSeriesLegend & object Per-series legend settings, overriding chart-level settings.
lineWidth? number Width of both boundary lines in pixels. Default 1
marker? AreaMarkerOptions Marker options for both boundaries. Normal markers are hidden by default.
name string Series name used in the legend and tooltip.
nullMode? "connect" | "skip" Incomplete points create gaps with 'skip'; 'connect' joins the surrounding complete points. Default 'skip'
opacity? number Fill opacity. Default 0.75
rangeSlider? ChartSeriesRangeSliderOptions Visibility and appearance of this series in the range slider.
tooltip? object Options for the tooltip that appears when the user hovers over a series or point.
tooltip.enabled? boolean Enable or disable the visibility of this series in the tooltip. Default true
tooltip.valueFormat? ValueFormat<CustomFormatContext> Formatting settings for tooltip value.
type "area-range" -
visible? boolean Initial visibility of the series
yAxis? number Index of the series Y axis. Default 0
Previous
Overview
Next
AreaRangeSeriesData