useWidgetScheduledExportFilters()

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

useWidgetScheduledExportFilters() 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

Returns filters for widget scheduled export.

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

Signature:

export declare function useWidgetScheduledExportFilters({ scheduledExportToEdit, widget, insight, }: IUseWidgetScheduledExportFiltersProps): QueryProcessingState<IFilter[]>;

Parameters

Parameter	Type	Description
{ scheduledExportToEdit, widget, insight, }	IUseWidgetScheduledExportFiltersProps

Returns:

QueryProcessingState<IFilter[]>