replaceKpiWidgetIgnoredFilters()
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Creates the ChangeKpiWidgetFilterSettings command for IFilterOpReplaceAttributeIgnores operation.
Dispatching this command will result in replacement of KPI widget’s attribute filter ignore-list. Those attribute filters that use the provided displayForms for filtering will be ignored by the widget.
export declare function replaceKpiWidgetIgnoredFilters(ref: ObjRef, displayForms?: ObjRef[], correlationId?: string): IChangeKpiWidgetFilterSettings;
Parameters
Parameter | Type | Description |
|---|---|---|
ref | reference of the KPI widget to modify | |
displayForms | ObjRef[] | (Optional) refs of display forms used by attribute filters that should be ignored |
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