Edit on GitHub

Timer

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

Defines a field of type timer to measure time or execute time-controlled actions.

Timers have two possible modes of operation, countdown and stopwatch. In countdown mode, the timer will run for a specified duration and fire a Timer Complete trigger upon completion. In stopwatch mode, the timer measures time until it is stopped, either manually or through an action.

typerequired
string
must be: timer
defaultDuration
reference
Duration

The default value of the timer. If set to a non-zero value, the timer will run in countdown mode. If no duration is defined or it is set to "0:00", the timer will run in stopwatch mode. Note that also defining defaultValue will overwrite this setting.

Examples:
90
1 mins 30 sec
1:30
showButtons
boolean
default: false

A flag indicating whether to show all timer control buttons. Use this setting to conveniently remove all buttons in case of the timer being controlled entirely by actions. This setting take precedence over the settings for the individual buttons.

showStartButton
boolean
default: false

A flag indicating whether to show the start button.

showStopButton
boolean
default: false

A flag indicating whether to show the stop button.

showResetButton
boolean
default: false

A flag indicating whether to show the reset button.

skipBehaviors
boolean
default: false

A flag indicating whether to skip automatically creating behaviors to handle the control button, e.g. starting the countdown.

Examples:
type: timer
defaultDuration: 120 seconds
showButtons: true
type: timer
skipBehaviors: true
showStartButton: true
showResetButton: true
Where is this used?
Other schemas that have a reference ($ref) to this schema.

No references found.