Skip to main content
A newer version of this page is available. .

ItemSelectionChangedEventArgs Interface

Provides data for the ItemSelectionChanged event.

Declaration

export interface ItemSelectionChangedEventArgs

Remarks

Use the onItemSelectionChanged handler to raise the ItemSelectionChanged event.

The ItemSelectionChanged event is raised after the selection within the dashboard item is changed. The selection can be changed in the following ways:

  • the state of master filter item is changed by an end-user or using the Web Dashboard’s API;
  • changing the selection within the dashboard item for which a custom visual interactivity is provided (using the ItemVisualInteractivity event).

Properties

getCurrentSelection Property

Gets currently selected elements.

Declaration

getCurrentSelection: () => Array<ItemDataAxisPointTuple>

Property Value

Type
() => Array<ItemDataAxisPointTuple>

itemName Property

Gets the component name of the dashboard item for which the event was raised.

Declaration

itemName: string

Property Value

Type Description
string

A string value that is the component name of the dashboard item.