unignoreFilterOnKpiWidget()
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Creates the ChangeKpiWidgetFilterSettings command for IFilterOpUnignoreAttributeFilter operation.
Dispatching this command will result in removal of one or more filters from KPI widget’s attribute filter ignore-list. Ignored attribute filters are not passed down to the KPI and will not be used to filter that KPI.
The operation is idempotent - trying to unignore an attribute filter multiple times will have no effect.
export declare function unignoreFilterOnKpiWidget(ref: ObjRef, oneOrMoreDisplayForms: ObjRef | ObjRef[], correlationId?: string): IChangeKpiWidgetFilterSettings;
Parameters
Parameter | Type | Description |
|---|---|---|
ref | reference of the KPI widget to modify | |
oneOrMoreDisplayForms | one or more refs of display forms used by attribute filters that should be removed from the ignore-list | |
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