ItemVisualInteractivityEventArgs Interface

Provides information for the ItemVisualInteractivity event.

Declaration

export interface ItemVisualInteractivityEventArgs extends DashboardItemBaseEventArgs

Remarks

Use the onItemVisualInteractivity handler to raise the ItemVisualInteractivity event.

The ItemVisualInteractivity event allows you to provide custom visual interactivity for data-bound dashboard items that support element selection and highlighting. This event is raised for dashboard items with disabled master filtering. Visual interactivity is enabled for master filter items by default. The Web Dashboard also fires this event when master filtering is applied to the current dashboard item or drill-down is performed in this dashboard item.

After the selection is changed, the ItemSelectionChanged event is raised. You can use the onItemSelectionChanged handler to raise this event.

The following table lists possible target axes for each dashboard item and supported interactivity capabilities.

Dashboard Item	Target Axes	Selection	Highlighting
GridDashboardItem	DefaultAxis	yes	no
ChartDashboardItem	ChartArgumentAxis	yes	yes
ChartDashboardItem	ChartSeriesAxis	yes	yes
ScatterChartDashboardItem	ChartArgumentAxis	yes	yes
PieDashboardItem	ChartArgumentAxis	yes	yes
PieDashboardItem	ChartSeriesAxis	yes	yes
CardDashboardItem	DefaultAxis	yes	yes
GaugeDashboardItem	DefaultAxis	yes	yes
MapDashboardItem	DefaultAxis	yes	yes
TreemapDashboardItem	DefaultAxis	yes	yes

Note

The Grid dashboard item does not support custom interactivity when Cell Merging is enabled.

Inherited Members

dashboardItem

itemName

Inheritance

DashboardItemBaseEventArgs

ItemVisualInteractivityEventArgs

Properties

enableHighlighting Property

Specifies whether to enable highlighting for the current dashboard item.

Declaration

enableHighlighting: (value: boolean) => void

Property Value

Type	Description
(value: boolean) => void	true, to enable highlighting; otherwise, false.

getSelectionMode Property

Gets the selection mode for dashboard item elements.

Declaration

getSelectionMode: () => DashboardSelectionMode

Property Value

Type	Description
() => DashboardSelectionMode	A DashboardSelectionMode value that specifies the selection mode.

Remarks

Use the ItemVisualInteractivityEventArgs.setSelectionMode property to set the selection mode.

getTargetAxes Property

Gets data axes used to perform custom interactivity actions.

Declaration

getTargetAxes: () => ItemDataAxisName[]

Property Value

Type	Description
() => ItemDataAxisName[]	An array of strings that are the names of data axes.

isHighlightingEnabled Property

Gets a value that specifies whether highlighting is enabled for the current dashboard item.

Declaration

isHighlightingEnabled: () => boolean

Property Value

Type	Description
() => boolean	true, if highlighting is enabled; otherwise, false.

setSelectionMode Property

Sets the selection mode for dashboard item elements.

Declaration

setSelectionMode: (value: DashboardSelectionMode) => void

Property Value

Type	Description
(value: DashboardSelectionMode) => void	A DashboardSelectionMode value that specifies the selection mode.

Remarks

Use the ItemVisualInteractivityEventArgs.getSelectionMode property to get the selection mode.

setTargetAxes Property

Sets data axes used to perform custom interactivity actions.

Declaration

setTargetAxes: (value?: ItemDataAxisName[]) => void

Property Value

Type
(value?: ItemDataAxisName[]) => void

Methods

getDefaultSelection Method

Gets the default selection for the current dashboard item.

Declaration

getDefaultSelection(): Array<ItemDataAxisPointTuple>

Returns

Type
Array<ItemDataAxisPointTuple>

setDefaultSelection(selection) Method

Sets the default selection for the current dashboard item.

Declaration

setDefaultSelection(
    selection: Array<ItemDataAxisPointTuple>
): void

Parameters

Name	Type
selection	Array<ItemDataAxisPointTuple>