removeDateFilter()
Home > @gooddata/sdk-ui-dashboard > removeDateFilter
removeDateFilter() 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 RemoveDateFilters command. Dispatching this command will result in the removal of dashboard's date filter with the provided date data set.
Signature:
export declare function removeDateFilter(dataSet: ObjRef, correlationId?: string): RemoveDateFilters;
Parameters
Parameter | Type | Description |
---|---|---|
dataSet | ObjRef | dashboard date filter's date data set ref |
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: