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

The widget's owning tab is resolved from layout, then the result is the intersection of that tab's parameter entries and the parameters referenced by the widget's insight (per insightParameters). Dashboard parameters not referenced by the widget's insight are excluded so that adding/removing unrelated parameters does not invalidate the widget's defFingerprint. Returns an empty array when enableParameters is off so persisted parameter values cannot silently affect execution while the UI is hidden.