ChartIndicatorsExtension Class

An extension that adds custom indicator types to the Trend Indicators dialog.

Declaration

export class ChartIndicatorsExtension implements IExtension

Remarks

When registered, ChartIndicatorsExtension adds the registered custom indicator type to the Trend Indicators dialog.

The following code snippet adds the MovingIndicator type to the Trend Indicators editor:

function onBeforeRender(dashboardControl) {
    // ...
    dashboardControl.registerExtension(new DevExpress.Dashboard.Designer.ChartIndicatorsExtension(dashboardControl, {
        customIndicatorTypes: [ {
                type: 'MovingIndicator',
                displayName: 'Moving Average'
            }
        ]
    }));
}

Refer to the following help topic for more information on how to create a custom indicator: Trend Indicators.

Implements

IExtension

constructor(dashboardControl, options)

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

Declaration

constructor(
    dashboardControl: DevExpress.Dashboard.DashboardControl,
    options: ChartIndicatorsExtensionOptions
)

Parameters

Name	Type	Description
dashboardControl	DashboardControl	A Web Dashboard control that owns the extension.
options	ChartIndicatorsExtensionOptions	A ChartIndicatorsExtensionOptions object that contains the indicator type settings.

Properties

customChartIndicators Property

Gets the custom indicator type.

Declaration

get customChartIndicators(): {
    type: string;
    displayName: string;
}[]

Property Value

Type	Description
{displayName: string, type: string}[]	An array of settings that identifies the indicator type.

name Property

Specifies the extension’s unique name.

Declaration

name: string

Property Value

Type	Description
string	The extension’s unique name.