Skip to content

Digital Valve

The Digital Valve is an automation symbol for a valve that is either open or closed, such as a shut-off valve. It is found in the Automation - OpenBridge section of the Perspective Component Palette under Valve, as Digital: it is the Valve with valveType set to digital.

Views made before the Valve existed use a separate Digital Valve component. It keeps working, with the same properties, but is no longer in the palette. Everything on this page applies to both.

It is meant to be placed in a mimic or diagram, typically in a coordinate container, with its properties bound to the state of the device. The Digital Valve shows the state it is given; it does not change it, and clicking it does nothing unless you configure an event.

Digital Valve with a tag

The Digital Valve is one of the automation buttons. The readout and tag, the alert frame, the progress ring, the badges, the size and the positioning are shared by all of them and are described in Automation Buttons — Common Features. This page covers what is specific to the Digital Valve.

A Digital Valve dropped from the palette with default properties:

Digital Valve with default properties

Bind open to the tag or property that tells whether the valve is open. The symbol is drawn filled and grey when open is false, and as an outline when it is true.

Closed Open
Closed valve Open valve

The status row of the readout shows Off or On.


variant selects whether the icon is drawn on a button or directly on the background:

  • regular (default) — the icon sits on a round button.
  • flat — only the icon is drawn, larger and without a button. Use it where the valve is part of a pipe in a diagram.

Set vertical to true for a valve in a vertical pipe.

Closed Open Closed, vertical Open, vertical
regular regular, closed regular, open regular, closed-vertical regular, open-vertical
flat flat, closed flat, open flat, closed-vertical flat, open-vertical

handle draws the handle or actuator of the valve on top of the symbol, the way a P&ID shows how a valve is operated. It is none by default. The handle takes the colour of the state: open, closed or static.

handle
manual-aveva manual-aveva handle
manual manual handle
lever-operator lever-operator handle
pneumatic pneumatic handle
electro-hydraulic electro-hydraulic handle
piston piston handle
solenoid solenoid handle
motor motor handle
spring spring handle

The handle sits on top when the medium flows to the right and turns with the flow. flowDirection sets the direction the medium flows through the valve; left at auto it follows vertical: down on a vertical pipe, right otherwise.

right left up down
Flow to the right Flow to the left Flow upwards Flow downwards

invertHandlePosition puts the handle on the other side of the valve, and handleSize set to small draws it from the centre of the symbol, for a flat valve without a button around it:

invertHandlePosition handleSize = small, flat
Handle on the other side Small handle on a flat valve

With static set to true, the valve and its handle are drawn in the static colour, for a valve whose state is not known:

Static valve with a handle

Name Description Property Type
handle The handle or actuator drawn on the valve: none, manual-aveva, manual, lever-operator, pneumatic, electro-hydraulic, piston, solenoid, motor or spring. Default none. value
flowDirection Direction the medium flows: auto, up, down, left or right. Default auto: down on a vertical pipe, otherwise right. value
invertHandlePosition Put the handle on the other side of the valve. Default false. value
handleSize regular, or small to draw the handle from the symbol’s centre. Default regular. value

Name Description Property Type
open Whether the valve is open. Default false. value
variant regular draws the icon on a button, flat draws only the icon. Default regular. value
vertical Draw the valve for a vertical pipe. Default false. value

The Digital Valve is an automation button. The properties below work in the same way on every automation button, and are described in Automation Buttons — Common Features:

  • Readout — The readout next to the symbol: the status row and the tag name. Properties: showReadoutStack, readoutPosition, readoutSize, showStatus, showStatusIcon, hasTag, tag.
  • Positioning — Which part of the button is aligned to the component’s box. Properties: positioning.
  • Size — Size of the whole component. Properties: componentSize.
  • Activated — Highlighted background that marks the symbol as selected. Properties: activated.
  • Static — Grey symbol for a device whose state is unknown. Properties: static.
  • Alert Frame — Alert frame around the symbol. Properties: alert, alertFrameType, alertFrameStatus, alertFrameMode, alertFrameThickness, showAlertCategoryIcon, showAlertIcon, alertIcon, alertLabel, alertTimer.
  • Progress — Progress ring while a command is carried out. Properties: progress, progressMode, progressValue.
  • Badges — Badges in the corners of the symbol. Properties: badgeControl, badgeAlert, badgeInterlock, badgeCommandLocked.
  • Style — Standard Perspective style object.

The Digital Valve has no component events of its own. The standard Perspective events, such as onClick, are available in the component’s event configuration. See Operating a Device.

Built on the OpenBridge Design System