All docs
V21.2
21.2
21.1
20.2
20.1
The page you are viewing does not exist in version 20.1. This link will take you to the root page.
19.2
The page you are viewing does not exist in version 19.2. This link will take you to the root page.
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

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 disable the current panel, call the unregisterExtension(extensionNames) method and pass the extension’s unique name as a parameter:

dashboardControl.unregisterExtension('itemFilterPanel');

Implements

constructor(dashboardControl)

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

Declaration

constructor(
    dashboardControl: 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