moveDateFilter()

Home > @gooddata/sdk-ui-dashboard > moveDateFilter

moveDateFilter() 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 MoveDateFilter command. Dispatching this command will result in move of the dashboard date filter with the provided dataSet to a new spot. The new spot is defined by index. For convenience the index of -1 means move to the end of the filter list.

Signature:

export declare function moveDateFilter(dataSet: ObjRef, index: number, correlationId?: string): IMoveDateFilter;

Parameters

Parameter

Type

Description

dataSet

ObjRef

dashboard filter's dataSet - no duplicates allowed

index

number

specify index among the draggable filters (attribute filters and date filters with dataSet) 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:

IMoveDateFilter

← MoveAttributeFilterPayloadMoveDateFilterPayload →