BindingPanelExtension Class

An extension that is the dashboard item’s Binding menu allowing you to create and modify data binding.

Declaration

export class BindingPanelExtension implements ISupportOptionExtension<BindingPanelExtensionOptions>

Remarks

When registered, the BindingPanelExtension adds the Binding 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('itemBindingPanel');

constructor(dashboardControl)

Initializes a new instance of the BindingPanelExtension class.

Declaration

constructor(
    dashboardControl: DashboardControl,
    options?: BindingPanelExtensionOptions
)

Parameters

Name	Type	Description
dashboardControl	DashboardControl	A Web Dashboard control that owns the extension.
options	BindingPanelExtensionOptions

Properties

name Property

Specifies the unique extension name.

Declaration

name: string

Property Value

Type	Description
string	The unique extension name. The return value is itemBindingPanel.

Remarks

Use the itemBindingPanel name in your applications so you can change the extension options when calling the control’s option method. Before v20.2 the extension name was item-binding-panel. You can use the old name only in the DashboardControl.findExtension method.

Warning

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

off Property

Unsubscribes from the BindingPanelExtension’s events.

Declaration

off: EventSubscriber<BindingPanelExtensionEvents>

Property Value

Type	Description
EventSubscriber<BindingPanelExtensionEvents>	An event subscription.

on Property

Subscribes to the BindingPanelExtension’s events.

Declaration

on: EventSubscriber<BindingPanelExtensionEvents>

Property Value

Type	Description
EventSubscriber<BindingPanelExtensionEvents>	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