Skip to main content

BindingPanelExtension Class

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

#Declaration

TypeScript
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:

JavaScript
dashboardControl.unregisterExtension('itemBindingPanel');

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

#Implements

ISupportOptionExtension

#constructor(dashboardControl)

Initializes a new instance of the BindingPanelExtension class.

#Declaration

TypeScript
constructor(
    dashboardControl: DevExpress.Dashboard.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

TypeScript
name: string

#Property Value

Type Description
string

The unique extension name. The return value is itemBindingPanel.

#Remarks

Use the itemBindingPanel 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.

#off Property

Unsubscribes from the BindingPanelExtension’s events.

#Declaration

TypeScript
off: DevExpress.Dashboard.Internal.EventSubscriber<BindingPanelExtensionEvents>

#Property Value

Type Description
EventSubscriber<BindingPanelExtensionEvents>

An event subscription.

#on Property

Subscribes to BindingPanelExtension events.

#Declaration

TypeScript
on: DevExpress.Dashboard.Internal.EventSubscriber<BindingPanelExtensionEvents>

#Property Value

Type
EventSubscriber<BindingPanelExtensionEvents>

#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

TypeScript
start(): void

#stop Method

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

#Declaration

TypeScript
stop(): void