setDrillForKpiWidget()
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Creates the SetDrillForKpiWidget command. Dispatching this command will result in KPI having its drill set to the given value.
export declare function setDrillForKpiWidget(ref: ObjRef, legacyDashboardRef: ObjRef, legacyDashboardTabIdentifier: string, correlationId?: string): ISetDrillForKpiWidget;
Parameters
Parameter | Type | Description |
|---|---|---|
ref | reference of the KPI widget to modify | |
legacyDashboardRef | 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