FilterPanelExtension Class

An extension that is the dashboard item’s Filters menu allowing you to apply filters on a dashboard item.

Declaration

export class FilterPanelExtension implements IExtension

Remarks

When registered, the FilterPanelExtension adds the Filters panel to the dashboard item’s menu.

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

var ext = dashboardControl.findExtension('itemFilterPanel');

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

dashboardControl.unregisterExtension('itemFilterPanel');

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

Implements

IExtension

constructor(dashboardControl)

Initializes a new instance of the FilterPanelExtension class with specified settings.

Declaration

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

name: string

Property Value

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

Remarks

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

start(): void

stop Method

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

Declaration

stop(): void