replaceInsightWidgetIgnoredFilters()
Home > @gooddata/sdk-ui-dashboard > replaceInsightWidgetIgnoredFilters
replaceInsightWidgetIgnoredFilters() 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 ChangeInsightWidgetFilterSettings command for FilterOpReplaceAttributeIgnores operation.
Dispatching this command will result in replacement of Insight widget's attribute filter ignore-list. Those attribute filters that use the provided displayForms for filtering will be ignored by the widget.
Signature:
export declare function replaceInsightWidgetIgnoredFilters(ref: ObjRef, displayForms?: ObjRef[], correlationId?: string): ChangeInsightWidgetFilterSettings;
Parameters
| Parameter | Type | Description |
|---|---|---|
| ref | ObjRef | reference of the insight 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: