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('dashboard-title-editor');

Inheritance

DisposableObject
DashboardTitleEditorExtension

Implements

Inherited Members

constructor(dashboardControl)

Initializes a new instance of the DashboardTitleEditorExtension class.

Declaration

constructor(dashboardControl: DashboardControl)

Parameters

Type Name Description
DashboardControl dashboardControl

A Web Dashboard control that owns the extension.

Properties

name Property

Specifies a unique extension name.

Declaration

name: string

Property Value

Type Description
string

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

Remarks

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

stop Method

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

Declaration

stop(): void