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, options?: OptionsPanelExtensionOptions)

Parameters

Name Type Description
dashboardControl DashboardControl

A Web Dashboard control that owns the extension.

options OptionsPanelExtensionOptions

Properties

name Property

Specifies The unique extension name.

Declaration

name: string

Property Value

Type Description
string

The unique extension name. The return value is 'item-options-panel'.

Remarks

WARNING

Do not change the unique name of the extension registered in the Web Dashboard to avoid exceptions.

off Property

Unsubscribes from the OptionsPanelExtension's events.

Declaration

off: EventSubscriber<OptionsPanelExtensionEvents>

Property Value

Type Description
EventSubscriber<OptionsPanelExtensionEvents>

An event subscription.

on Property

Subscribes to the OptionsPanelExtension's events.

Declaration

on: EventSubscriber<OptionsPanelExtensionEvents>

Property Value

Type Description
EventSubscriber<OptionsPanelExtensionEvents>

An event subscription.

Remarks

The extension's on and off methods help you subscribe to and unsubscribe from events.

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