The requested page is not available for the requested platform. You are viewing the content for Default platform.

ItemDrillDownStateChangedEventArgs Interface

Provides data for the ItemDrillDownState event.

Declaration

export interface ItemDrillDownStateChangedEventArgs

Remarks

The ItemDrillDownStateChanged event is raised when an end-user performs drill-down or drill-up in a certain dashboard item. Use the ViewerApiExtensionOptions.onItemDrillDownStateChanged handler to raise the ItemDrillDownState event. To determine the component name of the dashboard item, use the ItemName event parameter. Other event parameters include the following:

WebDashboardDrillDownScheme

Properties

action Property

Gets the drill-down action performed in the dashboard item.

Declaration

action: "Down" | "Up"

Property Value

Type Description
"Down"

Identifies a drill-down.

"Up"

Identifies a drill-up.

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.

values Property

Gets values from the current drill-down hierarchy.

Declaration

values: Array<PrimitiveType>

Property Value

Type Description
Array<PrimitiveType>

An array of drill-down values.

Remarks

In OLAP mode, the values property returns unique names instead of values.