Label

Functional reference for LabelObject, including its runtime role and the supported settings available in the design environment.

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

Functional explanation

LabelObject displays static text or live variable values. Internally it behaves like a textarea, so the visible result depends heavily on the chosen width, height, padding, and font settings.

It is commonly used for captions, value displays, status text, engineering units, and other text that must be visible on a page without a full input control.

Leave enough height for bold or larger fonts. A label that looks correct in edit mode can clip in runtime if the line height or padding is too small.

Object name

Set the object name shown in the label decorator context.

SettingDescriptionExampleUnits
Object NameName used to identify the Label object.StatusLabelText

Variable / Expression

Configure the expression that supplies the live label text.

SettingDescriptionExampleUnits
Variable / ExpressionExpression used to supply the visible label text.PLC1.StatusTextExpression

Label

Configure the label text shown when a fixed label is needed.

SettingDescriptionExampleUnits
LabelStatic label text shown by the Label object.Pump statusText

Text

Configure the text appearance and colors used by the Label object. The Color and Background Color settings are the base colors. Color states override the base color only while a condition matches, so a label without color states keeps its configured colors.

SettingDescriptionExampleUnits
ColorText color used for the label.#212529Color
Text Color StatesConditional text color states. The Text Color setting is the base color, a state overrides it only while its condition matches, and the last matching condition wins.[{"condition":"Pump1_Fault == 1","color":"#dc3545"}]JSON array
Background ColorBackground color used behind the label. This is the base color when background color states are used. A gradient can be used here as well as a single color; see the Gradients section of the Color Library article.#FFFFFFColor
Background Color StatesConditional background color states. The Background Color setting is the base color, a state overrides it only while its condition matches, and the last matching condition wins. A gradient can be used here as well as a single color; see the Gradients section of the Color Library article.[{"condition":"Pump1_Fault == 1","color":"#dc3545"}]JSON array
Font FamilyFont family used for the label text.ArialFont family name
Font AlignHorizontal alignment of the label text: Left, Center or Right.LeftSelection
Font SizeFont size used for the label text. A number without a unit is applied in px.14px
Font WeightFont weight used for the label text.700CSS font weight
PaddingSpace between the border and the label 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. The top and bottom padding reduce the height available for the text, so increase the Height of the object by the same amount.4 8px

Position / Size

Configure the position and size of the Label object.

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

Individual

Configure the display and formatting options for the Label object.

SettingDescriptionExampleUnits
Read OnlyKeeps the label display-only. A read only label that has no actions of its own passes clicks through to the object behind it in runtime, so a label placed over a button or a shape does not block that object's action. A label that has its own actions keeps receiving its clicks. In the graphics builder the label always stays selectable.trueBoolean
UnitsAppends the configured variable unit when enabled.trueBoolean
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.trueBoolean
DecimalsNumber of decimals used for numeric display when Floating Point is on. It overrides the Format of the variable for this label.2Number
NumpadEnables the on-screen numpad for input-style editing.falseBoolean
Decimal SymbolEnables the decimal symbol on the numpad.trueBoolean
Minus SymbolEnables the minus symbol on the numpad.trueBoolean

Actions

Configure the action list executed when the label is clicked.

SettingDescriptionExampleUnits
ActionsAction list executed when the label is clicked.Open page, open popup, write variableAction configuration

Animate Position / Size

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

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

Border

Configure the border styling for the Label object.

SettingDescriptionExampleUnits
Border ColorBorder color used for the label.#CED4DAColor
Border Color StatesDynamic border color state rules JSON array.[{"state":"alarm","color":"#dc3545"}]JSON array
Border WidthBorder width used for the label.1px
Border RadiusCorner radius of the label 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

Rotation

Configure the rotation of the label object. The fixed Rotation angle and the free-running rotation are independent and can be combined: the object is first turned to its fixed angle and then keeps turning from there.

Free-running rotation is applied in runtime. In the design environment the object stays still so that it can be selected, moved, and resized.

SettingDescriptionExampleUnits
RotationFixed rotation angle applied to the object. Accepts a value, a variable, or an expression.45Degrees
Transform OriginPoint the object rotates around. Left empty the object turns around its own centre.centerCSS transform origin
Rotate ContinuouslyTurns free-running rotation on while the value resolves to true, which is how a running fan, pump, agitator, or mixer is shown. Accepts true or false, a variable, or an expression, so the movement can follow a run feedback.PLC1.Fan1_RunningExpression
Rotation SpeedSpeed of the free-running rotation in degrees per second, so a larger value turns faster. Accepts a value, a variable, or an expression, which lets the symbol turn at the speed the device reports. A negative value turns the other way.90Degrees per second
Rotation DirectionDirection of the free-running rotation. Accepts a value, a variable, or an expression, so it can follow the direction the drive reports: a positive value turns clockwise and a negative value turns counter clockwise. Clockwise and Counter Clockwise are accepted as text, and a true or false value is read as a reverse signal, where true turns counter clockwise. Leave empty to turn clockwise. Often not needed, because a Rotation Speed that can go negative already sets the direction.-1Signed value

Access Control

Configure access control for the Label 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 label appearance.blur(0px) contrast(30%)CSS filter

Visibility

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

SettingDescriptionExampleUnits
VisibilityExpression controlling whether the object is visible.PLC1.LabelVisibleExpression
BlinkExpression or boolean controlling label 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