Documentation Vision Library+ Documentation

Asset Comparison Bar Chart+

Asset Comparison Bar Chart+ compares the same attributes across many AF assets as bars. Rank the assets, color the bars by limits, mark a target for each asset, and let operators click a bar to open a trend or change the display's asset context.

Overview

Bar chart of assembly line speed with bars colored by limits and a target dot for each line

Watch the demo

See Asset Comparison Bar Chart+ in a practical PI Vision workflow.

When to use it

Use Asset Comparison Bar Chart+ when you need to:

  • Compare one attribute across all the assets that match a search, such as the speed of every assembly line.
  • Show several attributes for each asset side by side, on one scale or on separate scales.
  • Keep only the highest or lowest assets of a ranking.
  • Color bars by limits, or mark each asset's target next to its value.
  • Compare a summary over the display time range, such as an average, instead of the current value.

Choose Asset Comparison Table+ when readers need the exact numbers of many attributes in rows. Choose Asset Time Series Chart+ when the values must be followed over time. Choose Asset Analytics KPI+ when you want counts and averages of many assets as cards.

Before you begin

  • Prepare comparable AF assets: either an asset search by database, root, and template, or a fixed set of assets.
  • Use numeric attributes. Units come from AF. Attributes with different units need their own scales (see Compare several attributes for each asset).
  • Current shows the value at the display end time. A summary such as an average covers the display time range.
  • Limits for coloring come from the limits of the AF attribute, such as Upper Limit 1 and Lower Limit 1.

Add and set up the symbol

  1. Select Asset Comparison Bar Chart+ in the PI Vision symbol gallery.
  2. Search for the assets, then drag an attribute such as Speed from the results onto the display. The symbol shows one bar for each asset found.
  3. Right-click the symbol and select Configure Bar Chart....
  4. Under Title, set Title to ON and enter Line speed.
  5. Under Argument, set Sort by to Speed.
  6. Under Data Labels, set Show to ON.
  7. Close the configuration pane. The chart shows the assets from the highest to the lowest speed, each bar labeled with its value and unit.
Bars of line speed sorted from the highest to the lowest with data labels

Common tasks

Choose which assets to compare

Use this when the chart shows too many assets, or the wrong ones.

  1. Right-click the symbol and select Search Criteria....
  2. Narrow the search with Search Root (1), Asset Name (2), Asset Type, or Asset Category. Asset Name accepts wildcards such as Line 1.1*.
  3. Set Number of Results (3) to the most assets you want.
  4. Select Refresh (4).
Search Criteria pane with the asset name Line 1.1 followed by a wildcard

The chart shows only the matching assets. Each symbol keeps its own search.

Five bars for Line 1.1 and the lines below it

Show only the highest or lowest assets

Use this when many assets would crowd the chart and operators need the leaders, or the laggards, only.

  1. In the configuration pane, open Argument.
  2. Set Sort by (1) to the attribute that decides the ranking, for example Speed.
  3. Keep Descending (2) ON to rank from the highest value. Set it to OFF to rank from the lowest.
  4. Set Top N (3) to ON.
  5. Enter the Count (4), for example 3.
Argument group with Sort by Speed, Descending on, Top N on, and a count of 3

The chart shows only the first three assets of the ranking. Top N ranks the assets that the search returned, so raise Number of Results in the search criteria when the ranking must cover more assets. For a ranking that reads from the top down, set Orientation to Horizontal under Style.

Three bars: the three fastest lines

Compare several attributes for each asset

Use this when each asset needs more than one bar, for example speed and production, which have different units.

  1. In the configuration pane, open Attributes and select Modify Attribute List (1). The link changes to Modify Attribute Properties and the pane lists the Additional Attributes.
  2. Select Production Amount (2) in Additional Attributes.
  3. Select the up arrow (3) to move it to Current Attributes.
  4. Under Scales, open Value and select the Multiple scale type (1). Each attribute gets its own scale.
  5. In Attributes, select Production Amount, and under Scale set Position to Right.
Attributes group with Production Amount selected in Additional Attributes
Value group with the Multiple scale type marked

The chart shows two bars for each asset, and each scale takes the color of its attribute. For attributes with the same unit, keep the Single scale type, and set Stack Type to Stack to pile their bars into one.

Two bars for each line, speed on the left scale and production on the right scale

Mark a target with a reference dot

Use this when each asset has its own target in AF and operators should see how far the value is from it.

  1. Add the target attribute, for example Speed|Target, as in the previous task.
  2. Select it in Current Attributes (1).
  3. Enter Target as the Label (2).
  4. Set Display (3) to Reference.
Attributes group with Speed|Target selected, the label Target, and Display set to Reference

The target is drawn as a dot at its value on each asset, and the legend shows it as Target. Set Display to Tooltip instead to hide the attribute from the plot and show its value in the tooltip only.

Bars of line speed with a target dot at 50 m/s for every line

Color bars by limits

Use this when operators must see which assets are in the normal band without reading the numbers.

  1. Right-click the symbol and select Add Multi-State....
  2. Select the attribute in Current Attributes, then check Enable Multi-State (1). The States list shows the limits of the attribute in AF.
  3. Select the color box next to a limit (2) and pick a color. Repeat for each limit.
  4. Optionally check Lines (3) to draw each limit as a dashed line across the plot.
Add Multi-State pane with the AF limits colored green, amber, and red

Each bar takes the color of the band that holds its value. Limits come from the AF attribute of each asset, so assets can change color at different values. The Bad data color marks bars without a good value.

Bars of line speed in green, amber, and red

Show an average over the time range

Use this when the chart should answer how the assets performed over a period, not how they are doing at the end of it.

  1. Set the display time range in the PI Vision time bar to the period you want.
  2. In the configuration pane, open Attributes and select the attribute.
  3. Set Value (1) to Average. Other choices are Total, Minimum, Maximum, Range, Standard Deviation, Population StdDev, Count, and Percent Good.
  4. Choose the Basis (2): Time Weighted or Event Weighted.
Attributes group with Value set to Average and Basis set to Time Weighted

The legend names the summary, for example Speed [Average]. Put the period in the title, because the chart does not show it.

Bars of the average line speed between 00:00 and 08:00

Use the symbol

Bar chart with numbered callouts and a tooltip
What it shows
(1)The title.
(2)The legend: one entry for each attribute, or for each asset when Argument is set to Attribute.
(3)A bar with its data label: the value and unit of one attribute for one asset.
(4)A reference dot, for example the target of an asset.
(5)The tooltip for the asset under the pointer: the value of every attribute, including attributes set to Tooltip.
(6)The toolbar buttons Full screen and Download, when the designer turns the toolbar on.
  • Hover a bar to see the asset and the values of its attributes.
  • Click a bar to do what the designer chose under Asset Selection. The default, Ad Hoc Chart, opens a Popup Trend of that asset's attributes. Set asset context changes the asset selector of the display to the clicked asset. Other actions open a hyperlink or filter other symbols.
  • Double-click the chart to open a Popup Trend of every asset the chart shows.
  • Full screen opens the chart in a large dialog. Download offers PNG, SVG, and PDF images, and CSV, JSON, and XLSX data with one row for each asset and attribute. The toolbar stays hidden until the pointer enters the chart, unless the designer chose Always.
  • Filters: an Asset Filter+ or another asset symbol on the display can narrow the bars. See Filtering dashboards.
  • No assets: when the search or a filter leaves no assets, the plot stays empty with its title and legend.
  • The symbol only displays data. It does not write to the PI System.
An empty plot with a title and legend for a search that found no assets

Configure the symbol

Right-click the symbol and select Configure Bar Chart.... The groups appear in this order. The right-click menu also offers Search Criteria... and Add Multi-State....

Title

SettingWhat it does
Title, Sub TitleShow or hide each heading and set its text.
Font Size, AlignmentSet the heading size and its position: left, center, or right.

Style

SettingWhat it does
ThemeSelects the color theme, from Software Athlete to Custom Theme. Custom Theme adds Foreground and Background colors.
Surface, Container StyleSelect a flat or gradient fill, and the frame around the symbol.
Apply to all symbolsCopies the theme, surface, container style, and display background to every other Vision Library+ symbol on the display.
Font SizeSets the size of all chart text except the title.
OrientationVertical draws columns. Horizontal draws rows.
GapSets the space between the bars of one asset, from 0% to 100%. Appears when the chart has more than one attribute.

Grid

SettingWhat it does
ShowTurns the grid on or off.
LinesDraws None, Horizontal, Vertical, or Both grid lines. The names describe the direction on screen, in either orientation.
BandsTurns alternating shaded bands on or off.
BorderAxes draws the two axis lines, Frame draws a rectangle around the plot, and None draws neither.

Legend

SettingWhat it does
EnabledShows or hides the legend.
Position, Placement, alignmentPlace the legend at the top, right, bottom, or left, outside or inside the plot, and along that edge.
ColorMarker shows a colored marker beside each entry. Text colors the entry text instead.

Data Labels

SettingWhat it does
ShowShows or hides the labels on the bars.
PositionPlaces labels Auto, Outside, Inside, Inside Bottom, or Inside Top.
Name, ValueSelect what each label prints.
BackgroundAdds a badge behind each label.
Font Size, UnitsSet the label size, and add the unit of the attribute after the value.

Tooltip

SettingWhat it does
ShowTurns the hover tooltip on or off.
PointerNone shows no guide. Argument highlights the asset band under the pointer. Cross adds crosshair lines.

Toolbar

SettingWhat it does
Show ToolbarShows the Full screen and Download buttons.
RevealOn Hover shows the buttons when the pointer enters the chart. Always keeps them visible and reserves a band at the top of the chart. Available when Show Toolbar is ON.

Asset Selection

SettingWhat it does
EnabledTurns the click on a bar on or off.
ActionAd Hoc Chart opens a Popup Trend of the clicked asset. Set asset context and Set asset context as root change the asset context of the display to the clicked asset. Open Hyperlink opens the link you enter, with the clicked asset as the asset parameter, in a new tab. Filter publishes the clicked asset to other symbols and highlights its bars.

Filtering

SettingWhat it does
Filter IndicatorCompact shows a filter icon, Full adds the asset count, and Hidden shows nothing.
Ignore MasterON ignores master filters. Linked inputs still apply.
Linked Inputs, Linked OutputsMap a named channel to a property of the assets, and the clicked asset to a channel. Linked outputs are available when Action is Filter. See Filtering dashboards.

Argument

The argument is the axis that carries the categories.

SettingWhat it does
TypeAsset puts the assets on the axis and draws one series for each attribute. Attribute puts the attributes on the axis and draws one series for each asset.
Show, Position, Invert Scale, TitleShow the axis, place it at the bottom or top, reverse its order, and show its title.
LabelAvailable when Type is Asset. Labels the assets with their Name, Description, Path, or the value of an attribute.
Sort by, DescendingAvailable when Type is Asset. Order the assets by an attribute. Used in Show only the highest or lowest assets.
Top N, CountAvailable when Type is Asset and Sort by is set. Keep the first assets of the ranking, from 1 to 100.
Group, AttributeAvailable when Type is Asset. Groups the assets under the value of the chosen attribute. That attribute is not drawn as a bar.
Stack, ColorAvailable when Type is Attribute. Stack piles the bars of all assets. Color is Auto or Custom, which uses the asset colors from the Assets group.

Value

SettingWhat it does
Label PositionDraws the scale labels Outside or Inside the plot.
Scale TypeSingle draws one scale. Multiple draws one scale for each attribute. Custom adds a list of scales with + Add Scale, and each attribute picks one in Attributes. Used in Compare several attributes for each asset. Appears when the chart has more than one attribute and Type is Asset.
Show, Position, Invert Scale, TitleShow the scale, place it on either side, reverse it, and show its title.
TransformLinear or Logarithmic. Not available while the bars of the scale are stacked.
Scale RangeAuto fits the scale to the values. Database uses the range stored with the attribute. Custom adds Minimum and Maximum.
TicksAuto or Custom tick spacing.
Stack TypeOFF, Stack, or 100%. Available when Type is Asset and the attributes share a scale.

Assets

Available when the symbol shows a fixed set of assets. A symbol with a search lists its assets in Search Criteria... instead.

SettingWhat it does
ColorSets the bar color of the selected asset. Available when Color under Argument is Custom.
LabelReplaces the name of the selected asset.

Attributes

The list shows the attributes the chart reads. Use Modify Attribute List to add and remove them.

SettingWhat it does
ValueCurrent, or a summary over the display time range. Used in Show an average over the time range.
BasisTime Weighted or Event Weighted. Available when Value is not Current.
Boundary TypeInside uses the values within the range. Outside also uses the last value before the range. Available when Basis is Event Weighted.
LabelReplaces the attribute name in the legend and tooltip.
Hidden MeasureON reads the attribute without drawing it, for example for sorting or labeling.
DisplayVisible draws bars. Tooltip shows the value in the tooltip only. Reference draws a dot. Used in Mark a target with a reference dot. Available when Type is Asset.
Color, BackgroundSet the bar color, and add a shaded band behind the bars with its color and opacity. Available when Type is Asset.
Stack, GroupStack piles the bars of this attribute with others. Attributes with the same Group name stack together. Available when Type is Asset and Scale Type is not Multiple.
ScaleSettings of the scale of this attribute: Show, Position, Invert Scale, Transform, Scale Range, Title, and Ticks. With Custom, a list picks one of your scales. Available when Type is Asset and Scale Type is Multiple or Custom.

Numbers

Sets the number format of the data labels and the tooltip: Database, General, Number, or Scientific.

Search Criteria

Opened from the right-click menu. Used in Choose which assets to compare.

SettingWhat it does
Database, Search RootThe AF database and the element that the search starts from.
Asset Name, Asset Type, Asset CategoryFilter the assets by name with wildcards, by element template, or by category.
Number of Results, Asset OrderLimit the number of assets, and order them in the results.

Add Multi-State

Opened from the right-click menu. Used in Color bars by limits.

SettingWhat it does
Current AttributesThe list of attributes. Each attribute has its own multi-state.
Enable Multi-StateTurns on coloring for the selected attribute.
LinesDraws each limit as a dashed line in its color. Available when Type is Asset.
StatesOne color for each band between the limits. Bad data colors values that are not good.

Troubleshooting and limitations

SymptomCauseWhat to do
The plot is empty.The search found no assets, or a filter excludes all of them.Open Search Criteria... and select Refresh, or clear the filter.
The chart shows fewer assets than expected.Number of Results or the Top N count limits them.Raise the limit, or turn Top N off.
The bars of one attribute are tiny.Attributes with different units share one scale.Select the Multiple scale type.
Bars keep their color.Enable Multi-State is off for that attribute, or it has no limits in AF.Open Add Multi-State..., select the attribute, and check Enable Multi-State.
A target appears as bars, not as dots.Display of the attribute is Visible.Set Display to Reference.
A click opens a trend, not another display.Action is Ad Hoc Chart, the default.Choose another Action under Asset Selection.
Download offers images only.Your administrator turned off data exports.Ask your administrator.

Limitation: Display, Stack, and the settings of individual scales apply when Type is Asset. With Type set to Attribute, all attributes share one scale.

Limitation: Sort by, Top N, Group, and Label apply when Type is Asset.

Limitation: The chart has no setting for a free-standing reference line. Use a Reference dot, or the Lines of a multi-state, to mark a value.

Limitation: Each bar shows one value for one attribute and asset: the current value, or one summary of the display time range. For the history of the values, use Asset Time Series Chart+.