Input

Functional reference for InputObject, including how it reads and writes values and which parameters can be configured.

Updated 7 min read
On this page (10 sections)
  1. Functional explanation
  2. Object name
  3. Variable / Expression
  4. Label
  5. Text
  6. Position / Size
  7. Border
  8. Animate Position / Size
  9. Access Control
  10. Visibility

Functional explanation

InputObject is a text entry field used to read and write variable values. It is suitable for numeric setpoints, string input, and operator entry fields that must allow direct manual editing.

The object can act as a normal writable input or as a read-only display field depending on the configuration. It is commonly used where operators must enter a value precisely instead of using a button or slider.

Use it for manual entry when the value must be typed, validated, and written back to a process variable or local variable.

Object name

Set the object name shown in the input decorator context.

SettingDescriptionExampleUnits
Object NameName used to identify the Input object.SetpointInputText

Variable / Expression

Configure the variable or expression bound to the input value.

SettingDescriptionExampleUnits
Variable / ExpressionVariable or expression bound to the field value.PLC1.SetpointExpression

Label

Configure the label text shown with the Input object.

SettingDescriptionExampleUnits
LabelLabel text displayed with the input field.SetpointText

Text

Configure the text formatting and display behavior for the Input object.

16 rows
SettingDescriptionExampleUnits
ColorText color used for the input.#212529Color
Background ColorBackground color used behind the input. A gradient can be used here as well as a single color; see the Gradients section of the Color Library article.#FFFFFFColor
Font FamilyFont family used for the input text.ArialFont family name
Font AlignHorizontal alignment of the input text: Left, Center or Right.LeftSelection
Font SizeFont size used for the input text. A number without a unit is applied in px.14px
Font WeightFont weight used for the input text.400CSS font weight
PaddingSpace between the border and the input text. Enter one to four values in the order top, right, bottom, left, for example 4 8 for 4 px at the top and bottom and 8 px at the left and right. A number without a unit is applied in px.4 8px
Read OnlyMakes the field display-only when true.falseBoolean
Password FieldMasks the input like a password field.falseBoolean
Floating PointTreats the value as a floating-point number and shows it with the number of Decimals. When off, a value from one variable is shown with the Format of that variable when the variable has one, and the Input shows the plain value while it is being edited.trueBoolean
DecimalsNumber of decimals used for numeric display when Floating Point is on. It overrides the Format of the variable for this input.2Number
UnitsAppends the configured variable unit when true.trueBoolean
NumpadEnables the on-screen numpad for text entry.falseBoolean
Decimal SymbolEnables the decimal symbol on the numpad.trueBoolean
Minus SymbolEnables the minus symbol on the numpad.trueBoolean
KeyboardEnables the on-screen keyboard for text entry.falseBoolean

Position / Size

Configure the position and size of the Input object.

SettingDescriptionExampleUnits
TopTop position of the object.100px
LeftLeft position of the object.220px
WidthWidth of the object.180px
HeightHeight of the object.32px
Z-indexLayer order of the object. Higher values appear in front of lower values.10Number

Border

Configure the border styling for the Input object.

SettingDescriptionExampleUnits
Border ColorBorder color used for the input.#CED4DAColor
Border Color StatesDynamic border color state rules JSON array.[{"state":"alarm","color":"#dc3545"}]JSON array
Border WidthBorder width used for the input.1px
Border RadiusCorner radius of the input border.4px
Border VisibilityExpression controlling whether the border is visible.SYSTEM.UserGroups == "Operators"Expression
Border BlinkExpression or boolean controlling border blinking.PLC1.AlarmActiveBoolean or expression
Border Blink SpeedBlink speed used for the border.500ms
Border Blink OffsetBlink offset used to stagger border blinking between objects.falseBoolean

Animate Position / Size

Configure the runtime animation settings for height, width, top, and left of the Input object.

22 rows
SettingDescriptionExampleUnits
Animate Height VariableVariable or expression that drives runtime height animation.PLC1.LevelVariable or expression
Animate Height Minimum RawStart of the raw value span. The animation scales the variable value across the difference between Maximum Raw and Minimum Raw, so keep this at 0 for a direct mapping from 0 to the Maximum Raw value.0Raw value
Animate Height Maximum RawEnd of the raw value span. The animated height reaches full scale when the variable value reaches the difference between Maximum Raw and Minimum Raw.100Raw value
Animate Height Minimum pxStart of the pixel span. The animated height runs from 0 px up to the difference between Maximum px and Minimum px.20px
Animate Height Maximum pxEnd of the pixel span. With Minimum px at 0, this is the height at full scale.60px
Animate Height ReverseSets the edge the height grows from. Cleared grows the object upwards from the bottom edge, which suits level and fill graphics. Selected grows it downwards from the top edge.falseBoolean
Animate Width VariableVariable or expression that drives runtime width animation.PLC1.ValueVariable or expression
Animate Width Minimum RawStart of the raw value span. The animation scales the variable value across the difference between Maximum Raw and Minimum Raw, so keep this at 0 for a direct mapping from 0 to the Maximum Raw value.0Raw value
Animate Width Maximum RawEnd of the raw value span. The animated width reaches full scale when the variable value reaches the difference between Maximum Raw and Minimum Raw.100Raw value
Animate Width Minimum pxStart of the pixel span. The animated width runs from 0 px up to the difference between Maximum px and Minimum px.80px
Animate Width Maximum pxEnd of the pixel span. With Minimum px at 0, this is the width at full scale.220px
Animate Width ReverseSets the edge the width grows from. Cleared grows the object to the right from the left edge. Selected grows it to the left from the right edge.falseBoolean
Animate Top VariableVariable or expression that drives runtime top-position animation.PLC1.PositionTopVariable or expression
Animate Top Minimum RawStart of the raw value span. The animation scales the variable value across the difference between Maximum Raw and Minimum Raw, so keep this at 0 for a direct mapping from 0 to the Maximum Raw value.0Raw value
Animate Top Maximum RawEnd of the raw value span. The offset reaches full scale when the variable value reaches the difference between Maximum Raw and Minimum Raw.100Raw value
Animate Top Minimum pxStart of the pixel span. A rising value moves the object upwards from its resting position by up to the difference between Maximum px and Minimum px. To move the object downwards, set Minimum px above Maximum px.100px
Animate Top Maximum pxEnd of the pixel span. A rising value moves the object upwards by up to the difference between Maximum px and Minimum px.260px
Animate Left VariableVariable or expression that drives runtime left-position animation.PLC1.PositionLeftVariable or expression
Animate Left Minimum RawStart of the raw value span. The animation scales the variable value across the difference between Maximum Raw and Minimum Raw, so keep this at 0 for a direct mapping from 0 to the Maximum Raw value.0Raw value
Animate Left Maximum RawEnd of the raw value span. The offset reaches full scale when the variable value reaches the difference between Maximum Raw and Minimum Raw.100Raw value
Animate Left Minimum pxStart of the pixel span. A rising value moves the object to the right from its resting position by up to the difference between Maximum px and Minimum px. To move the object to the left, set Minimum px above Maximum px.200px
Animate Left Maximum pxEnd of the pixel span. A rising value moves the object to the right by up to the difference between Maximum px and Minimum px.420px

Access Control

Configure access control for the Input object.

SettingDescriptionExampleUnits
Access Control EnableEnables access control evaluation for the object.trueBoolean
Access ControlExpression controlling who can use or see the object.SYSTEM.UserGroups == "Operators"Expression
Access Control FilterCSS filter applied when access control is used to alter the object appearance.blur(0px) contrast(30%)CSS filter

Visibility

Configure the runtime visibility and blinking behavior for the Input object.

SettingDescriptionExampleUnits
VisibilityExpression controlling whether the object is visible.PLC1.InputVisibleExpression
BlinkExpression or boolean controlling input blinking.PLC1.AlarmActiveBoolean or expression
Blink SpeedBlink speed used during runtime.500ms
Blink OffsetBlink offset used to stagger blinking between objects.falseBoolean
Something missing or wrong in this article? Contact us