openflexure_microscope_server.ui

module documentation
(source)

Functionality for communicating the required user interface for a thing.

Class ActionButton The data required for creating an actionButton in Vue.
Class PropertyControl The data required for creating an actionButton in Vue.
Function action_button_for Create a ActionButton data for the specified Thing Action.
Function property_control_for Create an PropertyControl data for the specified Thing Property.
def action_button_for(action, **kwargs) -> ActionButton: (source)

Create a ActionButton data for the specified Thing Action.

Parameters
actionThe thing action to create a button for.
**kwargsAny attribute of ActionButton except for thing or action.
Returns
ActionButtonUndocumented
def property_control_for(thing, property_name, **kwargs) -> PropertyControl: (source)

Create an PropertyControl data for the specified Thing Property.

Parameters
thingThe instance of the thing that has the property to be controlled.
property_nameThe name of the property to create a control for.
**kwargsAny attribute of PropertyControl except for thing or property_name. If label is not set here it will be the property name.
Returns
PropertyControlUndocumented