Customize Branch Display Settings

This guide explains how to customize the branch display settings to show the results of branch properties on the map window. SAInt allows to display many branch properties, and to visualize the results of a simulation at the branch level using the branch legend. A user can personalize the branch legend from the settings using colors and number of classes. How to add a new class, edit the colors and display the branch legend are explained in this guide. A gas network is used in the examples. However, the same method can be used for all energy networks (electric, thermal, etc.).

1. STEP 1: Access the branch legend color setting window

Open the network and a solved scenario (e.g., network GNET29_18 and scenario "STE_0_wT"). Click on the three dots button at the bottom right of the map display settings to access the branch display settings window, as shown by the mouse pointer in Figure 1.

Make sure to duplicate the selection of the options of the "Layers Window" and "Map Display Settings" (i.e., checked boxes and blue border for the icons) to replicate Figure 1. Remember to active "Turn On/Off Network Legend Settings" (i.e., the icon on the left of the three dots button) to visualize the branch legend in the remaining steps.

The "Map Legend Settings" window can also be accessed by clicking on the Home button of SAInt and selecting "Settings" from the context menu.

branch display setting 00
Figure 1. How to access the branch legend color settings from the map display settings.

Alternatively, from the general settings of SAInt (i.e., blue button on the top-left side of the main window) select the tab "Color Legend". From there, select the tab "Branch" to access the branch color legend settings (i.e., see Figure 2).

branch display setting 01
Figure 2. "Color Legend" tab of the main settings window of SAInt for branches. The user can access the tab "Branch" to modify the branch settings and the "color values".

2. STEP 2: Define the branch settings

The "Branch Settings" of the color legend tab allows to specify the network type, the branch parameter and the unit of measure to be used in the legend means of drop-down menus. Select "Gas" in "Network", "Q(PipelineFlowRate)" in "Parameter", and "Megawatt-[MW]" in "unit", as shown in Figure 2.

If the "Color Value" box under "Automatic" is activated, SAInt uses the five default classes and colors. When clicking on the button Apply, the branch legend is updated and now represents the flow in the branches using the default colors across the five classes. Otherwise, the results are displayed in one color.

Changes to the legend settings are visualized only if the same property is selected in the settings and in the "Map Display Settings".

3. STEP 3: Change the branch filling color

The user can change the filling color of the branches for the selected class by opening the "Color Dialog" window from the three dots symbol available when clicking on the existing color (Figure 3). Select the colors for the different classes with the "Web" tab of the "Color dialog". Use the colors "Dark Blue", "Dark Green", "Gold", "Peru" and "Dark Red" for the classes.

branch display setting 02
Figure 3. Opening the "Color Dialog" window from the "Color Values" section by clicking on the three dots symbol after selecting the color cell.

4. STEP 4: Change the number of classes and personalize the ranges

SAInt allows the user to add new classes and define specific ranges for each class. Click on Add new row to add a new class. To define the values range of the classes the user can enter the "Value From" and "To Value".

The cells "Value From" and "To Value" are active only if the box "Color Values" for the option "Automatic" in the "Node Settings" section is unchecked. Otherwise, SAInt will use equal ranges.

The first and last class will have the "Value From" and "To Value" fixed to the minimum and maximum of the value of the property, respectively. These are automatically computed by SAInt and cannot be changed by the user. For the other classes, the "Value From" of one class sets the "To Value" of the previous.

A new class is easily added by clicking on the row "Add new row". Add a new class with the color "Aqua" and set the values as shown in Figure 4.

branch display setting 03
Figure 4. How to add a class and specify the range of each class for a branch legend.
branch display setting 04
Figure 5. Example of a extended and personalized branch legend for the property Q (PipelineFlowRate) for a steady scenario of a gas network.