03 Display Groups

Introduction

A list of pre-configured displays can be configured in the Display groups. When available on the file system, the name of the XML file is for example:

DisplayGroups 1.00 default.xml

DisplayGroups                              Fixed file name for the explorer settings

1.00                                            Version number

default                                         Flag to indicate the version is the default configuration (otherwise omitted).

The pre-configured displays are organised in a tree view in the time series display (see example in Figure 1). Each pre-configured display is identified by its name, and may include one or more subplots, each with one or more time series lines.

Figure 1 Example of time series display, showing two sub-plots and tree-view of pre-configured displays

Another option is to plot a longitudinal profile in the time series display (see figure 2). The main difference with the normal time series plot is, that on the X-axis the river chainage is plotted. With the control toolbar a specific time step can be selected.

Figure 2 Example of time series display, showing longitudinal profile.

The display groups are configured by first listing the names of the filters to be shown in the display (for example "Rain gauges", "Gauges" and "Fractions" in figure 3 below) under the displayGroup descriptor. The names of the subplots can then be added (e.g. "MacRitchie" and "Woodleigh" below). Each of the subplots is assigned a plotId which links to the definitions of the plots and the time series set to be used. For example in the Fractions displayGroup a stackPlot is defined with a max and min (this file is attached as an example). Please note that the colours, linestyle, precision etc are defined in the TimeSeriesDisplayConfig.

figure 3 - example of a configured displayGroup file (click to enlarge)

Figure 4 Root element of the display groups definition

displayGroups

Root element for each displayGroup. A display group forms one of the main nodes in the tree view and may contain multiple displays. Multiple display groups may be defined.

Attributes;

• description: Optional description
• plot: Plot complex type
• displayGroup: displayGroup complex type

plot

Defines the plots relating to the displayGroup

Attributes;

• description: Description of plot
• legendFontSize: Font size of legend
• axis TitleFontSize: Title font size
• tickLableFontSize: Option to change tick label font size
• subplot: Link to subplot complex type.

displayGroup

Defines the groups of plots to be viewed (i.e. the branches of the shortcuts in the display)

Attributes;

• description: Optional description
• display: Display complex type
• displayGroup: displayGroup which links to the plot id

subplot

Root element for each subplot. Multiple sub-plots may be defined per display.

Attributes;

• description
• axisScaleUnit
• lowerMarginPercentage:
• upperMarginPercentage:
• thresholdAxisScaling
• forecastConfidenceTimeSpan: TimeSpanComplexType
• area: SubPlotAreaComplexType. Displays the extent of multiple time series as a single area
• color: Overides colours specified in the timeseriesdiplay
• lineSytle: Line style of time series marker line. Enumeration of "solid", "none", "bar", "dashdot", "dashed", "dotted".
• timeSeriesSet  

display

Definition of a pre-configured display. Each display may contain multiple sub-plots. Multiple displays may be defined per display group.
[

Figure 4 Elements in the Display section of the DisplayGroups configuration

Attributes;

• description: Optional description
• relativeViewPeriod
• nrOfRecentForecasts: Can be applied to show multiple recent forecasts (simulated forecast type)
• ParentLocationId:
• ThresholdLocationSetId:
• plotId: Link to the plot id

SubPlotArea

Options available when creating an area type display

Atrributes;

• color: Overides other predefined colours
• opaquenessPercentage: Opaqueness expressed as a percentage
• IncludesZeros: When true the zero is always included in the painted extent