useFiltersForDashboardScheduledExport

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

useFiltersForDashboardScheduledExport variable

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 dashboard scheduled export.

Note: - This function excludes cross-filtering filters, as these are typically not desired in exported reports.

  • If the current dashboard filters (excluding cross-filtering) match the saved dashboard filters, this hook returns undefined. In such cases, the scheduled export will use the most recent saved dashboard filters, guaranteeing that the export reflects the latest intended filter configuration.

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

Signature:

useFiltersForDashboardScheduledExport: ({ scheduledExportToEdit, }: IUseFiltersForDashboardScheduledExportProps) => FilterContextItem[] | undefined
← useFilterBarPropsuseFiltersForWidgetScheduledExport() →