disableInsightWidgetDateFilter()

Home > @gooddata/sdk-ui-dashboard > disableInsightWidgetDateFilter

disableInsightWidgetDateFilter() function

This API is provided as a 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 FilterOpDisableDateFilter operation.

Dispatching this command will result in change of Insight widget's date filter setting. The date filtering will be disabled.

Signature:

export declare function disableInsightWidgetDateFilter(ref: ObjRef, correlationId?: string): ChangeInsightWidgetFilterSettings;

Parameters

ParameterTypeDescription
refObjRefreference of the insight widget to modify
correlationIdstring(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:

ChangeInsightWidgetFilterSettings

← DescriptionTooltipOpenedTypedisableKpiWidgetDateFilter() →