investfly.models.indicator.IndicatorParamSpec

Parameter specification for a custom indicator.

@dataclass
class IndicatorParamSpec:

Describe one accepted custom-indicator parameter.

Attributes:
  • paramType: Required data type.
  • required: Whether callers must supply the parameter.
  • defaultValue: Suggested value used by authoring interfaces.
  • options: Optional finite list of accepted values.
paramType: investfly.models.indicator.ParamType

Parameter Type (INTEGER, FLOAT, BOOLEAN, STRING, BARINTERVAL)

required: bool = True

Whether this parameter is required or optional

defaultValue: typing.Any | None = None

The default value for the parameter to auto-populate mainly in UI

options: Optional[List[Any]] = None

Valid value options (if any). If specified, then in the UI, this parameter renders as a dropdown select list. If left as None, parameter renders and freeform input text field.