drillToInsight()
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Creates the IDrillToInsight command. Dispatching this command will result into applying the drill intersection filters to the target insight and dispatching IDashboardDrillToInsightResolved event that will contain it.
In the default dashboard implementation this command will also result into opening the drill dialog with the target insight that has the drill intersection filters applied.
export declare function drillToInsight(drillDefinition: IDrillToInsightModel, drillEvent: IDashboardDrillEvent, correlationId?: string): IDrillToInsight;
Parameters
Parameter | Type | Description |
|---|---|---|
drillDefinition | drill definition with the target insight. | |
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 insight command