DashboardColorSchemeEditorExtension Class

A Web Dashboard extension that allows you to configure color schemes.

Declaration

class DashboardColorSchemeEditorExtension implements IExtension

When registered, the DashboardColorSchemeEditorExtension adds the "ColorScheme" 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-color-scheme-editor');

Implements

Constructors

Constructor

Initializes a new instance of the DashboardColorSchemeEditorExtension class.

Declaration

constructor(dashboardControl: DashboardControl)

Parameters

Type Name Description
DashboardControl dashboardControl

A Web Dashboard control that owns the extension.

This extension is a part of the Web Dashboard and is not intended to be used directly from your code.

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-color-scheme-editor'.

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