...
Attributes: name and id
Elements:
- description: Optional descriptiondisplay:
- nodeId
- viewPermission
- editPermission
- locationLoop
- types of display
- display
- singleLocationDisplays
- singleParentLocationDisplays
- displayGroup: displayGroup which links to the plot id
- displayGroupId
plot
plot: Defines the plots relating to the displayGroup
Each diplayGroup gets 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.
Attribute: id
Elements:
- description: Description of plot
- legendFontSize: Font size of legend
- axis TitleFontSize: Title font size
- tickLableFontSize: to change tick label font size
- tickTimeStep: to tie ticks to a time step (since 2018.02)
- synchronizeParameterAxis: to synchronize the axis range of subplots displaying time series for the same parameter group (since 2018.02)
- visibilityGroup: defines order of the visibility groups in the drop down box (since 2019.02)
- subplot: Link to subplot complex type, see below for details
- plotViewerId & tableViewerId: to use alternative viewers for plot or tables
Figure 3 - example of a configured displayGroup file (click to enlarge)
Figure 4 Root element of the display groups definition
subplot (plot
...
)
Element of plot. Root element for each subplot. Multiple sub-plots may be defined per displayplot.
Subplot elements :
- description
- subPlotType
- axisLable, axisScaleUnit, lowerMarginPercentage, upperMarginPercentage
- leftAxis, rightAxis
- barMarginPercentage: Since 2018.02. Only applicable for subplots which contain bars, such as plots of <subPlotType> "horizontalColorCode" or bar charts. Percentage of the bar width by which the bar width will be reduced, to create space between the bars. Default value is the barMarginPercentage in the generalDisplayConfig of the TimeSeriesDisplayConfig.xml (which is 0 by default). Use the general option to set a barMarginPercentage to be applied to all plots containing bars. Use this config option to overrule the general barMarginPercentage for a specific subplot.
- inverted
- logarithmic
- drawingOrderInverted
- splitForDifferentRuns
- plotweight
- plotSeparatorWeight
- thresholdAxis
- thresholdAxisScaling
- forecastConfidenceTimeSpan
- line, with dual axis plot
- area Fills the area between multiple time series.
- clusteredBars
- variableLineWidth
- classBreaksId, classBreaks
- direction
- color Overides colors specified in the timeseriesdiplay
- lineStyle: Line style of time series marker line. Enumeration of "solid", "none", "bar", "dashdot", "dashed", "dotted". When a suffix of ";thick" is given, 1 will be added to the linewidth found in the TimeSeriesDisplayConfig.xml. For example, if a linewidth of 2 is configured in the TimeSeriesDisplayConfig and for a subplot the linestyle is set to "solid;thick", the resulting linewidth will be 2 + 1 = 3.
- markerStyle, markerText
- ratingAxis, lookupAxis, datumAxis
- visibleInLegend
- label
- visibleInTable
- visibleInPlot
- descriptiveFunction, with value and timeSpan
- timeSeriesSet, with chainage location set, single domain axis and dual domain axis
- additionalTimeSeries
Attributes:
- min (max is not implemented): set default minimum value for y-axis, which will be overruled by data that is below this value
- yAxisScalingType (since 2020.02): Default is scaleOutsideMinAndMax. If it is set to scaleOutsideMinAndMax, the y axis will scale to the data available. If it is set to fixedBetweenMinAndMax, the min and max of the y axis will always be the configured values, regardless of the data. This could make the entire data set fall of the visible chart. If all the data is in the middle of min and max withing a small range, the axis will scale to the data, it will appear as a small line in the middle. If it is set to scaleBetweenMinAndMax, the min will never be smaller than what is configured, and the max will never be greater than configured, but if the available data falls between these values, the axis will scale so that the data fills the whole area. If the data falls entirely outside of min and max, it will not be visible.
- convertDatum
stackPlot - deprecated since 2014.02
...
Attributes:
- min (max is not implemented): set default minimum value for y-axis, which will be overruled by data that is below this value
- yAxisScalingType (since 2020.02): Default is scaleOutsideMinAndMax. If it is set to scaleOutsideMinAndMax, the y axis will scale to the data available. If it is set to fixedBetweenMinAndMax, the min and max of the y axis will always be the configured values, regardless of the data. This could make the entire data set fall of the visible chart. If all the data is in the middle of min and max withing a small range, the axis will scale to the data, it will appear as a small line in the middle. If it is set to scaleBetweenMinAndMax, the min will never be smaller than what is configured, and the max will never be greater than configured, but if the available data falls between these values, the axis will scale so that the data fills the whole area. If the data falls entirely outside of min and max, it will not be visible.
- convertDatum
stackPlot - deprecated since 2014.02
Elements :
- description
- subPlotType
- axisLable, axisScaleUnit, lowerMarginPercentage, upperMarginPercentage
- leftAxis, rightAxis
- barMarginPercentage: Since 2018.02. Only applicable for subplots which contain bars, such as plots of <subPlotType> "horizontalColorCode" or bar charts. Percentage of the bar width by which the bar width will be reduced, to create space between the bars. Default value is the barMarginPercentage in the generalDisplayConfig of the TimeSeriesDisplayConfig.xml (which is 0 by default). Use the general option to set a barMarginPercentage to be applied to all plots containing bars. Use this config option to overrule the general barMarginPercentage for a specific subplot.
- inverted
- logarithmic
- drawingOrderInverted
- splitForDifferentRuns
- plotweight
- plotSeparatorWeight
- thresholdAxis
- thresholdAxisScaling
- forecastConfidenceTimeSpan
- line, with dual axis plot
- area Fills the area between multiple time series.
- clusteredBars
- variableLineWidth
- classBreaksId, classBreaks
- direction
- color Overides colors specified in the timeseriesdiplay
- lineStyle: Line style of time series marker line. Enumeration of "solid", "none", "bar", "dashdot", "dashed", "dotted". When a suffix of ";thick" is given, 1 will be added to the linewidth found in the TimeSeriesDisplayConfig.xml. For example, if a linewidth of 2 is configured in the TimeSeriesDisplayConfig and for a subplot the linestyle is set to "solid;thick", the resulting linewidth will be 2 + 1 = 3.
- markerStyle, markerText
- ratingAxis, lookupAxis, datumAxis
- visibleInLegend
- label
- visibleInTable
- visibleInPlot
- descriptiveFunction, with value and timeSpan
- timeSeriesSet, with chainage location set, single domain axis and dual domain axis
- additionalTimeSeries
subPlotType (subplot)
By default the <subPlotType> is set to 'standard', which means the default plot type for the configured timeSeriesType will be used. Optionally, you can configure the following other subplot types.
...
|  |
|---|
leftAxis and rightAxis (subplot)
| Info |
|---|
2022.02 and later |
Use elements leftAxis and rightAxis to confiure the axes separately.If the rightAxis is configured, the leftAxis must be configured too.
...
If the optional attributes min and max are not configured, then subplot attributes min and max are used.
area for vertical line fill (subplot)
Use the <area> element in combination with a <lineStyle> to obtain vertical lines.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
<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 (subplot)
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.
logarithmic (subplot)
Available since 2020.02. If it is set to true, the subplot y-axis (or domain axis) will be logarithmic. A parameter can also be configured to always/never be displayed on a logarithmic scale, but the subplot setting has precedence. If a parameter is set logarithmic true, but the subplot it appears in is configured logarithmic-false, the axis will not be logarithmic. It is also possible to configure a mixture of logarithmic and non-logarithmic subplots in the same plot:
...
Logarithmic axis can also be turned on and off manually, using the menu bar. If you do so, the setting will effect all subplots the same way. Should you wish to reset the subplots to the configured version, use the reset domain axis to configured button.
clusteredBars (subplot)
This option makes it possible to cluster bars per timestep. A code example can be found here. This example shows how clustered bars are displayed:
drawingOrderInverted (subplot)
This option can be used to invert drawing order of the lines. By default the lines are drawn in the same order as shown in the legend : the first line first, the last line last. The last line is then on top. If drawing order is inverted the last line in the legend is drawn first and the first line last. The first line is then on top.
thresholdAxis (subplot)
Thresholds can be displayed on the left axis, or on the right axis, or on both. By default the thresholds are displayed on the left axis.
To change it, an option ‘ thresholdAxis’ can be used . Configure <thresholdAxis>right</thresholdAxis> if only the right axis should have thresholds, or <thresholdAxis>both</thresholdAxis> if both left and right axes should have thresholds
line (subplot)
The tag line can be used to configure both single or dual y-axis. Enables the configuration of a custom colour. visibleInLegend, visibleInPlot and visibleInTable are optional, default setting is true. If visibleInLegend is set to false, the series will show up in the plot area, but not in the legend. If visibleInTable is set to false, the time series can still be sen on the plot, but the data will not show in the table. If visibleInPlot is set to false, the time series can be still shown in the table, but will not be visible in the plot. VisibleInLegend, visibleInPlot and visibleInTable are supported by clustered bars too.
...
| Code Block | ||
|---|---|---|
| ||
<displayGroup name="bars">
<display name="clusteredBars">
<subplot>
<clusteredBars axis="left">
<bar>
<color>blue</color>
<visibleInLegend>false</visibleInLegend>
<visibleInPlot>false</visibleInPlot>
<timeSeriesSet>
<moduleInstanceId>Import</moduleInstanceId>
<valueType>scalar</valueType>
<parameterId>H.m</parameterId>
<locationId>LocA</locationId>
<timeSeriesType>external historical</timeSeriesType>
<timeStep unit="hour"/>
<relativeViewPeriod unit="hour" start="-12" end="12"/>
<readWriteMode>editing visible to all future task runs</readWriteMode>
</timeSeriesSet>
</bar>
<bar>
<color>red</color>
<visibleInTable>false</visibleInTable>
<label>Rated Discharge</label>
<timeSeriesSet>
<moduleInstanceId>Import</moduleInstanceId>
<valueType>scalar</valueType>
<parameterId>Q.m</parameterId>
<locationId>LocA</locationId>
<timeSeriesType>external historical</timeSeriesType>
<timeStep unit="hour"/>
<relativeViewPeriod unit="hour" start="-12" end="12"/>
<readWriteMode>editing visible to all future task runs</readWriteMode>
</timeSeriesSet>
</bar>
</clusteredBars>
</subplot>
</display> |
Dual y-axis plots (subplot)
It is possible to have two y-axis visible in the same plot. This can be done by having multiple timeseries where some are assigned to the left y axis and some to the right y axis, or by having a timeseries on the left y axis with an associated rating curve on the right y axis. So every timeseries plot (also in reports) will have a mandatory left y axis to which a timeseries is associated and an optional right y axis to which a timeseries or rating curve is associated.
The display of threshold lines are supported for one y axis. But there can be threshold lines for either the left or the right y axis, but not both.
Multiple TimeSeries plots (dual y-axis plot)
To associate a timeseries to the left or right y axis use the <axis> element. This element is optional and leaving it out will associate it (default) to the left axis. Please note that at least one timeseries should be on the left axis (by either settings <axis>left</axis> or leaving the element out and using the default).
...
|
| |||||||
|
|
Stage/discharge plots (dual y-axis plot)
When a discharge is displayed, it is possible to show the stage on the right axis. It is not possible to configure this rating on the left axis (and the timeseries on the right axis), since a plot has to have at least one timeseries on the left axis.
...
|
|
descriptiveFunctions (subplot)
Adding DescriptiveFunctions will result in an extra panel in the display, showing relevant descriptive information about the timeseries in view. More information on the descriptive functions available can be found at TimeSeriesDisplayConfiguration
VariableLineWidth (subplot)
Options available when creating an variable line width type display
...
- markerColor: option to set marker color different from line color
- lineWidthScaleFactor: factor to increase or decrease the line width
- valueTimeSeriesSet: Time series for XY line plot
- lineWidthTimeSeriesSet: Time series for line width of the XY plot lines
Example
Below a screenshot of a variable line width plot for different ensemble members that have different line width's. In this case line width is an indication of the probability of the ensemble member. The sum of probability of all ensemble members at a time is one. Selecting separate ensemble members will mark them with the color black.
...
Single location displays can be used to easily create plots for individual locations. This can either be done for individual locations, or alternatively for a locationSet which will then produce a list of location with their corresponding plot.
Chainage location set (subplot)
(Since 2016.02) By using a chainage location set in a time series set of a plot in the display groups, a longitudinal profile can be plot based on scalar time series for different locations
...
Notice that it is not possible to combine a longitudinal plot in with a standard plot (having time on the X-axis). Furthermore, it is not possible to use it for relatedLocations, and also thresholds will not be shown.
Single Domain Axis Time Series / 1D Spectra plots (subplot)
Time series with one domain axis are displayed as one xy chart per time step, like longitudinal profiles. A slider is used to navigate through time.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
<timeSeriesSet> <moduleInstanceId>LMW_Import_spectrum</moduleInstanceId> <valueType>scalar</valueType> <parameterId>Wave.variancedensity.meting</parameterId> <domainParameterId>f</domainParameterId> <locationSetId>LMW_Czz10</locationSetId> <timeSeriesType>external historical</timeSeriesType> <timeStep unit="minute" multiplier="60"/> <relativeViewPeriod unit="day" start="-2" end="2"/> <readWriteMode>read only</readWriteMode> </timeSeriesSet> |
Dual Domain Axis Time Series / 2D Polar Spectra plots (subplot)
When a second domain axis is available this will always be used as direction for a polor plot by the time series dialog. When second domain axis is not a directional parameter or the time series has more than two domain axes the time series can not be diplayed the time series dialog with the current functionality
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
<subplot> <classBreaks> <break symbolSize="10" color="000080" lowerValue="0"/> <break symbolSize="10" color="0000A8" lowerValue="0.0005"/> <break symbolSize="10" color="0000E6" lowerValue="0.001"/> <break symbolSize="10" color="004DFF" lowerValue="0.0025"/> <break symbolSize="10" color="00B3FF" lowerValue="0.005"/> <break symbolSize="10" color="1AFFE5" lowerValue="0.01"/> <break symbolSize="10" color="80FF80" lowerValue="0.015"/> <break symbolSize="10" color="E6FF19" lowerValue="0.02"/> <break symbolSize="10" color="FFB200" lowerValue="0.025"/> <break symbolSize="10" color="FF4C00" lowerValue="0.035"/> <break symbolSize="10" color="E50000" lowerValue="0.04"/> <break symbolSize="10" color="A80000" lowerValue="0.045"/> <break symbolSize="10" color="800000" lowerValue="0.05"/> </classBreaks> <direction>from</direction> <timeSeriesSet> <moduleInstanceId>Swan_dcsmv6_hirlam_forecast_import</moduleInstanceId> <valueType>scalar</valueType> <parameterId>Wave.variancedensity2D.voorspeld</parameterId> <domainParameterId>f</domainParameterId> <domainParameterId>dir</domainParameterId> <locationSetId>SWAN_POINTS2</locationSetId> <timeSeriesType>simulated forecasting</timeSeriesType> <timeStep unit="minute" multiplier="60"/> <relativeViewPeriod unit="day" start="-2" end="2"/> <readWriteMode>read only</readWriteMode> </timeSeriesSet> </subplot> |
Additional time series (subplot)
Additional time series can be configured in display group plots. These series are found via attribute functions in the <locationFunctionEquals selected=@ATTRIBUTE_ID_A@ additional="@ATTRIBUTE_ID_B@"> of the selected time series and the additional time series. When the attribute functions evaluate to the same value the additional time series are added as invisible by default. When additional time series are available the icon of the visibility dialog will change which shows that invisible time series are available and can be made visible.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
<plot id="WATERBALANS_DAG_CAW"> <subplot stackPlot="true"> <lineStyle>bar</lineStyle> <timeSeriesSet> <moduleInstanceId>BalansAfvoergebieden</moduleInstanceId> <valueType>scalar</valueType> <parameterId>H.G.i.d</parameterId> <locationSetId>AFVOERGEBIEDEN</locationSetId> <timeSeriesType>external historical</timeSeriesType> <timeStep unit="day" timeZone="GMT+1"/> <relativeViewPeriod unit="day" start="-32" end="0"/> <readWriteMode>read only</readWriteMode> </timeSeriesSet> <additionalTimeSeries name="*AFGB_NAAR*" separateSubPlot="true"> <locationFunctionEquals selected="@LOC_ID@" additional="@AFGB_NAAR@"/> <timeSeriesSet> <moduleInstanceId>ImportOpvlWater</moduleInstanceId> <valueType>scalar</valueType> <parameterId>Q.G.15</parameterId> <locationSetId>OPVLWATER_SUBLOC_DEBIETEN</locationSetId> <timeSeriesType>external historical</timeSeriesType> <timeStep unit="minute" multiplier="15"/> <relativeViewPeriod unit="hour" start="-70" end="0"/> <readWriteMode>read only</readWriteMode> </timeSeriesSet> </additionalTimeSeries> <additionalTimeSeries name="*AFGB_VAN*" separateSubPlot="true"> <locationFunctionEquals selected="@LOC_ID@" additional="@AFGB_VAN@"/> <timeSeriesSet> <moduleInstanceId>ImportOpvlWater</moduleInstanceId> <valueType>scalar</valueType> <parameterId>Q.G.15</parameterId> <locationSetId>OPVLWATER_SUBLOC_DEBIETEN</locationSetId> <timeSeriesType>external historical</timeSeriesType> <timeStep unit="minute" multiplier="15"/> <relativeViewPeriod unit="hour" start="-70" end="0"/> <readWriteMode>read only</readWriteMode> </timeSeriesSet> </additionalTimeSeries> </subplot> </plot> |
displayGroup elements
statisticalFunctionId (
...
display)
This feature is available since 2021.02
...
| Code Block |
|---|
<display name="Central Moving Average"> <locationId>LocD</locationId> <plotId>PlotId</plotId> <statisticalFunctionId>CMD</statisticalFunctionId> </display> |
...
Show as Scatter Plot (displayGroup)
...