drillToLegacyDashboard()
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Creates the IDrillToLegacyDashboard command. Dispatching this command will result into dispatching IDashboardDrillToLegacyDashboardResolved event.
Drill to legacy dashboard can be configured for Kpi widgets only.
export declare function drillToLegacyDashboard(drillDefinition: IDrillToLegacyDashboardModel, drillEvent: IDashboardDrillEvent, correlationId?: string): IDrillToLegacyDashboard;
Parameters
Parameter | Type | Description |
|---|---|---|
drillDefinition | drill definition with the target dashboard. | |
drillEvent | 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
drill to legacy dashboard command