Pump

This text is AI-generated — we need your feedback

This documentation was written with the help of AI and has not been fully reviewed. If something is wrong, unclear or missing, please tell us: open the feedback form, say which section it concerns and what you expected to read. The same link is at the bottom of every page.

The Pump is an automation symbol for a pump. It is found in the Automation - OpenBridge section of the Perspective Component Palette as Pump.

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 Pump shows the state it is given; it does not change it, and clicking it does nothing unless you configure an event.

The Pump 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 Pump.

A Pump dropped from the palette with default properties:

State

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

Off	On

The status row of the readout shows Off while the pump is off, and the speed while it is on.

---

Speed

While on is true, the readout shows the speed. Set hasSpeed to true and bind speed to the speed of the device. speedUnit is the text shown after the number, for example % or rpm.

speed = 60, speedUnit = %	speed = 1450, speedUnit = rpm, speedMaxDigits = 4

speedMaxDigits is the number of digits the readout makes room for. Shorter numbers are padded with dimmed zeros, so the readout does not change width when the speed changes. Set it to the number of digits of the highest speed.

Note: When hasSpeed is false, the readout shows the deprecated speedInPercent property instead. Use hasSpeed and speed in new views.

Label Direction

labelDirection selects the chevron in front of the speed. Point it in the direction of the flow or movement in the diagram, or set it to none to hide it.

up	down	left	right (default)	none

---

Variant

variant selects what is drawn in the button:

variant		Off	On
regular (default)	The device icon on a round button.
double	The direction icon above the device icon, on a round button.
forward	Only the direction icon, on a round button.
flat	Only the device icon, larger and without a button. Use it where the symbol is part of a line diagram.
flat-forward	Only the direction icon, without a button. It looks the same on and off.

Direction

direction selects the direction icon. It is drawn only in the double, forward and flat-forward variants; in regular and flat it has no effect.

direction		double	forward
forward (default)	Running forward.
forward-fast	Running forward at high speed.
forward-stopped	Stopped; will run forward.
backward	Running backward.
backward-fast	Running backward at high speed.
backward-stopped	Stopped; will run backward.
standby	Standby.

Vertical

Set vertical to true to draw the device icon for a pump that is mounted vertically.

	vertical = false	vertical = true
regular
flat

---

Properties

Name	Description	Property Type
on	Whether the pump is running. Selects the running icon and the speed readout instead of Off. Default false.	value
hasSpeed	Show speed in the readout. When false, speedInPercent is shown. Default false.	value
speed	Speed shown in the readout while on is true. Default 0. Only shown when hasSpeed is true.	value
speedUnit	Text shown after the speed, for example % or rpm. Empty by default.	value
speedMaxDigits	Number of digits the readout makes room for. Default 3.	value
speedInPercent	Deprecated. Speed shown when hasSpeed is false. Default 0.	value
labelDirection	Chevron in front of the speed: up, down, left, right or none. Default right.	value
variant	regular, double, forward, flat or flat-forward. Default regular.	value
direction	Direction icon: forward, forward-fast, forward-stopped, backward, backward-fast, backward-stopped or standby. Default forward.	value
vertical	Draw the icon for a vertically mounted device. Default false.	value

Common Properties

The Pump 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, 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.
• Alert Frame — Alert frame around the symbol. Properties: alert, alertFrameType, alertFrameStatus, alertFrameMode, alertFrameThickness, showAlertCategoryIcon, showAlertIcon.
• 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.

Component Events

The Pump 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.