Button

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

Updated 7 min read
On this page (11 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. Access Control
  11. Visibility

Functional explanation

ButtonObject is a clickable operator control used to execute actions from a page. It is typically used for commands such as navigation, popup opening, script execution, or process-related actions that must be initiated by the operator.

The object can also reflect a digital state through different ON and OFF text and color settings. This makes it suitable when the operator must both issue a command and immediately recognize the current state from the same object.

Object name

Set the object name shown in the button decorator context.

SettingDescriptionExampleUnits
Object NameName used to identify the Button object.PumpStartButtonText

Variable / Expression

Configure the expression that drives the Button state.

SettingDescriptionExampleUnits
Variable / ExpressionExpression used to drive the Button state.PLC1.RunFeedbackExpression

Label

Configure the text shown for the ON and OFF states.

SettingDescriptionExampleUnits
ON TextText shown when the Button state is ON.RunningText
OFF TextText shown when the Button state is OFF.StoppedText

Text

Configure the text appearance used by the Button label.

SettingDescriptionExampleUnits
Font FamilyFont family used for the button text.ArialFont family name
Font AlignHorizontal alignment of the button text: Left, Center or Right.CenterSelection
Font SizeFont size used for the button text. A number without a unit is applied in px.14px
Font WeightFont weight used for the button text.700CSS font weight
PaddingSpace between the border and the button 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. Text with Font Align Center stays centered when the padding is equal on all sides; unequal padding, or Font Align Left or Right, offsets the text. Allow for the padding in the Width and Height of the object. A new Button starts with 0 12: 0 px at the top and bottom and 12 px at the left and right, so a 16 px font fits a Height of 26 px. Clearing the field applies the standard padding of 6 px at the top and bottom and 12 px at the left and right.4 8px

Position / Size

Configure the position and size of the Button object.

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

Individual

Configure the ON and OFF appearance settings for the Button.

SettingDescriptionExampleUnits
ON ColorText color shown when the Button state is ON.#FFFFFFColor
ON Background ColorBackground color shown when the Button state is ON. A gradient can be used here as well as a single color; see the Gradients section of the Color Library article.#28A745Color
ON Border ColorBorder color shown when the Button state is ON.#1E7E34Color
OFF ColorText color shown when the Button state is OFF.#FFFFFFColor
OFF Background ColorBackground color shown when the Button state is OFF. A gradient can be used here as well as a single color; see the Gradients section of the Color Library article.#6C757DColor
OFF Border ColorBorder color shown when the Button state is OFF.#545B62Color
Border RadiusCorner radius of the Button.6px

Actions

Configure the action list executed when the button is clicked.

SettingDescriptionExampleUnits
ActionsAction list executed when the button is clicked.Navigate to Home, Open SettingsAction 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.PositionVariable 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.40px
Animate Width Maximum pxEnd of the pixel span. With Minimum px at 0, this is the width at full scale.160px
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.AxisPositionVariable 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.120px
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.240px
Animate Left VariableVariable or expression that drives runtime left-position animation.PLC1.LeftPositionVariable 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 Button 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 Button object.

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