Transmitter
The Transmitter is a label for a measuring point in a diagram, such as a pressure or temperature transmitter on a pipe. It shows the reading on a chip that is attached to the line by a short leader line. It is found in the Automation - OpenBridge section of the Perspective Component Palette as Transmitter (Experimental).
Note: This component is experimental: its properties may change in a later version.

- Leader line — the short line from the chip to the line in the diagram. See Orientation.
- Chip — the reading: an optional icon, the value and the unit. See Value.
- Id tag — the name of the measuring point. See Tags.
The Transmitter shows the value it is given; it does not read tags itself.
Clicking it fires the onActionPerformed event.
A Transmitter dropped from the palette with default properties. The blue frame is the component’s box, as the Designer shows it when the component is selected:

For several readings of the same measuring point on one leader line, use the Transmitter Stack.
type selects what the transmitter shows:
| type | Shows | |
|---|---|---|
indicator |
Only a round pill with the tag, and no value. |
![]() |
value (default) |
The value and the unit. | ![]() |
horizontal-graph |
The value, with a trend graph beside it. | ![]() |
vertical-graph |
The value, with a trend graph below it. | ![]() |
The graph shows the points in data. data can be:
- a dataset, for example from a tag history binding. The first date column (or else the first column) is the time, and the first other column that is not a date is the value. A dataset with a single value column is drawn against the row number;
- an object with two lists,
xValuesandyValues; - a list of objects with
xandy; - a list of numbers, which are the values in order.
Without data the graph is an empty line:

Properties
Section titled “Properties”| Name | Description | Property Type |
|---|---|---|
| type | indicator, value, horizontal-graph or vertical-graph. Default value. |
value |
| data | The points of the trend graph, in one of the four forms above. Empty by default. | object |
Bind value to the measurement, and write the unit in unit. A value that is
not a number is shown as dashes.
value = 12.3, unit = bar |
unit empty |
hasDegree = true, unit = C |
|---|---|---|
![]() |
![]() |
![]() |
hasDegree adds a degree sign between the value and the unit, for
temperatures and angles.
Number Format
Section titled “Number Format”numberFormat is a Java
DecimalFormat
pattern. The Transmitter uses two things from it:
- The digits after the decimal point set the number of decimals. They are
always shown, whether written as
0or#: both0.000and0.###show1.5as1.500. A pattern without a decimal point shows no decimals. - The zeros before the decimal point set how many digits the chip makes
room for, so that it keeps its width when the value changes:
000.0makes room for three digits.
No thousands separator is added, also when the pattern has a ,. The same
format is used for the advice and the setpoint.
The value 12.345 with four patterns:
0.0 (default) |
0 |
0.00 |
000.0 |
|---|---|---|---|
![]() |
![]() |
![]() |
![]() |
Set hintedZeros to true to fill the room that numberFormat makes with
dimmed zeros:

A minus sign makes the chip wider. Set hasSignSpacer to true to always keep
room for the sign, so that the chip has the same width for positive and
negative values:
5.2, hasSignSpacer = false |
5.2, hasSignSpacer = true |
-5.2, hasSignSpacer = true |
|---|---|---|
![]() |
![]() |
![]() |
Set hasIcon to true and select an icon with icon.path to show what is
measured:
![]()
Properties
Section titled “Properties”| Name | Description | Property Type |
|---|---|---|
| value | The reading. Default 0. |
value |
| unit | Text after the reading, for example bar. Empty by default. |
value |
| numberFormat | DecimalFormat pattern: the number of decimals, and the number of digits to make room for. Default 0.0. |
value |
| hintedZeros | Show the room made by numberFormat as dimmed leading zeros. Default false. |
value |
| hasSignSpacer | Always keep room for a minus sign. Default false. |
value |
| hasDegree | Show a degree sign between the value and the unit. Default false. |
value |
| hasIcon | Show an icon in front of the reading. Default false. |
value |
| icon | The icon. Only shown when hasIcon is true. |
object |
| icon.path | Path of the icon, for example openbridge/pressure. Default openbridge/placeholder. |
value |
| icon.useCssColor | Draw the icon in its own colors instead of the text color. See Icons. Default false. |
value |
A transmitter has two texts:
idTag— the name of the measuring point, for examplePT01, shown below the chip (above it whenorientationistop). It is shown for everytype.tag— the short text in the pill of theindicatortype, for examplePT. It is not used by the other types.
idTag = PT01 |
idTag empty |
indicator with tag = PT |
|---|---|---|
![]() |
![]() |
![]() |
Properties
Section titled “Properties”| Name | Description | Property Type |
|---|---|---|
| idTag | Name of the measuring point, shown outside the chip. Empty by default. | value |
| tag | Text in the pill. Empty by default. Only shown when type is indicator. |
value |
Advice and Setpoint
Section titled “Advice and Setpoint”The chip can show two more numbers in front of the reading:
- an advice, a recommended value: set
hasAdvicetotrueand bindadviceValue; - a setpoint, the value the process is controlled towards: set
hasSetPointtotrueand bindsetpointValue.
Both are for reading only, and use the same numberFormat as the value. They
are not shown by the indicator type.
| Advice | Setpoint | Both |
|---|---|---|
![]() |
![]() |
![]() |
Properties
Section titled “Properties”| Name | Description | Property Type |
|---|---|---|
| hasAdvice | Show the advice. Default false. |
value |
| adviceValue | The advised value. Default 0. Only shown when hasAdvice is true. |
value |
| hasSetPoint | Show the setpoint. Default false. |
value |
| setpointValue | The setpoint. Default 0. Only shown when hasSetPoint is true. |
value |
Set hasAlert to true to draw an alert frame around the transmitter, the
graph and the id tag included. Bind it to an expression that is true while
the measurement has an active alarm. The other alert properties have the same
names and values as on the automation buttons, described in
Alert Frame:
alertFrameStatus— severity, which sets the colour and the badge in the flap: alevel-*value (the legacyalarm,warningandcautionstill work when bound or typed in). Defaultlevel-high.alertFrameType—regular(default) draws the frame alone; the*-fliptypes add a flap with the status badge.alertFrameMode—acked-active(default) is steady,unacked-activeflashes,unacked-rectifiedflashes a dashed frame. A flashing frame turns 2 px wider and back; the images show it wide.alertFrameThickness—small(default) orlarge.alertIcon,alertLabelandalertTimer— an icon, a label and a timer in the flap, described in Flap Content. The icon needsshowAlertIcon.
value |
horizontal-graph |
|---|---|
![]() |
![]() |
alertFrameType adds a flap with the status badge:
small-side-flip |
large-side-flip |
|---|---|
![]() |
![]() |
bottom-flip |
top-flip |
![]() |
![]() |
alertFrameStatus = level-medium |
alertFrameMode = unacked-rectified |
|---|---|
![]() |
![]() |
Properties
Section titled “Properties”| Name | Description | Property Type |
|---|---|---|
| hasAlert | Draw an alert frame around the transmitter. Default false. |
value |
| alertFrameStatus | Colour and badge: a level-* value (the legacy alarm, warning and caution still work when bound or typed in). Default level-high. Only shown when hasAlert is true. |
value |
| alertFrameType | Shape of the frame: regular, small-side-flip, large-side-flip, bottom-flip or top-flip. Default regular. Only shown when hasAlert is true. |
value |
| alertFrameThickness | small or large. Default small. Only shown when hasAlert is true. |
value |
| alertFrameMode | Life cycle state: acked-active (steady), unacked-active (flashes) or unacked-rectified (dashed, flashes). Default acked-active. Only shown when hasAlert is true. |
value |
| showAlertCategoryIcon | Show the status badge in the flap. A small-side-flip without it is not drawn. Default true. Only shown when hasAlert is true. |
value |
| showAlertIcon | Show alertIcon in a large-side-flip, bottom-flip or top-flip flap. Default false. Only shown when hasAlert is true. |
value |
| alertIcon | The icon in the flap. Only shown when showAlertIcon is true. |
object |
| alertIcon.path | Path of the icon. Default openbridge/placeholder. |
value |
| alertIcon.useCssColor | Draw the icon in its own colors instead of the text color. See Icons. Default false. |
value |
| alertLabel | Label in a bottom-flip or top-flip flap. Default empty. Only shown when hasAlert is true. |
value |
| alertTimer | Timer text at the end of a bottom-flip or top-flip flap. Default empty. Only shown when hasAlert is true. |
value |
Orientation
Section titled “Orientation”orientation selects on which side of the line the chip is, and thereby which
way the leader line points: with bottom the chip is below the line and the
leader line points up, with left the chip is to the left of the line and the
leader line points right.
The chip and the leader line together are centred in the component’s box. The blue frame in the images is the component’s box:
| orientation | |
|---|---|
top |
![]() |
right |
![]() |
bottom (default) |
![]() |
left |
![]() |
The transmitter does not grow with the box. The chip is as wide as its content,
so with left and right the tip of the leader line moves sideways when the
value gets more digits. Use numberFormat and
hasSignSpacer to keep the width constant.

Properties
Section titled “Properties”| Name | Description | Property Type |
|---|---|---|
| orientation | Side of the line the chip is on: top, right, bottom or left. Default bottom. |
value |
size sets the size of the chip:
regular (default) |
medium |
large |
|---|---|---|
![]() |
![]() |
![]() |
Note: Use
size, and leavecomponentSizeatregular.componentSizemakes the chip, the unit and the name larger but not the value, so withmediumandlargethe value sits low in a chip that is too tall for it.
The colours follow the OpenBridge palette of the session:

Properties
Section titled “Properties”| Name | Description | Property Type |
|---|---|---|
| size | Size of the chip: regular, medium or large. Default regular. |
value |
| componentSize | Size of the chip, unit and name, not the value: regular, medium or large. Default regular. See the note above. |
value |
| style | Standard Perspective style object. | object |
Component Events
Section titled “Component Events”| Event | Description | Event Object |
|---|---|---|
| onActionPerformed | Fired each time the transmitter is clicked. | — |
Examples
Section titled “Examples”Example 1 — Pressure Transmitter on a Pipe
Section titled “Example 1 — Pressure Transmitter on a Pipe”-
Drop a Transmitter into the coordinate container of the diagram, above the pipe.
-
Set:
Property Value orientation topunit barnumberFormat 00.0idTag PT01hasIcon trueicon.path openbridge/pressure -
Bind
valueto the measurement, for example[default]Pump01/Pressure. -
Bind
hasAlertto an expression that istruewhile the measurement has an active alarm, andalertFrameModetounacked-activewhile that alarm is not acknowledged. -
Move the component so that the tip of the leader line touches the pipe.
Example 2 — Open a Trend Popup on Click
Section titled “Example 2 — Open a Trend Popup on Click”- Configure the
onActionPerformedevent of the Transmitter with a Popup action that opens a view with a trend of the measurement. - Pass the tag path to the popup as a view parameter, for example
[default]Pump01/Pressure.
Found an error or something unclear?
Tell us what is wrong, confusing or missing on this page.
Built on the OpenBridge Design System































