ignoreFilterOnRichTextWidget()
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Creates the ChangeRichTextWidgetFilterSettings command for IFilterOpIgnoreAttributeFilter operation.
Dispatching this command will result in addition of one or more filters into Rich Text 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 metrics and will not be used to filter those metrics.
The operation is idempotent - trying to ignore an attribute filter multiple times will have no effect.
export declare function ignoreFilterOnRichTextWidget(ref: ObjRef, oneOrMoreDisplayForms: ObjRef | ObjRef[], correlationId?: string): IChangeRichTextWidgetFilterSettings;
Parameters
Parameter | Type | Description |
|---|---|---|
ref | reference of the rich text widget to modify | |
oneOrMoreDisplayForms | 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