moveAttributeFilter()
Home > @gooddata/sdk-ui-dashboard > moveAttributeFilter
moveAttributeFilter() function
This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Creates the MoveAttributeFilter command. Dispatching this command will result in move of the dashboard attribute filter with the provided local id to a new spot. The new spot is defined by index. For convenience the index of -1 means move to the end of the attribute filter list.
Signature:
export declare function moveAttributeFilter(filterLocalId: string, index: number, correlationId?: string): IMoveAttributeFilter;
Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
filterLocalId |
string |
dashboard filter's local identifier |
|
index |
number |
specify index among the attribute filters at which the new filter should be placed. The index starts at zero and there is convenience that index of -1 would add the filter at the end. |
|
correlationId |
string |
(Optional) specify correlation id to use for this command. this will be included in all events that will be emitted during the command processing |
Returns: