unignoreFilterOnRichTextWidget()
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 IFilterOpUnignoreAttributeFilter operation.
Dispatching this command will result in removal of one or more filters from Rich Text widget’s attribute filter ignore-list. 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 unignore an attribute filter multiple times will have no effect.
export declare function unignoreFilterOnRichTextWidget(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 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