Documentation Vision Library+ Documentation

Asset Treemap+

Asset Treemap+ shows a set of assets as rectangles. One attribute sets the size of each tile and another sets its color, so you see which assets matter most and which need attention in a single view. Tiles can be grouped by the AF hierarchy or by attribute values.

Overview

Treemap of pumps grouped by line and department, sized by pressure and colored by OEE

Watch the demo

See Asset Treemap+ in a practical PI Vision workflow.

When to use it

Use Asset Treemap+ when you need to:

  • Compare the size of many assets and their status in the same view, such as pressure and OEE of every pump.
  • Group assets by line, department, or any attribute, and drill into a group.
  • Color tiles by a numeric range or by a state, so that a failing asset stands out.
  • Open the trend of an asset, or filter other symbols, by clicking its tile.

Choose Asset Comparison Bar Chart+ when you need to read exact values and rank assets, or Asset Comparison Table+ when you need every value in a column.

Before you begin

  • Prepare assets that share an AF template with a numeric attribute for the tile size, such as pressure or production. A tile without a size value is not drawn.
  • Prepare one more attribute for the color: a numeric attribute for a color scale, or a text or state attribute for fixed colors per value. The symbol reads AF attributes, not PI Points on their own.
  • To group by the AF hierarchy, place the assets in an AF structure such as Line, then Department, then Pump.
  • To let a click filter other symbols, add the filter symbols to the display first. See Filtering dashboards.

Add and set up the symbol

  1. Select Asset Treemap+ in the PI Vision symbol gallery.
  2. Drag an AF element that has the size and color attributes onto the display. The symbol shows that asset as one tile.
  3. Right-click the symbol and select Add Dynamic Search Criteria.... The Search Criteria pane opens.
  4. Set Search Root (1) to the element that holds your assets. Optionally narrow the search with Asset Name (2), for example Pump?.
  5. Check Number of Results (3) and select Refresh (4). The symbol loads every matching asset.
  6. Right-click the symbol and select Configure Asset Treemap.... Under Data, set Value to the attribute that sets the tile size. Under Color, set Mode to VALUE and Value to the attribute that sets the color.
  7. Close the pane. Each asset appears as a tile.
Search Criteria pane with Search Root, Asset Name, Number of Results, and Refresh marked
Treemap of nine pumps, each tile sized and colored by OEE

Attributes in the lists appear with a leading vertical bar, such as |OEE. An asset with no size value is not drawn, and one whose size value is 0 is drawn as a thin line or not at all.

Common tasks

Size the tiles by one attribute and color them by another

Use this when the size and the color must tell two different things, for example how much pressure a pump delivers and how well it performs.

  1. Right-click the symbol and select Configure Asset Treemap....
  2. Under Data, set Value (1) to the attribute that sets the size, such as |Pressure.
  3. Under Color, set Mode (2) to VALUE and Value (3) to the attribute that sets the color, such as |OEE.
  4. To change the colors of the scale, use the color list (4). Add Color adds a color stop, and the x button removes one. A scale keeps at least two colors.
  5. Under Scale Range (5), select the first icon, Auto, to span the lowest to the highest value of the loaded assets, or the second icon, Custom, to enter a Minimum and Maximum.
  6. Under Legend, set Enabled (6) to ON to show the color scale beside the treemap.
Data and Color groups with the size attribute, color attribute, color list, scale range, and legend marked

The large tiles are the pumps with the highest pressure, and the color of each tile follows its OEE. Pump2 is large and orange: it carries much pressure and performs poorly.

Treemap with tiles sized by pressure and colored by OEE, with a color scale on the right

If the color attribute has a multi-state definition, the tiles take the states and colors of that definition instead of the scale, and the pane tells you to right-click the symbol and select Add Multi-State... to change them.

Group the tiles by the AF hierarchy

Use this when assets belong to lines or departments and you want to compare within and across them.

  1. Right-click the symbol and select Configure Asset Treemap....
  2. Under Group, set Mode (1) to HIERARCHY.
  3. Set Root (2) to OFF to hide the common top-level element as a group, or to ON to show it.
Group with Hierarchy selected and Root set to Off

The symbol reads the AF path of every asset and nests the tiles by element. Two assets with the same name stay apart because each sits in its own group. With Root off, the lines are the outermost groups.

Treemap with pumps nested in departments and lines

Drill into a group

Use this when the treemap holds more assets than readers can compare at once, and each reader looks at one line at a time. Group by HIERARCHY or ATTRIBUTES first.

  1. Right-click the symbol and select Configure Asset Treemap....
  2. Under Interactivity, open Selection.
  3. Set Click Action (1) to Drilldown. The option is not available when Mode under Group is NONE.
Selection group with Click Action set to Drilldown

The treemap now shows only the outermost groups, each with a triangle and a color that sums up its assets. Click a group to open it, then click a department to reach its assets. A breadcrumb at the bottom shows where you are. Click a name in it to go back up.

Treemap drilled into Line 2 with its three departments and a breadcrumb

Group the tiles by an attribute and give each group a color

Use this when the assets share a state, such as a status, and you want each state in its own block and color.

  1. Under Group, set Mode (1) to ATTRIBUTES.
  2. In Value (2), select the attribute to group by, such as |Status. To group in several levels, select + below the list and choose another attribute.
  3. Under Color, set Mode (3) to CUSTOM.
  4. For each value in the list, such as Running or Failure, open its color list and select a color.
Group set to Attributes with Status, and Color set to Custom with one color per status

Each status becomes a group with its own color, and the tiles inside show the pumps in that state. The list in the pane shows the values found in the loaded assets. A color you picked stays saved even when its value is not in the data at the moment. Set Mode to AUTO instead to give every tile a color from a fixed palette.

Pumps grouped by status with one color per status

Choose what each tile says

Use this when a tile must show more than the asset name and one value, such as its status or a second measurement.

  1. Open Data Labels and make sure Show is ON. Set Position (1) to where the text sits in the tile.
  2. Select + (3) below the list (2) to add a line.
  3. In Value (4), select the attribute for the new line, such as |Pressure.
  4. Set Label (5) to ON to print the attribute name before the value.
  5. To change the size of one line, select it in the list and change Font Size.
Data Labels group with a Pressure line added to the list of tile lines

Every tile now shows its name, its OEE, its status, and its pressure, one per line. Move a line with the arrow buttons below the list, and remove it with the x button. With Units ON, the unit from AF follows each value.

Tiles with the asset name, OEE, status, and pressure on separate lines

Open the trend of an asset from its tile

Use this when an operator who sees a poor tile wants to see how the asset behaved.

  1. Under Interactivity, open Selection.
  2. Set Click Action (1) to Quick Trend.
  3. Click a tile on the display.
Selection group with Click Action set to Quick Trend

A trend opens in a pop-up with every attribute of that asset, such as OEE, Pressure, and Status. Close it with the X at the top right. The other Click Action choices are None, Drilldown, and Filter (see Use the symbol).

Pop-up trend of the clicked pump showing OEE, Pressure, and Status

Use the symbol

Treemap with numbered callouts and a tooltip
What it shows
(1)The title.
(2)A group header, such as a department. In drilldown mode, the group is a tile that you click to open.
(3)A tile. Its area is the size attribute of the asset.
(4)The color attribute value of the asset in the tile text. The tile color follows the same value.
(5)Further lines of the tile, such as the status.
(6)The color scale. It appears when Legend is on and Color is VALUE.
  • Hover a tile to see its name, its size value, and its color value, each with its unit. A digital attribute shows its state text. A group shows the sum of its sizes and the average of its color values, without units.
  • Click a tile to run the click action that the designer chose. Quick Trend opens a pop-up trend. Drilldown opens the group, and the breadcrumb returns. Filter selects the asset, and the symbols linked to it show only that asset. Click the tile again to clear the selection. None does nothing.
  • Toolbar: when the designer turns the toolbar on, it appears at the top right while the pointer is over the symbol. Fullscreen opens the treemap in a large dialog at the same level and with the same colors. Download offers PNG, SVG, and PDF images, and CSV, JSON, and XLSX data. The data file has one row per drawn tile with Asset, Parent, Attribute, Value, Units, and Level. If the administrator disables data exports, only the images remain.
  • Filters: the symbol also follows the master filters of the display. The filter indicator shows how many assets remain. See Filtering dashboards.
  • The symbol only displays data. It does not write to the PI System. Only the Filter click action changes other symbols.

Configure the symbol

Right-click the symbol and select Configure Asset Treemap.... The sections appear in this order. The right-click menu also offers Search Criteria..., Add Multi-State..., and Add Navigation Link....

Trend Options

SettingWhat it does
TitleShows a title with its text, font size, and alignment. A subtitle is optional.
StyleSets the theme, surface, container style, background, foreground, and font size. Apply to all symbols is part of this group.
Data LabelsControls the text in each tile. Show turns the text on or off, Position places it, and Value and Font Size set the default line. Units adds the AF unit. The list holds one entry per line, each with its Value attribute, Label switch for the attribute name, and Font Size. See Choose what each tile says.
ToolbarShow Toolbar turns the toolbar on. Reveal chooses between showing it on hover and always.

Data

SettingWhat it does
ValueThe attribute that sets the tile size. See Size the tiles by one attribute and color them by another.

Interactivity

SettingWhat it does
Click ActionWhat a click on a tile does: None, Quick Trend, Drilldown, or Filter. Drilldown is not available when Mode under Group is NONE. See Drill into a group and Open the trend of an asset from its tile.
FilteringFilter Indicator chooses COMPACT, FULL, or HIDDEN. Ignore Master makes the symbol ignore master filters. Linked Inputs accept filters from other symbols. Linked Outputs publish the clicked asset. Available when Click Action is Filter.

Group

SettingWhat it does
ModeNONE draws a flat list of tiles. HIERARCHY nests tiles by AF path. ATTRIBUTES nests tiles by attribute values.
RootShows or hides the top-level element as a group. Available when Mode is HIERARCHY.
Attributes list and ValueThe attributes to group by, outermost first. Add, move, or delete entries with the buttons below the list. Available when Mode is ATTRIBUTES.

Color

SettingWhat it does
ModeAUTO gives each tile a color from a fixed palette. CUSTOM sets your own colors. VALUE colors by an attribute.
Color (Custom)With HIERARCHY or NONE, one color for all tiles. With ATTRIBUTES, one color per value found; colors of values that are not in the current data stay saved.
Value (Value mode)The attribute that sets the color. If it has a multi-state definition, its states and colors apply.
Add Color and color listThe color stops of the scale, from low to high. Available when the color attribute has no multi-state definition.
Scale RangeAuto uses the lowest and highest loaded value. Custom shows Maximum and Minimum fields.
LegendEnabled shows the color scale at the right edge.

Assets

SettingWhat it does
Assets listFor a fixed set of assets: select an asset and enter a Label to replace its name in the tile. Not shown when the symbol uses a dynamic search.

Attributes and Numbers

SettingWhat it does
Current Attributes and Modify Attribute ListThe attributes the symbol loads for each asset. Every attribute you use for size, color, grouping, or text must be in this list.
Hidden MeasureTakes the selected attribute out of the size, color, grouping, and text choices while it stays in the attribute list.
NumbersThe number format of the displayed values.

Troubleshooting and limitations

SymptomCauseWhat to do
An asset has no tile.It has no value for the size attribute (the log shows how many assets were left out), or the value is 0.Check the value of the size attribute. A 0 is drawn as a thin line or not at all.
The color scale or the legend is missing.Color is not VALUE, or Legend is off.Set Mode under Color to VALUE and Enabled under Legend to ON.
Drilldown cannot be selected.Mode under Group is NONE.Select HIERARCHY or ATTRIBUTES.
Two tiles carry the same name.Two assets share a name in different groups.Group by HIERARCHY, or check the Parent column of a data download.
The colors of a tile follow states, not the scale.The color attribute has a multi-state definition.Right-click the symbol and select Add Multi-State... to change the states.
The treemap shows too few assets.The search returns fewer assets than expected.Open Search Criteria..., check Search Root and Number of Results, and select Refresh.

Limitation: A treemap does not zoom or pan. Use Drilldown to move between levels.

Limitation: The color scale sits at the right edge and is always a gradient bar.