navigate.config.configuration_schema.SettingSpec
- class navigate.config.configuration_schema.SettingSpec(value_type: type, default: 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:
objectDescription of one user-editable setting or feature parameter.
choicesdefines a closed set of displayed values.choice_valuesmaps displayed values to saved values when those should differ.dynamic_sourceidentifies choices that should be resolved at render time, anddepends_onnames the parameter that provides context for dependent choices.minimum,exclusive_minimum,maximum, andstepdefine a numeric range; they are intentionally mutually exclusive withchoices.- __init__(value_type: type, default: 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: Optional[Mapping[Any, Any]] = None
- choices: Optional[Tuple[Any, ...]] = None
- default: Any = None
- depends_on: Optional[str] = None
- property display_label: str
Return the configured label, falling back to the setting key at render time.
- dynamic_source: Optional[str] = None
- exclusive_minimum: Optional[float] = None
- help_text: Optional[str] = None
- label: Optional[str] = None
- maximum: Optional[float] = None
- minimum: Optional[float] = None
- required: bool = False
- step: Optional[float] = None
- value_type: type