useFiltersForWidgetScheduledExport()

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

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

Hook for getting filters for widget scheduled export.

Note: - The resulting filters are a combination of insight and dashboard filters, following these rules: - Cross-filtering filters are excluded as they are typically not desired in the scheduled export. - The widget's ignored filters configuration is honored (ignored filters are not overridden by dashboard filters and remain as is). - If the resulting filters include all-time date filter, it is excluded as it has no effect on the scheduled export execution.

  • If we are editing an existing scheduled export, this function will return its filters, as changing saved filters is currently not allowed.

Signature:

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

Parameters

ParameterTypeDescription
{ scheduledExportToEdit, widget, insight, }IUseFiltersForWidgetScheduledExportProps

Returns:

QueryProcessingState<IFilter[]>

← useFiltersForDashboardScheduledExportuseInsightWidgetDataView() →