ignoreFilterOnKpiWidget()
Home > @gooddata/sdk-ui-dashboard > ignoreFilterOnKpiWidget
ignoreFilterOnKpiWidget() function
This API is provided as a beta 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 for FilterOpIgnoreAttributeFilter operation.
Dispatching this command will result in addition of one or more filters into KPI widget's attribute filter ignore-list. Those attribute filters that use the provided displayForms for filtering will be ignored by the widget on top of any other filters that are already ignored.
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 ignore an attribute filter multiple times will have no effect.
Signature:
export declare function ignoreFilterOnKpiWidget(ref: ObjRef, oneOrMoreDisplayForms: ObjRef | ObjRef[], correlationId?: string): ChangeKpiWidgetFilterSettings;
Parameters
| Parameter | Type | Description |
|---|---|---|
| ref | ObjRef | reference of the KPI widget to modify |
| oneOrMoreDisplayForms | ObjRef | ObjRef[] | one or more refs of display forms used by attribute filters that should be added to 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: