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 remove this item from the menu, call the unregisterExtension(extensionNames) method and pass the extension’s unique name as a parameter:

dashboardControl.unregisterExtension('dashboardParameterEditor');

Implements

IExtension

constructor(dashboardControl)

Initializes a new instance of the DashboardParameterEditorExtension class.

Declaration

constructor(
    dashboardControl: DashboardControl
)

Parameters

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

Properties

dashboard Property

Declaration

dashboard: ko.Computed<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 your applications so you can change the extension options when calling the control’s option method. Before v20.2 the extension name was dashboard-parameter-editor. You can use the old name only in the DashboardControl.findExtension method.

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