useWidgetAlertFilters()

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

useWidgetAlertFilters() 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.

Warning: This API is now obsolete.

  • can be removed, once enableAutomationFilterContext is removed

Hook for getting filters for widget alert.

Note: - In case of existing widget alert, it returns the saved filters from the widget alert. - Otherwise, it returns the filters ready to be saved in new widget alert, sanitized according to the following rules: - Cross-filtering filters are excluded as they are typically not desired in the widget alert. - The widget's ignored filters configuration is honored.

Signature:

export declare function useWidgetAlertFilters({ alertToEdit, widget, insight, }: IUseWidgetAlertFiltersProps): QueryProcessingState<IFilter[]>;

Parameters

ParameterTypeDescription
{ alertToEdit, widget, insight, }IUseWidgetAlertFiltersProps

Returns:

QueryProcessingState<IFilter[]>

← useVisualizationExportDatauseWidgetExportData →