addDateFilter()

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

addDateFilter() 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 AddDateFilter command. Dispatching this command will result in the addition of another date filter with defined dimension to the dashboard's filter bar, at desired position, or error in case of invalid update (e.g. wrong or duplicated date dimension/data set)

The filter will be set for the date dimension provided by reference. When created, the filter will be no-op - all time filter.

Signature:

export declare function addDateFilter(dateDataset: ObjRef, index: number, correlationId?: string): IAddDateFilter;

Parameters

Parameter

Type

Description

dateDataset

ObjRef

specify date dimension/data set which will be used for filtering of all widgets

index

number

specify index among the 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

Returns:

IAddDateFilter

← AddAttributeFilterPayloadaddDrillDownForInsightWidget() →