drillToDashboard()
Home > @gooddata/sdk-ui-dashboard > drillToDashboard
drillToDashboard() function
This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Creates the IDrillToDashboard command. Dispatching this command will result into getting the drill intersection filters that can be applied to the target dashboard and dispatching IDashboardDrillToDashboardResolved event that will contain them.
Signature:
export declare function drillToDashboard(drillDefinition: IDrillToDashboardModel, drillEvent: IDashboardDrillEvent, correlationId?: string): IDrillToDashboard;
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 dashboard command