selectExportEffectiveParameters()

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

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

Returns the per-tab parameter overrides to send on dashboard tabular export, keyed by tab localIdentifier. The shape matches the backend's dashboardTabsParametersOverrides field directly.

Signature:

selectExportEffectiveParameters: (widgetIds: string[] | undefined) => DashboardSelector<Record<string, IDashboardParameterValueOverride[]>>

Parameters

Parameter	Type	Description
widgetIds	string[] | undefined

Returns:

DashboardSelector<Record<string, IDashboardParameterValueOverride[]>>

Remarks

Scope rules: - When widgetIds is empty/undefined (whole-dashboard export), every tab in scope contributes parameter entries with a runtimeOverride. - When widgetIds is non-empty, each widget's owning tab contributes only entries with a runtimeOverride whose ref is referenced by the widget's insight metrics via the dashboard-wide metric → parameter dependency map. Multi-widget across distinct owning tabs yields one map entry per owning tab; entries for the same tab are unioned and deduplicated by ref.

Returns {} (signalling "omit the field on the wire") when: - enableParameters is off, - the workspace catalog parameters are not loaded, - (widget scope only) the measureParameters dependency map is not loaded, - or no in-scope parameter has a runtimeOverride.