unignoreDateFilterOnInsightWidget()
Home > @gooddata/sdk-ui-dashboard > unignoreDateFilterOnInsightWidget
unignoreDateFilterOnInsightWidget() 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 FilterOpUnignoreDateFilter operation.
Dispatching this command will result in removal of one or more filters from Insight widget's date filter ignore-list. 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 unignore an date filter multiple times will have no effect.
Signature:
export declare function unignoreDateFilterOnInsightWidget(ref: ObjRef, oneOrMoreDataSets: ObjRef | ObjRef[], correlationId?: string): ChangeInsightWidgetFilterSettings;
Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
ref |
reference of the insight widget to modify | |
|
oneOrMoreDataSets |
one or more refs of date data sets used by date 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: