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

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:
• inverted
• plotweight
• thresholdAxisScaling
• forecastConfidenceTimeSpan: TimeSpanComplexType
• line
• area: Fills the area between multiple time series.
• color: Overides colours specified in the timeseriesdiplay
• lineSytle: Line style of time series marker line. Enumeration of "solid", "none", "bar", "dashdot", "dashed", "dotted".
• timeSeriesSet 

Vertical line fill

Use the <area> element in combination with a <lineStyle> to obtain vertical lines.

<subplot>
     <area>
        <lineStyle>solid</lineStyle>
        <lineWidth>10</lineWidth>
         <color>blue</color>
         <opaquenessPercentage>50</opaquenessPercentage>
           <timeSeriesSet>
                <moduleInstanceId>ImportMSW</moduleInstanceId>
                <valueType>scalar</valueType>
                <parameterId>Q.m</parameterId>
                <locationId>H-MS-LUIK</locationId>
                <locationId>H-MS-SINT</locationId>
                <timeSeriesType>external historical</timeSeriesType>
                <timeStep unit="hour"/>
                <relativeViewPeriod unit="day" start="-2" end="0"/>
                <readWriteMode>read only</readWriteMode>
           </timeSeriesSet>
        </area>
</subplot>

inverted

This tag can be used to invert the y-axis of a plot. Below a screenshot of an inverted graph. In the example the timeseries with parameter RAIM is inverted.

line

The tag line can be used to configure options like:

• dual y-axis plots
• discharge/stage-plots or stage/discharge plots

Dual y-axis plots

It is possible to display a set of time series with two different parameters types in one plots. One parameter will be displayed on the left axis, the other will be displayed on the right axis.

Below an example of a dual y-axis plot.

Below an example of how to configure a timeseries which should be displayed on the right y-axis.

<subplot>
			<plotWeight>2</plotWeight>
			<line>
			<color>blue</color>
			<axis>right</axis>
				<timeSeriesSet>
					<moduleInstanceSetId>MAP</moduleInstanceSetId>
					<valueType>scalar</valueType>
					<parameterId>MAP</parameterId>
					<locationId>LNDW1XU</locationId>
					<timeSeriesType>simulated forecasting</timeSeriesType>
					<timeStep unit="hour" multiplier="6"/>
					<readWriteMode>read only</readWriteMode>
				</timeSeriesSet>
			</line>
			<line>
			<color>dark orange</color>
			<axis>right</axis>
				<timeSeriesSet>
					<moduleInstanceSetId>MAP</moduleInstanceSetId>
					<valueType>scalar</valueType>
					<parameterId>MAP</parameterId>
					<locationId>LNDW1XM</locationId>
					<timeSeriesType>simulated forecasting</timeSeriesType>
					<timeStep unit="hour" multiplier="6"/>
					<readWriteMode>read only</readWriteMode>
				</timeSeriesSet>
			</line>

In setting the axis to right this timeseries will be displayed at the right axis instead of the (default) left axis.

Stage/discharge plots

When a discharge is displayed, it is possible to show the stage on the right axis.

The right axis is then not a linear axis but the ticks on the right axis are calculated from the discharge ticks on the left axis.

It is also possible to display the stage and show the discharge on the right axis. The example below shows a display which plots several discharge time series.

The left axis is a linear axis with ticks for the discharge. The right axis is a non-linear axis.

The ticks on the right axis are calculated from the value of the discharge on the left axis by using a rating curve.

Below a configuration example

<subplot>
	<plotWeight>5</plotWeight>
	<line>
		<axis>left</axis>
		<ratingAxis>
		<parameterGroupId>Level</parameterGroupId>
		<transformationType>dischargeStage</transformationType>
		<ratingCurve>
			<locationId>exampleId</locationId>
		</ratingCurve>
		</ratingAxis>
		<timeSeriesSet>
			<moduleInstanceId>STAGEQ_LEDC2_LEDC2R_Forecast</moduleInstanceId>
			<valueType>scalar</valueType>
			<parameterId>QIN</parameterId>
			<locationId>LEDC2R</locationId>
			<timeSeriesType>simulated forecasting</timeSeriesType>
			<timeStep unit="hour" multiplier="6"/>
			<readWriteMode>read only</readWriteMode>
			<ensembleId>QPF</ensembleId>
		</timeSeriesSet>
</line>

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 or season
• nrOfRecentForecasts: Can be applied to show multiple recent forecasts (simulated forecast type)
• ParentLocationId:
• ThresholdLocationSetId:
• plotId: Link to the plot id

Normally, displays are defined with a relative view period, so that the view window progresses with current system time.
This paradigm does not fit systems that are more oriented towards seasonal or water year analysis. Therefore an option has been added since 2011.02 to define a season, such that the time axis is fixed, while the vertical red line (current system time) moves over time from left to right through the display.
To utilize this functionality, a season should be defined instead of a relative view period. This season specification if composed of a start and end date, as well an entry called 'startForwardLookingPeriod'.
The software compares the currentSystemTime against the date specified in the 'startForwardLookingPeriod' entry, to decide if the time axis needs to shift to the next year/season. This decision is relevant within a water supply forecasting context since a few weeks before the end of the water year you may like to look forward to the next wateryear instead of the current wateryear.

E.g. in the code example below, a wateryear is defined from 1st of October to 30th of September. The startForwardLookingPeriod is defined as 1st of September.

<display name="SELI1 - Selway R nr Lowell - SWE">
	<startForwardLookingPeriod>--09-01</startForwardLookingPeriod>
	<season>
		<startMonthDay>--10-01</startMonthDay>
		<endMonthDay>--09-30</endMonthDay>
	</season>
	<locationId>SELI1L</locationId>
	<locationId>SELI1U</locationId>
	<plotId>SWE</plotId>
</display>

The associated display looks like:

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