ignoreFilterOnInsightWidget()
Home > @gooddata/sdk-ui-dashboard > ignoreFilterOnInsightWidget
ignoreFilterOnInsightWidget() function
Creates the ChangeInsightWidgetFilterSettings command for FilterOpIgnoreAttributeFilter operation.
Dispatching this command will result in addition of one or more filters into Insight 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 insight and will not be used to filter that insight.
The operation is idempotent - trying to ignore an attribute filter multiple times will have no effect.
Signature:
export declare function ignoreFilterOnInsightWidget(ref: ObjRef, oneOrMoreDisplayForms: ObjRef | ObjRef[], correlationId?: string): ChangeInsightWidgetFilterSettings;
Parameters
| Parameter | Type | Description |
|---|---|---|
| ref | ObjRef | reference of the insight 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: