ItemMasterFilterStateChangedEventArgs Interface

Provides information for the ItemMasterFilterStateChanged event.

Declaration

export interface ItemMasterFilterStateChangedEventArgs extends DashboardItemBaseEventArgs

Remarks

Use the onItemMasterFilterStateChanged handler to raise the ItemMasterFilterStateChanged event.

The ViewerApiExtensionOptions.onItemMasterFilterStateChanged event occurs when filtering is applied or the state of the master filter item changes. Its e.values property allows you to obtain the selected values for the dashboard item that causes the event.

For instance, for the dashboard in the image below, the e.values property returns the following objects for the Grid dashboard item:

[['UK', 'Anne Dodsworth'], ['USA', 'Andrew Fuller']]

For the Range Filter dashboard item, the e.values property returns the Date objects for minimum and maximum values in the selected range. The minimum is Sun Feb 01 2015 and the maximum is Sun Jan 31 2016.

The ViewerApiExtensionOptions.onItemActionAvailabilityChanged event occurs after the available interactivity actions are changed for the specific dashboard item.

Inherited Members

dashboardItem

itemName

Inheritance

DashboardItemBaseEventArgs

ItemMasterFilterStateChangedEventArgs

Properties

values Property

Gets the currently selected values.

Declaration

values: Array<Array<DevExpress.Dashboard.Data.PrimitiveType>>

Property Value

Type
PrimitiveType[][]