changeDrillableItems()
Home > @gooddata/sdk-ui-dashboard > changeDrillableItems
changeDrillableItems() 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 IChangeDrillableItems command. Dispatching this command will result into enabling drilling of the widgets, if they match some of the drillable item definition/predicate.
Signature:
export declare function changeDrillableItems(drillableItems: ExplicitDrill[], correlationId?: string): IChangeDrillableItems;
Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
drillableItems |
reference to the drillable items or predicates that enables insight/kpi drilling. | |
|
correlationId |
string |
(Optional) specify correlation id. It will be included in all events that will be emitted during the command processing. |
Returns:
change drillable items command