OpenBuildings™ Station Designer Help

Thematic Maps Legend builder

A secondary dialog to the Thematic Maps dialog, the Thematic Maps Legend builder contains controls used to configure the appearance and information displayed on Thematic Map legends.



Opens when selecting entries from the Legend column in the Thematic Maps dialog's searches pane.

SettingDescription
Summary

The Summary field is where the legend expression is keyed in. The expression may be a simple string displayed for the particular legend item or it may contain more sophisticated expressions built using functions and properties selected from the two pick lists in the Add new expression portion of the dialog.

Note: By default, summary expressions are the name of the selected class.

Add new expression

Options available here are used to build a Legend Expression. The summary field is updated as expression components are added. Refresh the legend to view changes.

  • Function — The table describes and provides an example of the available legend function expressions.

    Function Description & Format

    Example

    Count – Returns a total count of found instances.

    Format: $count$

    Number of occupied rooms – $count$



    Sum – Adds the values of a specific property for all found instances.

    Format: $sum([Property Name])$

    Total area of occupied rooms - $sum(Actual area)$



    Average – Calculates the average of a specific property for all found instances.

    Format: $average([Property Name])$

    Average area of occupied rooms - $average(Actual area)$



    Min – Returns the minimum value of a specific property for all found instances.

    Format: $min([Property Name])$

    Minimum area of occupied rooms - $min(Actual area)$



    Max – Returns the maximum value of a specific property for all found instances.

    Format: $min([Property Name])$

    Maximum area of occupied rooms - $max(Actual area)$

    If a search definition searches for all rooms with the “area classification” property equaling “Office space”, this expression would show a legend item that displays the area size of the largest office room found on the floor



    Value – Displays the value of a specific property for all found instances. If the values are different, **varies** is displayed. The value function is primarily used with the auto iterateoperator.

    Format: $value([Property Name])$

    Room type - $value(Usage)$



  • Property — Used to select the property to act upon when creating expressions.
  • Expression — This read only field previews the expression being considered.
  • Add — Click to add the expression to the Summary.
OK

Click OK to accept the new legend expression.

CAUTION: OK must be clicked before moving the focus away from the Thematic Maps dialog (switching to another application window for instance). Otherwise, changes are not saved as the Thematic Map Legend builder is a context sensitive dialog.