enableKpiWidgetDateFilter()
Home > @gooddata/sdk-ui-dashboard > enableKpiWidgetDateFilter
enableKpiWidgetDateFilter() function
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Creates the ChangeKpiWidgetFilterSettings command for FilterOpEnableDateFilter operation.
Dispatching this command will result in change of KPI widget's date filter setting. The date filtering will be enabled and the provided date data set will be used for date-filtering widget's KPI.
Signature:
export declare function enableKpiWidgetDateFilter(ref: ObjRef, dateDataset: ObjRef | "default", correlationId?: string): ChangeKpiWidgetFilterSettings;
Parameters
| Parameter | Type | Description |
|---|---|---|
| ref | ObjRef | reference of the KPI widget to modify |
| dateDataset | ObjRef | "default" | date data set to use for filtering the insight, if "default" is provided, the default date dataset will be resolved and used |
| 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: