navigate.config.configuration_schema.SettingSpec

class navigate.config.configuration_schema.SettingSpec(value_type: type, default: Optional[Any] = None, label: Optional[str] = None, help_text: Optional[str] = None, choices: Optional[Tuple[Any, ...]] = None, choice_values: Optional[Mapping[Any, Any]] = None, minimum: Optional[float] = None, exclusive_minimum: Optional[float] = None, maximum: Optional[float] = None, step: Optional[float] = None, required: bool = False, dynamic_source: Optional[str] = None, depends_on: Optional[str] = None)

Bases: object

Description of one user-editable setting or feature parameter.

choices defines a closed set of displayed values. choice_values maps displayed values to saved values when those should differ. dynamic_source identifies choices that should be resolved at render time, and depends_on names the parameter that provides context for dependent choices. minimum, exclusive_minimum, maximum, and step define a numeric range; they are intentionally mutually exclusive with choices.

__init__(value_type: type, default: Optional[Any] = None, label: Optional[str] = None, help_text: Optional[str] = None, choices: Optional[Tuple[Any, ...]] = None, choice_values: Optional[Mapping[Any, Any]] = None, minimum: Optional[float] = None, exclusive_minimum: Optional[float] = None, maximum: Optional[float] = None, step: Optional[float] = None, required: bool = False, dynamic_source: Optional[str] = None, depends_on: Optional[str] = None) → None

Methods

__init__(value_type[, default, label, ...])

Attributes

choice_values
choices
default
depends_on
display_label	Return the configured label, falling back to the setting key at render time.
dynamic_source
exclusive_minimum
help_text
label
maximum
minimum
required
step
value_type

property display_label: str

Return the configured label, falling back to the setting key at render time.