replaceKpiWidgetFilterSettings()
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
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.
export declare function replaceKpiWidgetFilterSettings(ref: ObjRef, settings: Omit<IFilterOpReplaceAll, "type">, correlationId?: string): IChangeKpiWidgetFilterSettings;
Parameters
Parameter | Type | Description |
|---|---|---|
ref | reference of the KPI widget to modify | |
settings | Omit<IFilterOpReplaceAll, “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