replaceInsightWidgetFilterSettings()
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Creates the ChangeInsightWidgetFilterSettings command for IFilterOpReplaceAll operation.
Dispatching this command will result in replacement of Insight widget’s filter settings; this includes change of data set used for common date filter, disabling common date filtering, ignoring attribute/date filters that are defined on the dashboard for the widget.
export declare function replaceInsightWidgetFilterSettings(ref: ObjRef, settings: Omit<IFilterOpReplaceAll, "type">, correlationId?: string): IChangeInsightWidgetFilterSettings;
Parameters
Parameter | Type | Description |
|---|---|---|
ref | reference of the insight 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