Label Options

The Label Options feature allows the user to define how labels are displayed for model elements shown on the Map View. This includes selecting which attributes appear in each label, defining the field order and separator, and selecting the font, color, border, and other visual label settings. Label settings are defined separately for each element type, allowing each model element type to use its own independent label design.

To use the Label Options feature, follow the steps below:

1. In the Map Data Layers panel, click the […] button next to the model definition layer.
   
2. The Layer Properties dialog box will be displayed.
   
3. Select the Label Options tab.
   

The following sections describe how to use the Label Options tab and interact with the above dialog box.

Selecting Element

The Select Element section allows the user to select the element type for which the label setting will be defined. Based on the selected element type, the software updates the available label fields, preset list, and live preview.

The following entry is available in this section:

• Element type
  This dropdown combo box allows the user to select the model element type whose labels are being defined. The following element types are available in the dropdown combo box:
  

1. 1. Drainage Subbasins
   2. Manhole Structures
   3. Routing Junctions
   4. Terminal Outfalls
   5. Stormwater Pipes
   6. Routing Reaches
   7. Roadway Gutters/Ditches/Inlets
   8. Roadway Crossings
   9. Storage Areas
   10. Cross Sections
   11. Flow Paths
   12. Rain Gages
   13. LID Structures

Selecting Preset

The Select Preset section allows the user to apply a saved combination of label fields to the selected element type. Presets allow the user to quickly switch between common label settings without manually re-checking each field.

The following options are available in this section:

• Preset
  This dropdown combo box lists the available label presets for the currently selected element type. The dropdown combo box contains two groups: built-in presets and custom presets. Built-in presets are hardcoded and cannot be edited or deleted, while custom presets are saved by the user. Selecting a preset immediately updates the Select Fields to Display checklist and the live preview.
• Save as
  This text input field allows the user to enter a name for a custom preset. The user types a unique preset name and clicks the [Save] button to add the current field selection as a custom preset for the currently selected element type. Note that custom preset names must be unique within each element type. If the entered name duplicates an existing preset, the [Save] button remains disabled.
• Save Button
  This button saves the current field selection and separator as a custom preset using the name entered in the Save as field. The new preset is added to the custom group of the Preset dropdown combo box and is automatically selected.
  Custom presets saved by the user are displayed below the built-in presets in the Preset dropdown combo box. Note that a delete icon (×) is displayed on the right side of each custom preset name. Clicking this icon deletes the custom preset for the currently selected element type. Built-in presets do not display a delete icon and cannot be deleted.

For example, in the image below, Custom Fields is a user-created custom preset with a delete icon (×) displayed on the right side of the preset name.

Selecting Fields to Display

The Select Fields to Display section allows the user to turn individual element attributes on or off and assign optional text prefixes to each selected field.

The following options are available in this section:

• Clear
  This button is used to uncheck all fields in the checklist at once.
• Field checkboxes
  Each row in the checklist represents one labelable attribute for the element type selected in the Select Element section. Checking the checkbox adds that attribute to the label. A sample value is displayed next to each field name as a quick reference for the field’s data type.
• Prefix
  This text input field next to each attribute allows the user to add a short label before the field value. For example, entering Diameter: in the Prefix box for the Diameter field produces a label segment such as Diameter: 24 in. Prefix text is optional. Fields with an empty prefix box are labeled using the field value only.

Note: For drainage subbasins, the list of available fields is dynamic. Changing the hydrology method automatically updates the checklist to show only the fields that are valid for that method. For example, SCS TR-55 fields are replaced with EPA SWMM fields when the hydrology method is switched.

Selecting Label Format

The Select Label Format section allows the user to define the visual appearance of the labels generated for the selected element type, including the separator used between multiple field values, font size, font color, border color, and label offset.

The following options are available in this section:

• Separator
  This checkbox option contains a group of buttons used to select the separator that appears between field values when two or more fields are selected. Three options are available: Pipe (|), Comma (,), and Slash (/). Only one separator can be selected at a time. By default, the pipe separator is selected.
• Label auto scaling
  This checkbox option is used to enable or disable automatic scaling of label size based on the Map View zoom level. When checked, the software adjusts the label size as the user zooms in or out. When unchecked, labels are displayed using the exact font size specified.
• Font size
  This spin control entry field is used to set the size of the label text. The default value is 10 pt.
• Font color
  This dropdown color palette is used to change the color of the label text. The user should select a color that contrasts with the Map View background and any underlying imagery.
• Label offset
  This spin control entry field is used to set the distance between the label and the element it describes. The default value is 2 px.
• Border color
  This dropdown color palette is used to change the color of the border drawn around each label.

Preview

The Preview section shows how the label will appear for the selected element type using representative example values. The preview updates immediately when the user changes the selected fields—separator, font size, font color, border color, or label offset. This allows the user to review and confirm the label appearance before applying it to the Map View.