DashboardParameterEditorExtension Class

A Web Dashboard extension that allows you to create and edit dashboard parameters.

Declaration

export class DashboardParameterEditorExtension implements IExtension

Impemented Interfaces

When registered, the DashboardParameterEditorExtension adds the "Parameters" item to the dashboard menu.

To remove this item from the menu, call the unregisterExtension method and pass the extension's unique name as a parameter:

dashboardControl.unregisterExtension('dashboard-parameter-editor');

Constructor

Initializes a new instance of the DashboardParameterEditorExtension class.

Declaration

constructor(dashboardControl: DashboardControl)

Parameters

Type Name Description
DashboardControl dashboardControl

A Web Dashboard control that owns the extension.

Properties

dashboard property

Declaration

dashboard: KnockoutObservable<Dashboard>

Property Value

Type Description
KnockoutObservable<js-DevExpress.Dashboard.Model.Dashboard>

name property

Specifies a unique extension name.

Declaration

name: string

Property Value

Type Description
string

A unique extension name. The return value is 'dashboard-parameter-editor'.

Implementation of

Warning

Do not change a unique name of the extension registered in the Web Dashboard in order to avoid exceptions.

Methods

start method

Contains code that is executed when you register the dashboard extension.

Declaration

start(): void

Implementation of

stop method

Contains code that is executed when you unregister the dashboard extension.

Declaration

stop(): void

Implementation of