DashboardTitleEditorExtension Class

An extension that is the Web Dashboard title editor.

Declaration

export class DashboardTitleEditorExtension extends DisposableObject implements IExtension

Remarks

When registered, the DashboardTitleEditorExtension adds the “Title” 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('dashboardTitleEditor');

Implements

Inheritance

DisposableObject
DashboardTitleEditorExtension

constructor(dashboardControl)

Initializes a new instance of the DashboardTitleEditorExtension class.

Declaration

constructor(
    dashboardControl: DashboardControl
)

Parameters

Name Type Description
dashboardControl DashboardControl

A Web Dashboard control that owns the extension.

Properties

name Property

Specifies the unique extension name.

Declaration

name: string

Property Value

Type Description
string

The unique extension name. The return value is dashboardTitleEditor.

Remarks

Use the dashboardTitleEditor 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-title-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

dispose Method

Releases resources associated with a DashboardTitleEditorExtension instance.

Declaration

dispose(): void

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