Skip to content

Symbols

A symbol is a named piece of SVG stored in the space. Drawing elements that recur — a valve, a breaker, a motor, a pump — are defined once and used from every screen.

The Symbols screen

FieldDescription
NameSymbol name
DescriptionDescription
ContentThe SVG file, uploaded and stored

Symbols are space-scoped rather than tied to a project: every project in the same space draws on the same library. To produce a variant of an existing symbol, clone it.

What symbols are really for is letting an object on a screen draw something different depending on state. With the animation element type set to GetSymbol, the value the expression produces resolves to a symbol, and the object renders that symbol.

A valve is the usual example: three symbols for open, closed and fault, with the expression deciding which is shown from what the field reports. The same approach covers breaker position, pump running state, and hand/auto selection.

This is not the same as doing it with colour: colour repaints the existing drawing, while a symbol replaces the drawing itself. When the open and closed states of a valve are different geometry, colour cannot express it.

All three give you reuse, but of different things:

What it givesWhen
SymbolA single drawing elementThe same shape recurs in many places
FaceplateA parameterised fragment of a screenThe same layout recurs for different equipment
ComponentA ready-made widget with behaviour of its ownYou need a gauge, tank, LED or similar