Skip to main content

InteractivityPanelExtension Class

An extension that is the dashboard item’s Interactivity menu containing settings that affect on interaction between various dashboard items.

#Declaration

TypeScript
export class InteractivityPanelExtension implements IExtension

#Remarks

When registered, the InteractivityPanelExtension adds the Interactivity panel to the dashboard item’s menu.

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

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

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

JavaScript
dashboardControl.unregisterExtension('itemInteractivityPanel');

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

#Implements

IExtension

#constructor(dashboardControl)

Initializes a new instance of the InteractivityPanelExtension class.

#Declaration

TypeScript
constructor(
    dashboardControl: DevExpress.Dashboard.DashboardControl
)

#Parameters

Name Type Description
dashboardControl DashboardControl

A Web Dashboard control that owns the extension.

#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 itemInteractivityPanel.

#Remarks

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