Skip to main content

Set Value

Purpose

Sets the value of an element e.g. the text to be shown in a label.

Example​

set-value --elementName my-template-name --value "Hello World"

Command Syntax​

ParameterFormatRequirementUsage
--elementNameStringMandatoryThe element whose value is being set.
--valueStringMandatoryThe value of the element. Depending on the element type the value will have a different meaning e.g label type has text as the value but image type will have the png name as the value.

Value Format Expectations​

Element TypeFormatRequirements
labelStringThe text to show in the label. Labels with spaces will need encapsulated in quotes as in the example above.
qrStringThe value of the QR code e.g. a fully qualified URL.
imageStringThe name of the image without .png extension. Names with spaces will need encapsulated in quotes as in the example above.
progressIntegerA number between 0 and 100 representing the percentage completion
buttonNot Applicable
button-arrayNot Applicable
containerNot Applicable
spinnerNot Applicable
Documentation Version 1.0.28