DashboardParameterEditorExtension Class

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

Declaration

export class DashboardParameterEditorExtension implements IExtension

Remarks

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

To get access to the DashboardParameterEditorExtension settings, call the control’s findExtension(extensionName) method and pass the extension’s name as a parameter.

var ext = dashboardControl.findExtension('dashboardParameterEditor');

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

dashboardControl.unregisterExtension('dashboardParameterEditor');

You can also call the control’s option method to change the extension options.

Implements

IExtension

constructor(dashboardControl)

Initializes a new instance of the DashboardParameterEditorExtension class.

Declaration

constructor(
    dashboardControl: DevExpress.Dashboard.DashboardControl
)

Parameters

Name	Type	Description
dashboardControl	DashboardControl	A Web Dashboard control that owns the extension.

Properties

dashboard Property

Declaration

dashboard: ko.Computed<DevExpress.Dashboard.Model.Dashboard>

Property Value

Type
Computed<Dashboard>

name Property

Specifies the unique extension name.

Declaration

name: string

Property Value

Type	Description
string	The unique extension name. The return value is dashboardParameterEditor.

Remarks

Use the dashboardParameterEditor name in the following cases:

• Call the DashboardControl.findExtension method and pass the extension name as a parameter to access the extension.
• Call the control’s option method to change the extension options.

Warning

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

Methods

start Method

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

Declaration

start(): void

stop Method

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

Declaration

stop(): void