Documentation Vision Library+ Documentation

Radial Gauge+

Radial Gauge+ shows a value as a needle, marker, or bar on a circular scale, with colored bands that mark the limits. Operators see at a glance where the value is and how close it is to a limit.

Overview

Radial gauge with a needle in the green band of a scale from 0 to 50 percent

Watch the demo

See Radial Gauge+ in a practical PI Vision workflow.

When to use it

Use Radial Gauge+ when you need to:

  • Show one process value on a dial, with its range.
  • Color the dial in bands that mark low, normal, high, and critical limits.
  • Show several related values of the same unit on one shared scale.
  • Choose the shape of the dial, from a full circle to a half circle.

Choose Linear Gauge+ when a straight bar fits the display better than a dial. Choose Value+ when the number alone is enough.

Before you begin

  • Prepare one or more numeric PI Points or AF attributes. All values on one gauge share one scale, so use values with the same unit.
  • Decide the limits and their colors if the dial should show bands. They are set in the PI Vision multi-state configuration of the symbol.
  • An AF attribute can be shown in another unit of the same kind with Display unit. A PI Point always shows its own engineering unit.

Add and set up the symbol

  1. Select Radial Gauge+ in the PI Vision symbol gallery and drop it on the display.
  2. Drag a numeric data source onto the symbol. The gauge shows a marker on the scale.
  3. Right-click the symbol and select Configure Radial Gauge.
  4. Under Trace Options, select the data source and set Type to Needle.
  5. Close the pane. The needle points to the current value on a scale that follows the range stored with the data source, and the center label shows the value.
Radial gauge with a blue needle on a scale from 0 to 100 percent

Common tasks

Set a fixed scale range

Use this when the useful part of the scale is smaller than the range stored with the data source.

  1. Right-click the symbol and select Configure Radial Gauge.
  2. Under Scale, open Range and set Range to Custom (1).
  3. Enter the Maximum (2) and the Minimum (3).
Range group with Custom selected and the Maximum and Minimum fields marked

The scale now runs from the minimum to the maximum, and the tick labels follow. A value outside the range stays at the end of the scale. Set Invert scale to ON to make the scale run counter-clockwise. A custom range is read in the displayed unit.

Radial gauge with a custom scale from 0 to 50 percent

Color the dial by limits

Use this when the operator must see at once whether the value is low, normal, or high. The bands come from the multi-state limits of the symbol.

  1. Right-click the symbol and select Configure Multi-State.
  2. Under States, change the upper limit (3) of a state, or click its color box (2) and pick a color.
  3. To add a state, type its upper limit in the empty field, then click Add (1).
  4. Right-click the symbol again and select Configure Radial Gauge.
  5. Under Rangebar, make sure Show (1) is ON.
Multi-State pane with four limits and colors

The dial shows one band for each state. While Range is Auto, the scale runs from the lowest limit to the highest one, and the major ticks sit on the limits.

To emphasize the band that holds the current value, set Highlight (2) to ON. The data source that drives the highlight is listed below the toggle (3).

Rangebar section with Show and Highlight set to ON

The other bands are dimmed, so the green band stands out. Change the dimming with Opacity under Appearance.

Radial gauge with the active green band highlighted and the other bands dimmed

Choose the shape of the dial

Use this when the dial must be a half circle to save height, or a full circle.

  1. Right-click the symbol and select Configure Radial Gauge.
  2. Under Scale, open Layout.
  3. Drag Angle (1) to the right to close the arc from both ends. Drag it to the left to open the arc up to a full circle.
  4. Drag Start (2) to rotate the arc.
Layout group with the Angle and Start sliders marked

Angle runs from 0 to 90 in steps of 5.

AngleResultExample
40 (default)An arc of 280 degrees with an opening at the bottom.
Dial with an arc of 280 degrees
90A half circle.
Dial as a half circle
0A full circle. The minimum and the maximum meet at the bottom, so one label covers the other.
Dial as a full circle

The symbol keeps its size when the shape changes. Resize it so that the labels fit.

Show several values on one dial

Use this when related values share a scale, such as a measured value, its setpoint, and a limit. Every data source on the symbol gets its own pointer.

  1. Drag the data sources onto the symbol.
  2. Right-click the symbol and select Configure Radial Gauge.
  3. Under Trace Options, select a data source in the list (1).
  4. Set Type (2) to Marker, Bar, or Needle.
  5. Set Color (3) so that each pointer is easy to tell apart.
  6. Repeat steps 3 to 5 for each data source.
Trace Options with a data source selected, its Type, and its Color marked

With Range set to Auto, the scale follows the first data source. In this example, a bar, two markers, and a needle share one scale from 5 to 105. Under General, Center Label lists the value and the name of every data source in the pointer color.

Radial gauge with a bar, two markers, and a needle, and four values in the center

When pointers overlap, give a marker or bar a different Position or Offset under its own group in Trace Options.

Style the needle and the value text

Use this when the needle covers the scale labels, or when the center label repeats information that the display already shows.

  1. Right-click the symbol and select Configure Radial Gauge.
  2. Under Trace Options, select the data source. Set Color (1) to Custom for a fixed color, or to Range for the color of the band that holds the value.
  3. Open Needle and drag Length (2) to shorten or lengthen the needle.
  4. Open Label and set Show (3) to Value to print the value at the tip of the needle. Other choices are Name and Name + Value.
Trace Options with the Color, Needle Length, and Label Show controls marked

To simplify the center label, open General > Center Label. Set Label (1) to OFF to hide the data source name. Set Color (2) to Custom for a fixed text color instead of the pointer color.

Center Label group with Label set to OFF and Color set to Marker

The needle is shorter, the value sits at its tip, and the center label shows only the value and the unit.

Radial gauge with a short needle, a value label at the needle tip, and a center label without the name

Use the symbol

Radial gauge with numbered callouts
What it shows
(1)A scale label. With limits, the major ticks and their labels sit on the limits.
(2)A band. Its color is the color of the state for that part of the scale.
(3)The needle. It points to the current value, and its color follows the band that holds the value.
(4)The center label with the value, the unit, and the name of the data source.
(5)The minimum and maximum of the scale.
  • Hover the gauge to see a tooltip, if the designer enabled it. The tooltip shows either the pointer values or the limits, depending on its Type.
  • Read the pointer, the value, and the active band together. Bands only show where the limits are. They do not alarm.
  • Stale data: when a displayed live value is stale, an amber clock appears. Its tooltip names each affected data source. See Data Quality.
  • Bad data: a bad value uses the bad data color of the multi-state configuration. Check the data source.
  • The symbol only displays data. It does not write to the PI System or change other symbols.

Configure the symbol

Right-click the symbol and select Configure Radial Gauge. The pane groups its settings into sections, and each section has collapsible groups. Rangebar appears when the symbol has multi-state limits. Marker, Bar, and Needle groups appear for the selected data source and its Type.

General

SettingWhat it does
StyleTheme, Surface, and Container Style set the common colors and the outer frame. Apply to all symbols copies the choice to other symbols. With the Custom theme, Foreground, Background, and Font are available. See Themes and container styles.
Center LabelShow turns the label in the middle of the dial on or off. Value, Label, and Units choose its content. Color uses the pointer color (Marker) or one fixed color (Custom). Text Shadow improves legibility. See Style the needle and the value text.
TooltipEnabled turns the tooltip on or off. Type shows the pointer values (Marker) or the limit information (Range).

Scale

SettingWhat it does
RangeAuto takes the scale from the lowest and highest limit, or from the range stored with the data source when there are no limits. Custom fixes the Minimum and Maximum. Invert scale reverses the direction. See Set a fixed scale range.
LayoutAngle (0 to 90) sets how far the arc closes: 0 is a full circle and 90 is a half circle. Start rotates the arc. See Choose the shape of the dial.
ScaleShow turns the scale line on or off. Width sets its thickness. Ticks are drawn only while the scale is shown.
MajorShow turns major ticks on or off. Tick spacing is Automatic, Fixed interval, or Multi-state boundaries. Density, Size, and Position (Inside, Center, Outside) shape the ticks. Color is Custom or Range. Range needs multi-state limits.
MinorThe same settings for minor ticks, including an automatic or fixed interval.
LabelsShow, Position (Inside or Outside), Offset, Font Size, and Opacity (%) shape the scale labels. Color is Custom or Range. Background adds a label background. Units adds a unit to the labels. A number format is available for the label values.

Rangebar

Available when the symbol has multi-state limits. The bands come from those limits.

SettingWhat it does
ShowTurns the bands on or off.
HighlightDims every band except the one that holds the value. Pick the data source that drives it in the list below the toggle. See Color the dial by limits.
AppearancePosition places the bands Outside, Center, or Inside of the scale. Size is Uniform (one Width) or Tapered (Start and End widths). Gap, Offset, and Opacity (%) adjust spacing and dimming.

Trace Options

Select a data source in the list. The settings below apply to it.

SettingWhat it does
Display unitShows an AF attribute in another unit of the same kind. Default follows the unit in AF. Unavailable for PI Points and for attributes without a unit. Typed ranges and limits are read in the displayed unit and are not converted, so re-enter them after you change the unit.
Value TypeValue is the current value. The other choices show a summary of the display time range, such as an average, minimum, or maximum.
TypeMarker, Bar, or Needle. See Show several values on one dial.
ColorCustom uses one color. Range uses the color of the band that holds the value (needs limits).
Size factorScales the pointer relative to the gauge, from 0.2 to 2.
MarkerAvailable for Marker. Type picks the shape. Position (Inside, Center, Outside) and Offset keep several markers apart.
BarAvailable for Bar. Position (Inside or Outside) and Rounded end caps.
NeedleAvailable for Needle. Length sets the reach from 20 to 150 percent of the radius.
LabelThe name type, Center Label (include this data source in the center label), Show (Off, Value, Name, Name + Value), Units, Font Size, Bold, and Background for the label at the pointer.
AppearanceOpacity (%), Border, and Border Width of the pointer. A bar also has a Background color.

Other sections

SectionWhat it does
Data RetrievalStart- and Endtimes choose the display time range or a time range of the symbol. It applies to summary value types.
NumbersThe number format of the values.
Data QualityStale warning and Stale after control the amber clock for stale live values. See Data Quality.

Troubleshooting and limitations

SymptomCauseWhat to do
The pointer is missing or sits at an end of the scale.The value is outside the scale range, or the data source has no data.Check the value and the scale range. Widen a Custom range, or set Range to Auto.
Rangebar is missing, or Range colors cannot be selected.The symbol has no multi-state limits.Right-click the symbol, select Configure Multi-State, and add limits.
The scale runs from the lowest to the highest limit and ignores the data source range.Range is Auto and limits exist.Set Range to Custom.
Values or scale labels look 1,000 or 1,000,000 times too large or too small.The attribute's unit in AF differs from the unit you expect.Check the unit in AF, or select the unit under Display unit.
The Display unit row is unavailable.The data source is a PI Point, an attribute without a unit, or a digital or string value.Use an AF attribute with a unit of measure.
A pointer or band is in the wrong place after you change Display unit.A custom range and typed limits are read in the displayed unit and are not converted.Re-enter them in the new unit.
Values read as 0 after you choose a larger unit.The unit is much larger than the stored one.Choose a number format with more decimal places under Numbers.

Limitation: All pointers share the scale of the first data source, so values with different units do not belong on one gauge.

Limitation: On a full circle, the minimum and the maximum are at the same place, and one label covers the other.

Limitation: The band colors and limits are edited in the multi-state pane of PI Vision, not in the gauge pane.