Documentation Vision Library+ Documentation

Map+

Map+ places assets on a map from their latitude and longitude attributes and shows their current values in labels beside each marker. Markers and labels can take their color from limits or states, so a site that needs attention stands out.

Overview

Map+ showing three European cities with value labels colored by limits

When to use it

Use Map+ when you need to:

  • Monitor assets that are spread over sites, plants, or regions, with the status and values of each location on one map.
  • Color markers and labels by limits or states, so that out-of-range locations stand out.
  • Let operators jump between regions, open the trend of a clicked asset, or use a click to filter other symbols.
  • Draw routes between assets, or add a KML, GPX, or GeoJSON file as an overlay.

Choose Asset Comparison Table+ when the location does not matter and you want to compare exact values side by side.

Before you begin

  • Give every asset a numeric Longitude and Latitude attribute with a good value. In PI System Explorer, set the attribute Properties to Location > Longitude and Location > Latitude. Map+ reads the traits, not the attribute names.
  • Use values from -180 to 180 for longitude and from -90 to 90 for latitude. An asset without valid coordinates has no marker.
  • The browser of every viewer must be able to reach the map tile server. Map+ loads its base map from a third-party provider, so a display on a network without internet access shows no map.

Add and set up the symbol

  1. Select Map+ in the PI Vision symbol gallery.
  2. Drag an AF element that has the location attributes onto the display. The symbol shows that asset at its location.
  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 and Asset Type (2) to their template. Check Number of Results (3).
  5. Select Refresh (4). The symbol loads every matching asset.
  6. Close the pane. Each asset appears as a marker at its location, with its values in a label.
Search Criteria pane with Search Root, Asset Type, Number of Results, and Refresh marked

To show a fixed set of assets instead of a search, drag each asset onto the symbol.

Map with one arrow marker and a value label for each wind turbine

Common tasks

Choose a base map

Use this when the default street map does not suit the display, for example when a quieter gray map makes the colored labels easier to read.

  1. Right-click the symbol and select Configure Map....
  2. Open Map.
  3. In Provider (1), select Arc GIS (Esri).
  4. In Style (2), select World Gray Canvas.
Map group with Provider set to Arc GIS (Esri) and Style set to World Gray Canvas

The base map changes at once. Open Street Map and Arc GIS (Esri) load without a key. For Map Box, a field for your own access token appears under Style.

Gray base map with three city labels

Show names and values in the labels

Use this when a label must say which attribute a value belongs to, or which asset it belongs to.

  1. Open Data Labels.
  2. Set Name (1) to ON to print the attribute name before each value.
  3. Set Asset (2) to ON to print the asset name above its values.
  4. Set Line (3) to ON to draw a line from each label to its marker.
Data Labels group with Name, Asset, and Line set to on

Each label now shows the asset name, then one row for each visible attribute, such as Speed and Power. Use Time to add the timestamp, and Start Hidden to open the display with the labels off.

Wind turbines with labels showing asset name, attribute names, and values

Color markers and labels by limits

Use this when operators must see at once which locations are low, normal, or high.

  1. Right-click the symbol and select Configure Multi-State....
  2. In Current Attributes, select the attribute (1), for example Value 1.
  3. Select Enable Multi-State (2). The attribute's limits and their colors (3) appear under States.
  4. Right-click the symbol, select Configure Map..., and open Series.
  5. Next to Color (1), select Attribute. In the list below (2), select the same attribute.
Multi-State pane with the attribute list, Enable Multi-State, and the state colors marked
Series group with Color set to Attribute and the attribute Value 1 selected

The marker and the label background take the color of the state that the current value falls into.

City labels colored white for a low value and cyan for a high value

Group nearby markers into clusters

Use this when many assets lie close together and their markers and labels overlap at the zoom level you need.

  1. Open Clustering.
  2. Set Enabled (1) to ON.
  3. Raise Threshold (2) to group more markers, or lower it to group fewer.
  4. In Aggregation (3), select how the cluster's values are calculated: Mean, Min, Max, Sum, or Count.
  5. In Symbol (4), select a different marker for clusters, so that they differ from single assets.
Clustering group with Enabled, Threshold, Aggregation, and Symbol marked

Markers that are close together become one marker. With Asset on, its label reads, for example, "3 Assets (Mean)" and shows the aggregated values. Zoom in and the cluster splits into single assets.

Map with circle clusters labeled 2 Assets (Mean) and 3 Assets (Mean)

Add a view for a region

Use this when operators need to jump to a region in one click.

  1. Pan and zoom the map to the region.
  2. Open Views and select Add View (1). A view named New View appears with the current map section.
  3. Enter a name for the view (2).
  4. To change a view later, move the map and select Apply Current View (3) on that row.
  5. To set the section the display opens with, set Default View to Saved View, move the map, and select Save Current View.
Views group with a new view named Asia and the Add View, name, and Apply Current View controls marked

A button with the view name appears at the bottom right of the map. Selecting it moves the map to that section and highlights the button. The home button at the top right returns to the default view.

Map showing Asia after the Asia view button was selected

Open a trend when an operator clicks an asset

Use this when operators should see the history of a location without leaving the display.

  1. Open Asset Selection.
  2. Check that Enabled (1) is ON.
  3. In Action (2), select Quick Trend (Dialog).
Asset Selection group with Enabled on and Action set to Quick Trend (Dialog)

Select a marker. A trend dialog opens with the asset name as the title and one trace for each visible attribute, over the display time range.

Quick trend dialog for turbine 14 with Speed and Power traces

Other actions: Filter publishes the asset to other symbols (see Filtering dashboards). Ad Hoc Chart (Window) opens the values in an ad hoc chart window. Set asset context swaps the asset context of the display to the clicked asset, so that symbols relative to the context follow. Open Hyperlink opens a display or URL, with the asset path appended for a custom link.

Use the symbol

Map+ with numbered callouts
What it shows
(1)A marker at the asset's location. Its shape, color, and size come from the series settings, for example the status or a limit state.
(2)The label: asset name, then the values of the visible attributes. A colored dot beside a value shows that attribute's state.
(3)Shows or hides all data labels.
(4)Returns the map to the default view.
(5)Zooms in and out. You can also scroll, and drag the map to pan.
(6)The view buttons. The highlighted button is the view that was selected last.
  • Click a marker to run the configured action. Selecting a cluster applies the action to all assets in it.
  • Hover a marker to see a tooltip with the asset name and the value of each visible attribute, with its state color.
  • Values: labels show the value at the end of the display time range, unless the attribute is set to a calculation over the range.
  • Auto View Cycling: when it is on, the map moves through the views by itself. Start or stop it with the button at the top right. Clicking a view button, or pressing the mouse on the map, stops it.
  • Edit mode: the map does not respond while the display is in edit mode. It shows "Exit edit mode to interact with the map".
  • No assets: a search without results shows "No assets were found. Modify the search criteria."
  • Writes: viewing never writes data. Panning and zooming are not saved. A click action that sets the asset context or publishes a filter changes other symbols on the display. Only Save in the Assets section of the pane writes to the PI System (see Assets).

Configure the symbol

Right-click the symbol and select Configure Map.... Groups appear in this order.

Map

SettingWhat it does
ProviderSelects the base map provider: Open Street Map, Open Topo Map, Arc GIS (Esri), or Map Box. Used in Choose a base map.
StyleSelects the look of the base map. Arc GIS (Esri) offers World Street Map, World Imagery, World Topographic, World Gray Canvas, and National Geographic. Map Box offers Streets, Satellite, Outdoors, Light, and Dark.
Access TokenHolds your own token. Available when the provider requires one (Map Box).

Series

SettingWhat it does
SymbolAttribute takes the marker shape from the attribute you select. In the Attributes section, an attribute with states can map each state to a shape. Custom uses one shape for all assets: circle, square, triangle, diamond, pin, arrow, or none.
DirectionRotates arrow markers by the value of the attribute you select, for example a wind direction. Available when the marker is an arrow.
ColorAttribute takes the color from the attribute you select (its state color when multi-state is on, otherwise its color in the Attributes section). Custom uses one color. Used in Color markers and labels by limits.
SizeAttribute takes the size from the attribute you select. Custom sets one size in pixels.
Border, Show No DataBorder draws an outline in a color and width you choose. Show No Data keeps markers whose values are bad or missing.

Data Labels

SettingWhat it does
Show, Value, Background, Font SizeShow or hide the labels and their values or background, and set the text size.
Name, Asset, TimeAdd the attribute name, the asset name, or the timestamp. Used in Show names and values in the labels.
Start HiddenOpens the display with the labels hidden. Operators show them with the eye button.
PositionAuto places labels to avoid overlap. Custom places each label on one side of its marker. Fixed places each label at an offset that you set per asset in the Assets section. Fixed is available only when you added the assets by dragging.
DistanceSets the distance between marker and label.
LineDraws a line from label to marker. Adds a Width setting.

Tooltip and Legend

SettingWhat it does
Font Size (Tooltip)Sets the size of the hover tooltip text.
Enabled (Legend)Shows or hides a legend. Adds Position, Alignment, Size, and Color (Marker or Text).

Clustering

SettingWhat it does
Enabled, Threshold, Aggregation, SymbolGroup close markers and set how the group is built and drawn. Used in Group nearby markers into clusters.
Dynamic Size, FactorMake a cluster marker larger than a single marker, by the factor you set.

Views

SettingWhat it does
Default ViewFit to Assets fits the map to all assets. Saved View opens the section you saved with Save Current View.
Home ButtonShows or hides the home button.
Views listAdds, renames, applies, and deletes views. Used in Add a view for a region.
Auto View CyclingMoves through the views by itself. Adds Start on Load, Time per View [s] (the pause at each view), Animate, Transition Time [s] (the travel time, when animating), and Buttons (shows the view buttons).

Asset Selection

SettingWhat it does
EnabledTurns the click action on or off.
ActionSelects what a click does: Filter, Quick Trend (Dialog), Ad Hoc Chart (Window), Set asset context, or Open Hyperlink. Used in Open a trend when an operator clicks an asset.
Link type, Search for Displays, New TabFor Open Hyperlink. The first selector (labeled Color in the pane) chooses Custom, which opens a display or URL with the asset path appended, or Attribute, which reads the URL from an attribute. New Tab opens the link in a new tab.

Filtering

SettingWhat it does
Filter IndicatorShows the active filter as Compact, Full, or Hidden.
Ignore MasterIgnores asset filters from other symbols.
Linked Inputs, Linked OutputsConnect the map to other symbols through named channels. Outputs need the Filter action. See Filtering dashboards.

Attributes

Select an attribute in the list, then set:

SettingWhat it does
ValueCurrent shows the value at the end of the display time range. The other choices calculate over the range: Total, Average, Minimum, Maximum, Range, Standard Deviation, Population StdDev, Count, and Percent Good.
Basis, Boundary TypeBasis selects Time Weighted or Event Weighted for a calculated value. Boundary Type (Inside or Outside) is available for Event Weighted.
Hidden MeasureRemoves the attribute from labels, tooltips, trends, and from color, size, symbol, and direction.
HiddenLeaves the attribute out of labels and tooltips. It can still drive color, size, symbol, and direction.
Color, Size, Symbol, OpacityStyle the marker. Size is Relative (scaled by the value within a Range of Auto, Database, or Custom limits) or Fixed. Each setting applies when the Series group takes that property from this attribute. A multi-state color overrides Color.

Lines

SettingWhat it does
Line listAdds, copies, and removes route lines between two assets.
Name, Start, EndName the line and select its two assets.
Size, Opacity, StyleSet the width, transparency, and Solid, Dash, or Dotted line.
Value, TypeValue selects the attribute. Type selects how the line's value is calculated from its two assets: Difference, Mean, Sum, Start, or End.
ColorCustom uses one color. Value takes the color from the line's value.
Data Labels, TooltipShow a label or tooltip on the line.

Assets

Available when you added the assets by dragging, not by a search.

SettingWhat it does
Asset listLists the assets on the map.
Longitude, LatitudeShow the asset's coordinates. An asset without location attributes shows "Longitude and Latitude traits not configured".
Edit, Save, CancelEdit lets you select a point on the map. Save writes the new coordinates to the asset's Longitude and Latitude attributes in the PI System, for everyone. Cancel discards the change.
Label offset (X, Y)Positions the asset's label. Available when Position is Fixed.

Map Files

SettingWhat it does
File list, upload, deleteAdds or removes a .kml, .gpx, or .geojson file, drawn as an overlay.
Show, Color, Width, OpacityShow the overlay and set its default line style. Styles inside the file take priority.

Style

SettingWhat it does
ThemeSelects the color theme. Custom Theme adds Foreground and Background colors.
Surface, Container StyleSelect Flat or Gradient fill and the frame around the symbol.
Apply to all symbolsCopies the theme, surface, and container style to every other Vision Library+ symbol on the display.

Troubleshooting and limitations

SymptomCauseWhat to do
The base map is blank or gray.The browser cannot reach the tile server, or the provider does not serve tiles.Check network access to the provider. Select Open Street Map or Arc GIS (Esri).
The map is covered by an "API KEY REQUIRED" watermark, or no tiles load.The map uses Carto, which does not serve anonymous tile requests.Select Open Street Map or Arc GIS (Esri), or use Map Box with your own access token.
An asset has no marker.Its Longitude or Latitude trait is missing, has no good value at the display end time, or is out of range.Check the traits in PI System Explorer. In the Assets section, the asset shows "Longitude and Latitude traits not configured".
An asset sits at latitude 0 and longitude 0, in the Atlantic off Africa.Its location attributes hold 0.Correct the values, or use Edit in the Assets section.
The map shows "No assets were found. Modify the search criteria."The search returns no asset.Open Search Criteria and change Search Root or Asset Type.
The map does not pan, zoom, or react to a click.The display is in edit mode, or Asset Selection is off.Exit edit mode. Check Enabled in Asset Selection.
Labels overlap.Many assets are close together.Zoom in, turn on Clustering, reduce Font Size, or hide the labels with the eye button.
The map keeps moving.Auto View Cycling is on.Press the mouse on the map or select a view button to stop it, or turn the setting off.
Fixed is not available for Position.The assets come from a search.Use Auto or Custom, or add the assets by dragging.

Limitation: Map+ draws one point for each asset, at the location it has at the end of the display time range.

Limitation: The base map comes from a third-party server. Availability, terms of use, and usage limits depend on the provider.