Polyline

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

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

Functional explanation

PolylineObject is the recommended line object for piping, wiring, conduits, and technical route drawings. It is intended for schematic connections and path-style graphics.

The object is often used to show flow paths or route-based equipment connections on overview pages and symbols. It fits technical drawings where a line must follow a specific path instead of being a simple single-segment separator.

Use PolylineObject instead of free-form alternatives when the drawing represents process or technical routing. Keep the point list readable so later maintenance is practical.

Object name

Set the object name shown in the polyline decorator context.

SettingDescriptionExampleUnits
Object NameName used to identify the Polyline object.PipeRouteText

Settings

Configure the point list, stroke, and click action for the polyline object.

SettingDescriptionExampleUnits
PointsPoint list that defines the polyline path.0,0 50,0 50,40Point list
Line WidthStroke width for the line.3px
Line StyleLine style such as Solid, Dotted, Dashed, or Long Dash. The dash and gap lengths are a multiple of Line Width, so changing the line thickness keeps the same proportions.SolidEnum
Line CapSVG line cap setting such as Butt, Round, or Square.buttEnum
Arrow StartArrowhead drawn at the first point of the line. Choose None, Arrow for a filled head, or Open Arrow for an open head.NoneEnum
Arrow EndArrowhead drawn at the last point of the line, which is how flow direction is shown on piping and signal runs. Choose None, Arrow, or Open Arrow.ArrowEnum
Arrow SizeArrowhead length as a multiple of Line Width. Left empty the value 4 is used, with a 6 pixel minimum so a thin line still gets a readable head.4Factor
Bridge CrossingsDraws a small hop where this line crosses another polyline, the notation used on piping and electrical diagrams to show that two lines cross without connecting. The crossings follow the live page layout, so moving either line updates the hops. A line hops over the lines it is drawn on top of, so place it on a higher layer than the lines it should hop over. The hop bulges to the left of the direction the points run in, so reversing the point order puts it on the other side.trueBoolean
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 polyline object.

SettingDescriptionExampleUnits
ColorStroke color for the line. Set from the Color picker in the Color group.#0d6efdColor
Color StatesConditional color state rules that restyle the polyline from a variable or expression. Each rule pairs a condition with a color, and the first matching rule wins.[{"state":"alarm","color":"#dc3545"}]JSON array

Position / Size

Configure the position and size of the Polyline object.

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

Border

Configure the border styling for the polyline object.

SettingDescriptionExampleUnits
Border ColorBorder color used for the polyline.#CED4DAColor
Border Color StatesDynamic border color state rules JSON array.[{"state":"alarm","color":"#dc3545"}]JSON array
Border WidthBorder width used for the polyline.1px
Border RadiusCorner radius of the polyline 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 polyline is clicked. See the Actions article for every available action type and its settings.

SettingDescriptionExampleUnits

Animate Position / Size

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

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