Edit on Github

Step Element Schema

A schema that is used to validate a part of Laboperator workflow templates.

Schema

Elements are used to display datapoints over a certain period.

Step Element Schema
typerequired
string
One of: BinaryState Button Clock ConsoleFeed Content DeviceChannelTable DeviceInfo Display FileTable Gauge GaugeControl JsonTable LineChart MultiState NumberInput Separator StringInput StringLog Switch Table Webcam WebPage
Type of the element
height
number
Fixed height of the element in pixels
grid
object or number

Responsive width of the element. The value is the number of columns that the element should occupy based on a 12-column grid layout.

There are 5 breakpoints allowing to define multiple width values for different screen sizes.

A single number may be provided and applied to all breakpoints if there is no reason to resize the element for different screen sizes.

Example 1:
6
Example 2:
xs: 12
md: 6
One of
  • object
  • number
property name*
number [ 1 .. 12 ]
oneOf
any
id
reference
Member Name

Can be used to render the element inside text (e.g. substep description) in the format {{element|memberName}}. For example, when id is defined as "rotationGauge" the text may look like:

Use this view to monitor the stirring speed {{element|rotationGauge}}

placement
string
One of: manual default

When set to manual the element won't be displayed in the substep. To render the element it has to be referenced inside the description markdown: {{element|rotationGauge}}. Replace rotationGauge with the value of the id property from your element definition.

description
string
settings
object
Additional settings

Where is this used?

Other schemas that have a reference ($ref) to this schema.