drillDown()
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Creates the IDrillDown command. Dispatching this command will result into applying drill down definition to the provided insight (result of the drill down application depends on the particular visualization type) and dispatching IDashboardDrillDownResolved event that will contain it.
In the default dashboard implementation dispatching this command will also result into opening drill dialog with the insight that has this particular drill down definition applied.
export declare function drillDown(insight: IInsight, drillDefinition: IDrillDownDefinition, drillEvent: IDashboardDrillEvent, correlationId?: string): IDrillDown;
Parameters
Parameter | Type | Description |
|---|---|---|
insight | insight to which the drill down should be applied. | |
drillDefinition | drill definition to apply. | |
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 down command