ChartSeries Class

Serves as the base class for chart series.

Declaration

export abstract class ChartSeries extends DataItemContainer

Remarks

The ChartSeries class descendants represent different types of chart series: bar, scatter, line and area plots (SimpleSeries), range (RangeSeries), weighted (WeightedSeries), financial (HighLowCloseSeries and OpenHighLowCloseSeries) graphs.

Chart series are stored in the ChartPane.series collection exposed by a pane that displays these series.

constructor

Initializes a new instance of the ChartSeries class.

Declaration

constructor(
    seriesJSON?: any,
    serializer?: ModelSerializer
)

Parameters

Name Type Description
seriesJSON any
serializer ModelSerializer

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

Properties

ignoreEmptyPoints Property

Specifies whether empty points are ignored when plotting the current chart series.

Declaration

ignoreEmptyPoints: ko.Observable<boolean>

Property Value

Type Description
Observable<boolean>

true, to ignore empty points; otherwise, false.

Remarks

Points that have no values defined for some of their arguments are treated as empty points. Depending on the ignoreEmptyPoints property value, chart series are plotted with or without intervals.

plotOnSecondaryAxis Property

Specifies a value indicating whether to plot series using the secondary axis.

Declaration

plotOnSecondaryAxis: ko.Observable<boolean>

Property Value

Type Description
Observable<boolean>

true, to plot series using the secondary axis; otherwise, false.

Remarks

Set the plotOnSecondaryAxis property to true to plot an additional series on the secondary axis.

pointLabelOptions Property

Provides access to options related to series point labels.

Declaration

pointLabelOptions: PointLabelOptions

Property Value

Type Description
PointLabelOptions

A PointLabelOptions object that contains options related to series point labels.

showPointMarkers Property

Specifies a value indicating whether series point markers are visible.

Declaration

showPointMarkers: ko.Observable<boolean>

Property Value

Type Description
Observable<boolean>

true, to show point markers; otherwise, false.

Methods

grabFrom(series) Method

Declaration

grabFrom(
    series: ChartSeries
): void

Parameters

Name Type
series ChartSeries