ignoreDateFilterOnInsightWidget()
Home > @gooddata/sdk-ui-dashboard > ignoreDateFilterOnInsightWidget
ignoreDateFilterOnInsightWidget() function
Creates the ChangeInsightWidgetFilterSettings command for FilterOpIgnoreDateFilter operation.
Dispatching this command will result in addition of one or more filters into Insight widget's date filter ignore-list. Those date filters that use the provided date data sets for filtering will be ignored by the widget on top of any other filters that are already ignored.
Ignored date 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 date filter multiple times will have no effect.
Signature:
export declare function ignoreDateFilterOnInsightWidget(ref: ObjRef, oneOrMoreDataSets: ObjRef | ObjRef[], correlationId?: string): ChangeInsightWidgetFilterSettings;
Parameters
| Parameter | Type | Description |
|---|---|---|
| ref | ObjRef | reference of the insight widget to modify |
| oneOrMoreDataSets | ObjRef | ObjRef[] | 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: