ChartPane Class

A chart pane.

Declaration

export class ChartPane extends SerializableModel

Remarks

The ChartPane instances represent chart panes - rectangular areas where series are plotted. A single chart dashboard item can have several panes.

Each pane has its own Y-axis and displays a specific set of series. All panes in a chart share the same X-axis.

wdd-chart-panes

The ChartPane objects provide access to the collection of series plotted on this pane (ChartPane.series) and settings of the Y-axis (ChartPane.primaryAxisY).

Use the ChartItem.panes property to access the collection of panes that constitute the ChartItem.

constructor(dataItemProvider)

Initializes a new instance of the ChartPane class.

Declaration

constructor(
    dataItemProvider: DataDashboardItem,
    dashboardItemJSON?: any,
    serializer?: ModelSerializer
)

Parameters

Name Type Description
dataItemProvider DataDashboardItem
dashboardItemJSON any

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

serializer ModelSerializer

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

Properties

createSeriesByViewType Property

Declaration

createSeriesByViewType: (seriesViewType: string) => ChartSeries

Property Value

Type
(seriesViewType: string) => ChartSeries

name Property

Specifies the name of the current pane.

Declaration

name: ko.Observable<string>

Property Value

Type Description
Observable<string>

A string that specifies the name of the current pane.

primaryAxisY Property

Gets the primary Y-axis displayed within the current pane.

Declaration

primaryAxisY: ChartAxisY

Property Value

Type Description
ChartAxisY

A ChartAxisY object that is the primary Y-axis displayed within the current pane.

Remarks

Use the primaryAxisY property to access settings of the primary Y-axis displayed within the current pane. These settings include the visibility of the axis, the axis title, etc.

secondaryAxisY Property

Gets the secondary Y-axis displayed within the current pane.

Declaration

secondaryAxisY: ChartSecondaryAxisY

Property Value

Type Description
ChartSecondaryAxisY

A ChartSecondaryAxisY object that is the secondary Y-axis displayed within the current pane.

Remarks

Use the secondaryAxisY property to access settings of the secondary Y-axis displayed within the current pane. These settings include the visibility of the axis, the axis title, etc.

series Property

Specifies the collection of series plotted in this pane.

Declaration

series: ko.ObservableArray<ChartSeries>

Property Value

Type Description
ObservableArray<ChartSeries>

A collection of ChartSeries descendants that represent series plotted in this pane.

Remarks

Use the series collection to introduce new series in the Chart dashboard item.

To do this, create instances of the appropriate ChartSeries descendants and add them to the series collection.

Methods

getInfo Method

For internal use.

Declaration

getInfo(): ISerializationInfoArray

Returns

Type Description
ISerializationInfoArray

An array of objects that provide serialization info.