Back to Devexpress

ChartContext Class

dashboard-js-devexpress-dot-dashboard-3caa949f.md

latest1.7 KB
Original Source

ChartContext Class

Provides a connection between data item containers from the Values section and series from an underlying control.

Declaration

ts
export class ChartContext

Remarks

The following code snippet shows how to use ChartContext to get a Chart item’s series:

javascript
var Model = DevExpress.Dashboard.Model;

function onItemWidgetOptionsPrepared(args) {
    if(args.dashboardItem instanceof Model.ChartItem) {
        var chartOptions = args.options;
        if(chartOptions.series) {
            chartOptions.series.forEach(function(seriesOptions) {
                var dashboardSeries = args.chartContext.getDashboardItemSeries(seriesOptions)
                if(dashboardSeries && dashboardSeries.plotOnSecondaryAxis()) {
                    seriesOptions.dashStyle = 'longDash';
                }
            })
        }
    }
}

constructor(_dashboardItem)

Initializes a new instance of the ChartContext class with specified settings.

Declaration

ts
constructor(
    _dashboardItem: DevExpress.Dashboard.Model.ChartItem
)

Parameters

NameType
_dashboardItemChartItem

Methods

getDashboardItemSeries(seriesOptions) Method

Declaration

ts
getDashboardItemSeries(
    seriesOptions: DevExpress.viz.ChartSeries
): DevExpress.Dashboard.Model.ChartSeries

Parameters

NameType
seriesOptionsChartSeries

Returns

Type
ChartSeries