The requested page is not available for the requested platform. You are viewing the content for Default platform.

OptionsPanelExtension Class

An extension that is the dashboard item's Options menu containing specific options and settings related to the current dashboard item.

Declaration

export class OptionsPanelExtension implements IExtension

Remarks

When registered, the OptionsPanelExtension adds the Options panel to the dashboard item's menu.

To disable the current panel, call the unregisterExtension(extensionNames) method and pass the extension's unique name as a parameter:

dashboardControl.unregisterExtension('item-options-panel');

Implements

constructor(dashboardControl)

Initializes a new instance of the OptionsPanelExtension class.

Declaration

constructor(dashboardControl: DashboardControl)

Parameters

Name Type 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 'item-options-panel'.

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