Square

Functional reference for SquareObject, 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. Settings
  4. Color
  5. Position / Size
  6. Border
  7. Actions
  8. Animate Position / Size
  9. Rotation
  10. Access Control
  11. Visibility

Functional explanation

SquareObject is a rectangular shape used for panels, status blocks, separators, background blocks, and simple visual highlighting.

It is the basic building block for many design layouts because it can act as a flat shape, a framed panel, or a container-style visual element inside a larger symbol.

Use the page background settings for the full page background. Use SquareObject for local panels and visual blocks inside the page.

Object name

Set the object name shown in the square decorator context.

SettingDescriptionExampleUnits
Object NameName used to identify the Square object.StatusPanelText

Settings

Configure the fill, border, and state styling for the square object.

SettingDescriptionExampleUnits
Set BackgroundMarks the object as a background element, so it sits behind the other objects on the page.falseBoolean

Color

Configure the color and the conditional color states for the square object.

SettingDescriptionExampleUnits
ColorFill color for the shape. Set from the Color picker in the Color group. A gradient can be used here as well as a single color; see the Gradients section of the Color Library article.#f8f9faColor
Color StatesConditional color state rules that restyle the square from a variable or expression. Each rule pairs a condition with a color, and the first matching rule wins. A gradient can be used here as well as a single color; see the Gradients section of the Color Library article.[{"state":"alarm","color":"#dc3545"}]JSON array

Position / Size

Configure the position and size of the Square object.

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

Border

Configure the border styling for the square object.

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

Actions

Configure the action list executed when the square is clicked. See the Actions article for every available action type and its settings.

SettingDescriptionExampleUnits
ActionsAction list executed when the square is clicked.Open popup, set valueAction configuration

Animate Position / Size

Configure the runtime animation settings for height, width, top, and left of the Square 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

Rotation

Configure the rotation of the square 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 Square 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 Square object.

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