What |
DisplayGroups.xml |
---|---|
Config group |
SystemConfigFiles |
Required |
no |
Description |
Defines pre-configured displays |
schema location |
Still to document TimeSpanComplexType
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: 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
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.
<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
- 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
Making stacked graphs
Since 2007/02 release the functionality of the SubPlotArea complex type has been extended to include stack plots. The only thing needed to implement this is to add a stackPlot="true" attribute to a subplot element. Attached to this page is a example of this funtionality.
If stackPlot is True, the timeseries of this subplot are plotted as stacked areas, except for the timeseries that are specified inside the (optional) element <area>. Area-series are always plotted as so called 'difference area'.
Attribute stackPlot is intended as overruling of the default series paint (i.e. line or bar)
It is not possible to combine 'stacked areas' and lines/bars in one plot.
Display groups may be defined while DELFT-FEWS is running and reloaded by re-opening the time series dialogue. If a mistake is made, then the shortcuts item to open the tree view will not appear and an appropriate message will be generated. After resolving the mistake the item will again become available on re-loading the display.