openflexure_microscope_server.ui.PropertyControl

class documentation

class PropertyControl(BaseModel): (source)

View In Hierarchy

The data required for creating an propertyControl in Vue.

Class Variable broken If True the property control is broken. There is no corresponding property.
Class Variable element_type Undocumented
Class Variable input_style The style of the control.
Class Variable label The label to show in the UI
Class Variable options A mapping of UI display name to value, used for creating a dropdown.
Class Variable property_name The name of the property (or setting).
Class Variable read_back Whether or not to read back the property after setting.
Class Variable read_back_delay The delay in ms before reading back the property.
Class Variable step The step size for a numerical input.
Class Variable thing The Thing "path" for the Thing instance.
broken: bool = (source)

If True the property control is broken. There is no corresponding property.

element_type: Literal['property_control'] = (source)

Undocumented

input_style: Literal['Default', 'DurationHMS'] = (source)

The style of the control.

Default - A standard input box. DurationHMS - Duration in hours mins and seconds.

label: str = (source)

The label to show in the UI

options: dict[str, str | int | float | bool] | None = (source)

A mapping of UI display name to value, used for creating a dropdown.

These options aren't validated here in any way. Any invalid values will be rejected when selected.

property_name: str = (source)

The name of the property (or setting).

read_back: bool = (source)

Whether or not to read back the property after setting.

This is useful for hardware settings that may be coerced to the closest value.

read_back_delay: int = (source)

The delay in ms before reading back the property.

step: int | float | None = (source)

The step size for a numerical input.

If the property is not numeric this will be ignored.

If this is left as None, then the UI will try to use the multipleOf field in the property dataSchema. If multipleOf is not set then the browser default is used.

thing: str = (source)

The Thing "path" for the Thing instance.