Skip to content

Electricity Battery

The Electricity Battery is an automation symbol for a battery in an electrical diagram, such as a one-line diagram. It is found in the Automation - OpenBridge section of the Perspective Component Palette as Electricity Battery.

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

Electricity Battery with a tag

The Electricity Battery 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 Electricity Battery.

An Electricity Battery dropped from the palette with default properties:

Electricity Battery with default properties

The Electricity Battery shows only whether the battery is on or off. To show its charge level, use the Automation Tank with type set to battery (see Example 3 — Battery).

Bind on to the tag or property that holds the state of the device. The symbol is drawn filled and grey when on is false, and as an outline when it is true. The status row of the readout shows Off or On.

Off On
Electricity Battery off Electricity Battery on

Note: There is no static icon for the battery. With static set to true, the button turns grey but the battery keeps its on or off icon.


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

  • square (default) — the icon sits on a square button with a border.
  • flat — only the icon is drawn, larger and without a button. Use it where the symbol is part of a line diagram.
square flat
Square variant Flat variant

orientation rotates the icon so that it follows the line it is part of. The readout is not rotated. verticalRight rotates the icon 90° clockwise, verticalLeft 90° counter-clockwise.

horizontal verticalRight verticalLeft
horizontal verticalRight verticalLeft

Name Description Property Type
on Whether the device is on. Selects the on icon and the On status row. Default false. value
variant square draws the icon on a button, flat draws only the icon. Default square. value
orientation Rotation of the icon: horizontal, verticalRight or verticalLeft. Default horizontal. value

The Electricity Battery 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 Electricity Battery 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