SentinelSCADA › Tutorial › Chapter 9

Chapter 9: Symbol SVG

Goal Bring your own vector artwork onto a screen with the Symbol SVG widget, and know when to use it instead of the Image widget or a built-in object.

The built-in pumps, valves and tanks from Chapter 8 cover common equipment. Every plant also has things they do not: a company logo, a special machine, a symbol from your own P&ID library. The Symbol SVG widget lets you drop in any vector artwork of your own. SVG is a vector format, so the artwork stays sharp at any size, from a small icon to a full-width or even full screen diagram, and it can change with a tag just like the built-in objects.

For this tutorial we will continue with our BoilerHouse project, though on the Settings screen we added in Chapter 7. From the File menu choose Load Screen…, select Settings and press Load Screen.

Part 1: Add a Symbol SVG

From the Toolbox, in the Process & Symbols group, drag a Symbol SVG onto the canvas.

The Symbol SVG item in the Toolbox, with an arrow to an empty Symbol SVG widget on the canvas reading No SVG Selected

Its properties are in two sections. In Geometry & Limits:

Width / Height
Size in pixels.
Orientation
Up, Down, Left or Right. Custom symbols default to Up, meaning exactly as uploaded.
Flip Horizontal
Mirrors the artwork before Orientation is applied.

In Styling & Appearance:

Off SVG File
The symbol file. Click the … button, choose an .svg file (up to 5 MB), and it uploads to the current project.
On SVG File
Optional. A second file shown when the bound tag is on. If left blank, the Off file is used for both.
Color Mode
How the On and Off colours are used (Part 3).
Color (Off) / Color (On) / Glow Color (Active)
The colours that Color Mode applies.
The Styling and Appearance section of the Properties panel showing Off SVG File, On SVG File, Color Mode, Color (Off), Color (On) and Glow Color (Active)

Part 2: Off and On files

Bind the widget to a tag and it switches between its Off and On appearance as the tag changes.

An example: a fire bell drawn as two files, one grey (off) and one lit red (on). Upload the grey file as the Off SVG and the red lit file as the On SVG, bind the widget to a tag, our demo tag Pulse_10s here for expedience, and the bell alternates as the tag changes.

Alarm bell, normal:

The fire alarm bell in its grey Standby state, with the Off and On SVG files set in the Properties panel

Alarm bell, active:

The fire alarm bell in its red Active state

SVG sources and tools

To source or create SVGs we have a wealth of resources, from online open source libraries and paid content, through SVG editing tools, and quite simply, we can ask any modern AI agent such as Claude or Gemini to produce the raw SVG files to the specification and prompt we provide. There are of course editors too, free and paid.

XML Control's SimpleVG is another tool to consider: a browser-based vector editor built for SCADA and HMI diagrams, which reads and writes plain SVG files, and can also export PNG for use in the Image widget (discussed below).

Part 3: Colour modes

Color Mode controls how the colour properties are applied to the artwork:

None
The artwork keeps its own colours.
Color Override
Recolours the symbol to the Off or On colour per state.
Glow Aura
Adds a glow in the Glow Color while the symbol is active.
The bell in its active state with a red glow, and Color Mode set to Glow Aura with the Glow Color set to red
Glow only If chosen, the glow colour only affects the shape outlines and drop shadows. It does not change internal shape colours.

Part 4: Orientation and Flip

Every symbol has an Orientation that turns it in 90 degree steps. The turn is around the symbol's own centre; it does not redraw the artwork or change the widget's size or position. Custom symbols start at Up, exactly as uploaded.

Some artwork is a true mirror image rather than a rotation. For that, tick Flip Horizontal. Flip mirrors the artwork first, and Orientation then turns the mirrored result, so the four Orientation steps behave the same whether Flip is on or off.

Part 5: Keep your artwork clean

Symbols are cleaned automatically when they are drawn, with nothing to configure. For predictable results:

If a symbol looks wrong after import, a missing background or an unstyled shape, check it for external references first.

Part 6: Symbol SVG or Image?

Each widget accepts only its own file types, up to 5 MB per file.

Symbol SVG
SVG only. Vector, so it stays sharp at any size.
Image widget
PNG, JPG, GIF and WEBP. SVG is refused.

Use Symbol SVG for logos, equipment and anything drawn. Use the Image widget for photographs. The Image widget also has an Off Image and an optional On Image for a tag-driven change, like the Symbol.

The Styling and Appearance section of the Properties panel for an Image widget, showing Off Image, On Image, Fit, Corner Radius, Opacity, Inactive Opacity and Grayscale When Inactive

When should I use which?

Built-in pump, valve, tank
Common equipment, ready to use (Chapter 8).
Symbol SVG
Your own drawn artwork, or an exact match to a P&ID standard.
Image widget
Photographs and raster pictures.

Styling the Image widget

Unlike the Symbol, the Image widget's picture cannot be recoloured, but its Styling & Appearance section has options for how it is shown:

Fit
How the picture fills the widget. Contain (the default) shows all of it with its proportions kept. Cover fills the box and crops any overhang. Stretch fills the box and distorts the picture. None shows it at natural size, centred.
Corner Radius (%)
Rounds the corners, from 0 to 50. At 50 a square picture becomes a circle. Best seen with Cover or Stretch.
Opacity (%)
How solid the picture is, 100 down to 0.
Inactive Opacity (%)
The opacity used instead while the bound tag is not active, so you can dim a picture when its equipment is off.
Grayscale When Inactive
Draws the picture in greys while the tag is not active. Colour then means “running” or “needs attention”, in the spirit of ISA-101.
Needs a tag The two Inactive options need a tag bound. They work with a single Off Image, so you do not need a second picture to get a dim or grey “off” state.

Here is the section with its default options:

A lamp picture in its lit state, with the Image widget options at their defaults

Here the same lamp has a Corner Radius of 20, an Inactive Opacity of 40 and Grayscale When Inactive ticked. While the tag is off the lamp is dimmed, grey and softly rounded; when the tag turns on it returns to full colour.

The same lamp dimmed and grey with rounded corners, with Corner Radius 20, Inactive Opacity 40 and Grayscale When Inactive ticked

Summary

So far our screens have run on the simulator. In the next chapter we will add a real Modbus device and set up some tags for real.