disableKpiWidgetDateFilter()
Home > @gooddata/sdk-ui-dashboard > disableKpiWidgetDateFilter
disableKpiWidgetDateFilter() 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 FilterOpDisableDateFilter operation.
Dispatching this command will result in change of KPI widget's date filter setting. The date filtering will be disabled.
Signature:
export declare function disableKpiWidgetDateFilter(ref: ObjRef, correlationId?: string): ChangeKpiWidgetFilterSettings;
Parameters
| Parameter | Type | Description |
|---|---|---|
| ref | ObjRef | reference of the KPI widget to modify |
| 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: