Skip to main content
A newer version of this page is available. .

RangeSeries Class

A Range series.

Declaration

export class RangeSeries extends ChartSeries

Remarks

A Range series contains two values for each argument value. These values can be presented with bars displayed along the Y-axis (the Range Bar series type) or lines can be stroked through the adjacent points, filling the area between them (the Range Area series type).

A Range series requires two measures. They are used to calculate the limits of the data range. Use the RangeSeries.value1 and RangeSeries.value2 to specify a measure that provides data used to calculate the first and second series of values.

To plot a series within the ChartItem, add the RangeSeries object to the ChartPane.series collection of a pane where you need to display this series. Use the ChartItem.panes property to access a desired pane.

Inheritance

ChartSeries
RangeSeries

constructor(dataItemProvider)

Declaration

constructor(
    dataItemProvider: DataDashboardItem,
    seriesJSON?: any,
    serializer?: DxDesigner.Analytics.Utils.ModelSerializer
)

Parameters

Name Type Description
dataItemProvider DataDashboardItem
seriesJSON any
serializer DxDesigner.Analytics.Utils.ModelSerializer

An object used for a dashboard deserialization. Do not pass this parameter directly.

Properties

seriesType Property

Specifies the series type.

Declaration

seriesType: ko.Observable<RangeSeriesType>

Property Value

Type Description
Observable<RangeSeriesType>

A RangeSeriesType value that specifies the series type.

value1 Property

Specifies a measure that provides data used to calculate the first series of values.

Declaration

value1: ko.Observable<Measure>

Property Value

Type Description
Observable<Measure>

A Measure object that provides data used to calculate the first series of values.

value2 Property

Specifies a measure that provides data used to calculate the first series of values.

Declaration

value2: ko.Observable<Measure>

Property Value

Type Description
Observable<Measure>

A Measure object that provides data used to calculate the first series of values.

Methods

getInfo Method

For internal use.

Declaration

getInfo(): DxDesigner.Analytics.Utils.ISerializationInfoArray

Returns

Type Description
DxDesigner.Analytics.Utils.ISerializationInfoArray