DashboardRequiredParam Object
A single parameter a dashboard requires across its charts, identified by the Metabase param slug. The dashboard form renders one control per distinct slug; charts sharing a slug share the value.
Fields
#
defaultValue
The resolved default scalar value for this param, computed from the mapping default rule (e.g. today's date for a DATE param defaulted to TODAY). Null when there is no default.
defaultValues
The resolved default values for this param when it accepts multiple selections.
kind
The mapped key (e.g. PRODUCT, DATE) — selects which control the form renders for this param.
options
The options configured on the Metabase parameter, when Metabase provides a complete list. Null when Metabase has no (or an incomplete) option list, or is unreachable — render the built-in control for the mapped key instead.
slug
The Metabase param slug. Identity of the form field and the key its value is stored under.
Usages
#
References
#
- Field requiredParams from Dashboard
- Field params from DashboardChartParams
DashboardParamValueInput