ignoreDateFilterOnRichTextWidget()
Home > @gooddata/sdk-ui-dashboard > ignoreDateFilterOnRichTextWidget
ignoreDateFilterOnRichTextWidget() function
This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Creates the ChangeRichTextWidgetFilterSettings command for FilterOpIgnoreDateFilter operation.
Dispatching this command will result in addition of one or more filters into Rich Text widget's date filter ignore-list. Ignored date filters are not passed down to the metrics resolved in rich text references.
The operation is idempotent - trying to ignore a date filter multiple times will have no effect.
Signature:
export declare function ignoreDateFilterOnRichTextWidget(ref: ObjRef, oneOrMoreDataSets: ObjRef | ObjRef[], correlationId?: string): ChangeRichTextWidgetFilterSettings;
Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
ref |
reference of the Rich Text widget to modify | |
|
oneOrMoreDataSets |
one or more refs of date datasets used by date 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: