DashboardDrillResolved

Home > @gooddata/sdk-ui-dashboard > DashboardDrillResolved

DashboardDrillResolved interface

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

A general drill event that is emitted each time any dashboard drill is resolved. It contains only valid drillDefinitions for this particular drill interaction, so you can select and dispatch relevant more granular drill command(s).

This is general dashboard drill event with details about all possible more granular drill interactions that can follow. Reason for this general drill event is that it may happen that multiple drill interactions are possible for one drill event.

Example: some attribute on the insight has drill down set and also widget has drill to insight set. Then this event will be dispatched with both and definitions.

• This must be always the first event that occurs after the drill interaction, and must be dispatched before more granular drill events. - Specific drill commands that can follow this general drill event are: DrillDown, DrillToInsight, DrillToDashboard, DrillToCustomUrl, DrillToAttributeUrl, DrillToLegacyDashboard

Signature:

export interface DashboardDrillResolved extends IDashboardEvent 

Extends: IDashboardEvent

Properties

Property	Modifiers	Type	Description
payload	readonly	DashboardDrillResolvedPayload	(ALPHA)
type	readonly	"GDC.DASH/EVT.DRILL.RESOLVED"	(ALPHA)