replaceKpiWidgetFilterSettings()
Home > @gooddata/sdk-ui-dashboard > replaceKpiWidgetFilterSettings
replaceKpiWidgetFilterSettings() 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. Dispatching this command will result in change of KPI widget's filter settings; this includes change of data set used for date filter, disabling date filtering, ignoring attribute filters that are defined on the dashboard for the widget.
Signature:
export declare function replaceKpiWidgetFilterSettings(ref: ObjRef, settings: Omit<FilterOpReplaceAll, "type">, correlationId?: string): ChangeKpiWidgetFilterSettings;
Parameters
| Parameter | Type | Description |
|---|---|---|
| ref | ObjRef | reference of the KPI widget to modify |
| settings | Omit<FilterOpReplaceAll, "type"> | new filter settings 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: