setDrillForKpiWidget()

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

setDrillForKpiWidget() function

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

Creates the SetDrillForKpiWidget command. Dispatching this command will result in KPI having its drill set to the given value.

Signature:

export declare function setDrillForKpiWidget(ref: ObjRef, legacyDashboardRef: ObjRef, legacyDashboardTabIdentifier: string, correlationId?: string): ISetDrillForKpiWidget;

Parameters

Parameter	Type	Description
ref	ObjRef	reference of the KPI widget to modify
legacyDashboardRef	ObjRef	ref of the legacy dashboard to drill to
legacyDashboardTabIdentifier	string	identifier of the legacy dashboard tab to drill to
correlationId	string	(Optional) specify correlation id to use for this command. this will be included in all events that will be emitted during the command processing

Returns:

ISetDrillForKpiWidget