selectEffectiveParameterValuesForWidget()

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

selectEffectiveParameterValuesForWidget() 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 parameter values to inject into the widget's IExecutionConfig.parameterValues.

Signature:

selectEffectiveParameterValuesForWidget: (ref: ObjRef | undefined) => DashboardSelector<IInsightParameterValue[]>

Parameters

Parameter

Type

Description

ref

ObjRef | undefined

Returns:

DashboardSelector<IInsightParameterValue[]>

Remarks

For each parameter referenced by the widget's metrics (via the dashboard-wide MAQL metric → parameter dependency map), the value is resolved in this order:

  1. dashboard chip on the widget's tab with runtimeOverride !== undefined, 2. else insight.parameters entry for that ref (AD-authored per-insight override), 3. else nothing (backend uses workspace default).

Parameters not referenced by the widget's metrics are excluded so that adding/removing unrelated parameters does not invalidate the widget's defFingerprint. Returns [] when enableParameters is off or while the dependency map has not been loaded.

← selectEffectiveDateFilterTitleselectEnableAlertAttributes →