ItemClickEventArgs Interface

Provides data for the ItemClick event.

Declaration

export interface ItemClickEventArgs extends DashboardItemBaseEventArgs

Remarks

Use the onItemClick handler to raise the ItemClick event.

Inherited Members

dashboardItem

itemName

Inheritance

DashboardItemBaseEventArgs

ItemClickEventArgs

Properties

getAxisPoint Property

Returns the axis point corresponding to the clicked visual element.

Declaration

getAxisPoint: (axis?: ItemDataAxisName) => ItemDataAxisPoint

Property Value

Type
(axis?: ItemDataAxisName) => ItemDataAxisPoint

getData Property

Gets the dashboard item’s client data.

Declaration

getData: () => ItemData

Property Value

Type
() => ItemData

getDeltas Property

Gets deltas corresponding to the clicked visual element.

Declaration

getDeltas: () => Array<ItemDataDelta>

Property Value

Type
() => Array<ItemDataDelta>

getDimensions Property

Gets the dimensions used to create a hierarchy of axis points for the specified axis.

Declaration

getDimensions: () => Array<ItemDataDimension>

Property Value

Type
() => Array<ItemDataDimension>

getMeasures Property

Gets measures corresponding to the clicked visual element.

Declaration

getMeasures: () => Array<ItemDataMeasure>

Property Value

Type
() => Array<ItemDataMeasure>

requestUnderlyingData Property

Gets underlying data corresponding to the clicked visual element.

Declaration

requestUnderlyingData: (onCompleted: (data: ItemUnderlyingData) => void, dataMembers: string[]) => void

Property Value

Type	Description
(onCompleted: (data: ItemUnderlyingData) => void, dataMembers: string[]) => void	A function that is executed when the server sends a response.

Remarks

The data parameter returns the ItemUnderlyingData object that contains a list of records from the dashboard data source.

The dataMembers parameter is optional. Add an array of string values to specify data members used to obtain underlying data. If you do not specify this parameter, underlying data are requested for all available data members.

Note that the requestUnderlyingData property does not return data for calculated fields that contain the aggr function.