Skip to main content

DashboardColorSchemeEditorExtension Class

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

#Declaration

TypeScript
export class DashboardColorSchemeEditorExtension implements IExtension

#Remarks

When registered, the DashboardColorSchemeEditorExtension adds the “ColorScheme” item to the dashboard menu.

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

JavaScript
var ext = dashboardControl.findExtension('dashboardColorSchemeEditor');

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

JavaScript
dashboardControl.unregisterExtension('dashboardColorSchemeEditor');

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

#Implements

IExtension

#constructor(dashboardControl)

Initializes a new instance of the DashboardColorSchemeEditorExtension class.

#Declaration

TypeScript
constructor(
    dashboardControl: DevExpress.Dashboard.DashboardControl
)

#Parameters

Name Type Description
dashboardControl DashboardControl

A Web Dashboard control that owns the extension.

#Remarks

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

#Properties

#name Property

Specifies the unique extension name.

#Declaration

TypeScript
name: string

#Property Value

Type Description
string

The unique extension name. The return value is dashboardColorSchemeEditor.

#Remarks

Use the dashboardColorSchemeEditor 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

TypeScript
start(): void

#stop Method

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

#Declaration

TypeScript
stop(): void