Skip to main content

Group Content Bar Template

Overview and Key Concepts​

This template creates a bar chart. The specified objects are divided into groups, and each group is represented by a bar. The length of the bar is determined by the total current flow (or bulk) content of the objects in the group.

Chart Types​

This section describes the Bar Template. The Group Content can be visualized using the following chart templates:

  • Bar chart (current value)
  • Table (current value)
  • Line chart (history vs. time)

The Options Tab​

The Options tab has the following properties:

  • Objects - Specifies the objects to include on the chart. See Adding Objects for more information.
  • Type Label - Defines the group for each of the objects. All objects with the same Type Label will be summed and shown as a single group. The dropdown for this option contains a few default options; you can write your own expression here using current to refer to each object in turn. Each object separately - Put each object into its own group. This effectively reduces the Group Content Bar chart to a regular Content Bar chart.
  • Product type - Create a group for each product type. All objects with the same product type will be summed. When you change the product type of an object, it will be automatically removed from one group and added to the group of the new product type.
  • Container object - Create a group based on the object's container object. This option is particularly useful if you have a container object, such as a Visual Tool, containing multiple tanks, and if you want to show the content of each tank pool in the model.
  • Value Type - Determines how the "Type Label" of each group will be shown in the chart. You can select the following combinations: Number (Raw) - The Type Label of the group will be shown as-is. You would use this option when the type label is a product type number or a numeric label value that segregates the objects into groups.
  • Number (Object) - The Type Label of the group is a number that corresponds to an object ID. You would use this option when the Type Label corresponds to an object in the model, such as the predefined option Container object which sets the group label to StatisticsCollector.getID( current.up ).
  • String (Raw) - The group label is a text, for example a product name or name of an object in the model. Note that instead of using object names or paths (such as current.getPath()) it is preferrable to use an object path using the StatisticsCollector.getID function.

The Settings Tab​

The Settings tab is identical to the Bar Settings tab. For more information, see Bar Settings.

The Text Tab​

The Text tab is identical to the Bar Text tab. For more information, see Bar Text.

The Colors Tab​

The Colors tab is identical to the Bar Colors tab. For more information, see Bar Colors.

The Advanced Tab​

This template, like all templates, uses the Advanced Tab. For more information, see Advanced Tab.