setDashboardDateFilterWithDimensionConfigMode()
Home > @gooddata/sdk-ui-dashboard > setDashboardDateFilterWithDimensionConfigMode
setDashboardDateFilterWithDimensionConfigMode() 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 ISetDashboardDateFilterWithDimensionConfigMode command.
Signature:
export declare function setDashboardDateFilterWithDimensionConfigMode(dataSet: ObjRef, mode?: DashboardDateFilterConfigMode): ISetDashboardDateFilterWithDimensionConfigMode;
Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
dataSet |
dataSet of the filter the mode is changed for | |
|
mode |
(Optional) newly added mode |
Returns:
ISetDashboardDateFilterWithDimensionConfigMode
change filter mode command
Remarks
Dispatching the commands will result into setting provided the mode as a mode for the date filter.