selectEffectiveParameterValuesForWidget()
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Returns the parameter values to inject into the widget’s IExecutionConfig.parameterValues.
selectEffectiveParameterValuesForWidget: (ref: ObjRef | undefined) => DashboardSelector<IInsightParameterValue[]>
Parameters
Parameter | Type | Description |
|---|---|---|
ref | ObjRef | undefined |
Returns
DashboardSelector<IInsightParameterValue[]>
Remarks
For each parameter the widget’s insight depends on (via the dashboard-wide insight → parameter dependency map), the value is resolved in this order:
- dashboard chip on the widget’s tab with
runtimeOverride !== undefined, 2. elseinsight.parametersentry for that ref (AD-authored per-insight override), 3. else nothing (backend uses workspace default).
Parameters the widget’s insight does not depend on 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.