drillToLegacyDashboard()

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

drillToLegacyDashboard() function

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.

Creates the IDrillToLegacyDashboard command. Dispatching this command will result into dispatching IDashboardDrillToLegacyDashboardResolved event.

Drill to legacy dashboard can be configured for Kpi widgets only.

Signature:

export declare function drillToLegacyDashboard(drillDefinition: IDrillToLegacyDashboardModel, drillEvent: IDashboardDrillEvent, correlationId?: string): IDrillToLegacyDashboard;

Parameters

Parameter	Type	Description
drillDefinition	IDrillToLegacyDashboardModel	drill definition with the target dashboard.
drillEvent	IDashboardDrillEvent	original drill event, that triggered this particular drill interaction.
correlationId	string	(Optional) specify correlation id. It will be included in all events that will be emitted during the command processing.

Returns:

IDrillToLegacyDashboard

drill to legacy dashboard command