applyDateFilter()
Home > @gooddata/sdk-ui-dashboard > applyDateFilter
applyDateFilter() function
Creates the ChangeDateFilterSelection command.
Signature:
export declare function applyDateFilter(filter: IDateFilter, correlationId?: string): ChangeDateFilterSelection;
Parameters
| Parameter | Type | Description |
|---|---|---|
| filter | IDateFilter | date filter to apply |
| 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:
Remarks
Dispatching this command will result in change of dashboard's date filter, or error in case of invalid update (e.g. hidden date filter option by dateFilterConfig).
All parameters for ChangeDateFilterSelection command is derived from the provided date filter.
See ChangeDateFilterSelection for a more complete description of the different parameters