Graphical Encoding and Spatial Report

Mel Meng
4 min readNov 3, 2020

source: Innovyze Support Portal

Present modeling results in maps with symbols and labels is an important task for any modeling projects.

For large models and professional quality figures with unique branding and looks, exporting the modeling results into a GIS package will be needed for the finer touches.

However, for small projects and a quick check of the modeling results, the overhead of exporting results to GIS is simply too high and XPSWMM has all the tools you’ll need to style the map and label the maps with just a few clicks.

To change the symbols of nodes and links, we’ll use the graphical encoding tool, and for advanced labeling, we’ll use the spatial report tool.

You can download the sample models for graphical encoding and spatial report on GitHub.

These tools can be accessed on the toolbar and in the layer tree.

Graphical Encoding

Graphical encoding styles the nodes and links based on the object’s attribute values. To start the Graphical encoding window, we can either right click on the “Graphical Encoding” tree item or click on the icon in the toolbar.

Each row in the window controls one aspect of the symbol. For example, the first row is for node color.

To set the node color symbols,

1. Select a variable to show, the freeboard

2. Click on the node color to set the color ramp

3. Use the suggest button to automatically get a range

4. Modify if needed the color and range

5. Click OK to finish

To add a legend,

1. click on the legend button.

2. Change the title

3. Select a background

4. Pick the location on the screen

5. Click OK

Spatial Report

For advanced labeling, we use the spatial report tool, which is an addition to the link and node labeling. Spatial report tags have leader lines to the object.

To start the spatial report window, we can either right click on the “Spatial Report” tree item or click on the icon in the toolbar.

As shown in the report attributes window, we define the attributes/variables, and the look of the “tag”/frame for links and nodes.

Setup the spatial report

And for the variables, we also define its label/Mnemonic and unit in the variable list window.

Once the tags (spatial report) are created, we can adjust the location by moving the tags.

We can also define the behavior how the tags are turned on or off by right click on the Spatial reports tree items.

For example, if “Show Spatial Reports as Tooltip” is selected, only when we hover the mouse on the object the tag will show. This can be great when interactively checking the modeling results.

Quick Data View

In addition to the spatial report, we can also use “Quick data view” to show attributes of the selected model element in its own window. To show the attribute table, click on the icon on the toolbar.

We can change the default table for node, link, and how multi-link should be displayed in the attributes window.

--

--