Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Attributes: name and id

  • Elements:

    • description: Optional description
    • nodeId
    • viewPermission
    • editPermission
    • locationLoop
    • types of display
      • display: see below for details
      • singleLocationDisplays 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.
      • singleParentLocationDisplays
      • displayGroup: see below for details
      • displayGroupId

...

Code Block
languagexml
titleline example (click to expand)
linenumberstrue
collapsetrue
<plot id="Test">
   <subplot>
      <line>
         <color>dark orange</color>
         <visibleInLegend>false</visibleInLegend>
         <visibleInTable>false</visibleInTable>
		 <visibleInPlot>true</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>
   </line>           
   </subplot>
</plot>

axis (

...

dual y-axis plot)

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.

...

Code Block
languagexml
titlelocationLoop example (click to expand)
linenumberstrue
collapsetrue
	<displayGroup name="Validations Location Loop">
		<displayGroup name=" ">
			<locationLoop>
				<locationSetId>FloodingAreas</locationSetId>
				<includeChildren>true</includeChildren>
				<locationRelationId>L_AREA</locationRelationId>
				<locationRelationId>L_VISIBILIY</locationRelationId>
				<locationRelationId>MEASUREMENT_PARENT</locationRelationId>
			</locationLoop>
			<displayGroup name="Waterbalance">
				<display name="Waterbalance">
					<plotId>Waterbalance</plotId>
				</display>
				<display name="Waterbalance incl. error">
					<plotId>Waterbalance_error</plotId>
				</display>
			</displayGroup>
                           ...
		</displayGroup>
	</displayGroup>


displayGroup elements

...

display

...

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

Attributes;

Some of the elements of display:

  • parentLocationId:
  • description
  • startForwardLookingPeriod: way to define view period for seasonal or water year analysis
  • 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
  • plotId
  • tickTimeStep
  • thresholdLocationSetId

startForwardLookingPeriod

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. Use readWriteMode=read only in your time seriessets, as other modes such as 'read complete forecast' stretches the time horizon, disrupting the time horizon displayed outside the season.

...

The associated display looks like:

tickTimeStep

...

To tie the date/time ticks to the valid times of the (cardinal) time step, configure ‘tickTimeStep’ in DisplayGroups.xml. For example, if the ‘tickTimeStep’ is 6 hours then the ticks are always aligned with the synoptic times 00Z, 06Z, 12Z, 18Z. When we are zooming out and there is no space to display all date/times along the x-axis, then one or more synoptic times ticks are omitted. For example we see ticks at 00Z and 18Z.

singleLocationDisplays

showAsVerticalProfile

Info
titletodo
todo

showAsScatterPlot

In a display group the element <showAsScatterPlot> can be used to use a plot where different time series are plotted against each other with the values of the different time series on the X and Y axis.

...

Example from Operational system:

statisticalFunctionId

This feature is available (since 2021.02) Using  statisticalFunctionId it is possible to create a preconfigured display with any statistical function.

...