Display groups file

The schema-companion to the Filters & display groups task guide. That guide explains filters vs. displays and the plot structure; this page is the generated field list.

At a glance

Purpose : Bundles related series into predefined chart/table views — how a chosen thing is drawn (hop ⑤).

Folder : Config/DisplayConfigFiles/

Root element : <displayGroups> (version="1.0", optional)

Depends on : The locations, parameters, and stored series each timeSeriesSet queries.

Minimal example

Config/DisplayConfigFiles/DisplayGroups 1.00 default.xml

<?xml version="1.0" encoding="UTF-8"?>
<displayGroups xmlns="http://www.wldelft.nl/fews" version="1.0">
  <plot id="DischargePlot">
    <subplot>
      <line>
        <color>0000FF</color>
        <lineStyle>solid</lineStyle>
        <timeSeriesSet>
          <moduleInstanceId>ImportObservations</moduleInstanceId>
          <valueType>scalar</valueType>
          <parameterId>Q.obs</parameterId>
          <locationId>RiverGauge_01</locationId>
          <timeSeriesType>external historical</timeSeriesType>
          <timeStep unit="hour" multiplier="1"/>
          <readWriteMode>read only</readWriteMode>
        </timeSeriesSet>
      </line>
    </subplot>
  </plot>
  <displayGroup name="Discharge gauges">
    <display name="River Gauge 01">
      <locationId>RiverGauge_01</locationId>
      <plotId>DischargePlot</plotId>
    </display>
  </displayGroup>
</displayGroups>

Field reference

Note

This is a large surface — display groups expose extensive charting options (axes, markers, subplots, colours). The full graph is below; most configs use a small subset (a plot with one subplot and a few lines).

Auto-generated from displayGroups.xsd. Descriptions are the schema's own annotations.

Element <displayGroups>

Attributes

Attribute	Use	Notes
version	optional	fixed: 1.0.

Elements

Element	Type	Cardinality	Description
description	string	optional
plot	PlotComplexType	optional · repeats
displayGroup	DisplayGroupComplexType	required · repeats

PlotComplexType

Defines a number of sub plots with can be shared by multiple displays. Add all the series you want to see in any display that uses this plot. In a specific display you can select a number of series for one or more specific locations

Attributes

Attribute	Use	Notes
id	required

Elements

Element	Type	Cardinality	Description
description	string	optional
legendFontSize	positiveInteger	optional
axisTitleFontSize	positiveInteger	optional
tickLabelFontSize	positiveInteger	optional
tickTimeStep	TimeStepComplexType	optional	Since 2016.02. Applicable only to scalar plots. When configured, the ticks are tied to this time step. For example if the time step is 6 hours, then the ticks are aligned with the synoptic times 00Z, 06Z, 12Z, 18Z.
synchronizeParameterAxis	boolean	optional	Since 2018.02. When configured, the parameter axis of different subplots showing time series from the same parameter group will be synchronized, i.e., they will show the same value range.
visibilityGroup	nonEmptyStringType	optional · repeats	Since 2019.01. Optional. Defines the order of the visibility groups in the drop down box
profilePositionMarkerLine	ProfilePositionMarkerLineComplexType	optional · repeats	Horizonal marker line at a vertical position in a vertial profile or a horizontal chainage line in longitudinal profile. The line is attachted to time series set with height/depth/chainage as parameter. The marker stretches over all sub-plots
subplot	SubPlotComplexType	required · repeats
plotViewerId	idStringType	required
tableViewerId	idStringType	required

DisplayGroupComplexType

Attributes

Attribute	Use	Notes
name	required
id	optional

Elements

Element	Type	Cardinality	Description
description	string	optional
nodeId	string	optional	This group is automatically selected when the node is selected in the topology panel References a node in the topology.xml
viewPermission	string	optional	set a permission to control who can view this display group
editPermission	string	optional	Set a permission to control who can edit timeseries enumerated in this display group (only editable timeseries can be editted)
locationLoop	LocationLoopComplexType	optional	Since 2015.01 Define a location set to create the tree of display groups for each location in the set
display	DisplayComplexType	required
singleLocationDisplays	DisplayComplexType	required	Adds multiple displays at once to this display group. Every display will show only one location.
singleParentLocationDisplays	DisplayComplexType	required	Adds multiple displays at once to this display group. Every display will show only children for one parent location, and the the parent location itself when specified in the time series sets
displayGroup	DisplayGroupComplexType	required
displayGroupId	string	required	Since 2023.01. Include a display group defined elsewhere by referencing via the id. Can also reference to a display group in another displayGroups*.xml file. When root nodes are referenced they will only be placed at the location they are referenced and not as a separate tree.

TimeStepComplexType

Time step, There are 5 valid combinations of attributes. id, unit+[multiplier]+[divider]+[timeZone], times+[timeZone] + monthDays+[timeZone] ([]=optional)

Attributes

Attribute	Use	Notes
id	optional	Id of the time step. You can reference time steps defined in the regionConfig/timeSteps.xml. Only specify the id attribute when referring to a predefined time step. In the regionConfig/timeSteps.xml the time steps list both the id and the attributes that define the time step
label	optional	Short name for the time step which is shown to the user when he can choose one from a list.
unit	optional
divider	optional
multiplier	optional
times	optional	Defines the time step by a list of times without dates, e.g. "10:00 23:00"
minutes	optional	Since 2017.02. Defines the time step by a list of minutes (with prefix 0 for single digits), e.g. "05 25" which results in times 0:05, 0:25, 1:05, etc.
daysOfMonth	optional	Defines the time step by a list of days of month, use "01 11 21" for a decade time step
monthDays	optional	Defines the time step by a list of dates, e.g. ""--03-01 --06-01 --09-01 --12-01" for the meteorological seasons
timeZone	optional

Elements

Element	Type	Cardinality	Description
description	string	optional	Optional description of this timeStep. This is not used and is only present for convenience.

ProfilePositionMarkerLineComplexType

Element	Type	Cardinality	Description
lineColor	colorStringType	required
lineWidth	nonNegativeDouble	optional
timeSeriesSet	TimeSeriesSetComplexType	required

SubPlotComplexType

Attributes

Attribute	Use	Notes
min	optional	Minimum value for the y-axis in the subplot. Will be overwritten if there is data available that falls inside the x-range, but is below the minimum value on the y-axis. In this case the y-range will be extended to the lowest y value + 5% of the y-range (autoscaling).
max	optional	Not implemented
yAxisScalingType	optional	default: scaleOutsideMinAndMax. Available 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 ot 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	optional
stackPlot	optional	Deprecated since 2014.02. If stackPlot is True, time series of this subplot are plotted as stacked areas (if lineStyle is solid) or stacked bars (if lineStyle is bar).

Elements

Element	Type	Cardinality	Description
description	string	optional
subPlotType	subPlotEnumStringType	optional	Since 2014.02 'standard'= default plot type for the configure ttimeSeriesType. 'stack' = time series of this subplot are plotted as stacked areas (if lineStyle is solid) or stacked bars (if lineStyle is bar). "colormapbars"= time series of this subplot are plotted as stacked bars. Color of the bar matches the paint scale color associated with the bar value. Height of all bars is the same, and equals Y-axis range / number of series in the plot One of: standard, stack, colorMapBars, horizontalColorCode
barMarginPercentage	percentageType	optional	Since 2018.02. 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 subplots containing bars. Use this config option to overrule the general barMarginPercentage for a specific subplot.
inverted	boolean	optional	This option can be used to invert the y-axis of a plot
logarithmic	boolean	optional	Available since 2020.02 This option can be used to make the y axis logarithmic.
drawingOrderInverted	boolean	optional	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.
splitForDifferentRuns	boolean	optional	When true, for each time series from a different run a separate subplot is created
plotWeight	positiveInteger	optional	The plot weight is an integer >= 1, default 1. The plotWeight determines how much space is allocated to the subplot relative to all the other subplots.
plotSeparatorWeight	nonNegativeDouble	optional	The plot separator weight is a double >= 0, default 0.1. It determines how much whitespace is allocated above this subplot, relative to all other subplots. Value will be ignored for first subplot. For example, if the first subplot, second subplot and separator of the second subplot are all given equal weight, each will occupy 1/3 of the screen.
thresholdAxis	subPlotChartAxisEnumStringType	optional	Option to indicate whether to use the left (default), right, or both axes in displaying thresholds. If no thresholds should be shown, use none One of: left, right, both, none
thresholdAxisScaling	thresholdAxisScalingEnumStringType	optional	One of: no thresholds, all thresholds, two thresholds
forecastConfidenceTimeSpan1	TimeSpanComplexType	optional
forecastConfidenceTimeSpan2	TimeSpanComplexType	optional
forecastConfidenceTimeSpan3	TimeSpanComplexType	optional
line	SubPlotLineComplexType	optional · repeats	Use 'line' to specify time series that should be displayed as a (customized) line.
area	SubPlotAreaComplexType	optional · repeats	Displays the extent of multiple time series as a single area. The area between the max and min values for each time are filled with a single color. The areas are always displayed behind the other lines. The area is painted on top of areas already specified, so specify the largest areas first.
clusteredBars	SubPlotClusteredBarsComplexType	optional	Since 2014.02. The time series are plotted as clustered bars
variableLineWidth	SubPlotVariableLineWidthComplexType	optional · repeats	Since 2014.02. FEWS-11325. Plot for which lines can have a variable line width over time. A time series set for the normal values is used and a separate time series set for the line width is used. For each value time series a line width time series is needed. Works best to use a value and line width time series set that only differ on parameter
direction	gridPlotDirectionTypeEnumStringType	optional	Direction of the polar plot (to or from), Default is from (wind) One of: to, from
additionalTimeSeries	AdditionalDisplayGroupsTimeSeriesComplexType	optional · repeats	Since 2017.01 Additional time series that are invisible by default and can be made visible via time series visibility dialog. When defining settings for additional time series sets, like label, styling, axis and visibility either specify them for all time series sets or none.
descriptiveFunction	DescriptiveStatisticalFunctionComplexType	optional · repeats	Since 2013.01, FEWS-8603
timeSeriesSet	TimeSeriesSetComplexType	required
color	colorStringType	optional	Specify the color that overrules the color as specified with ParameterDisplayOptions.
lineStyle	chartLineStyleEnumStringType	optional	Specify the line style that overrules the lineStyle as specified with ParameterDisplayOptions. One of: none, solid, solid;thick, dashed, dashed;thick, dotted, dotted;thick, dashdot, dashdot;thick, bar, area, constant, verticalLine, verticalDotted, verticalDotted;thick
axis	chartAxisEnumStringType	optional	One of: left, right, both
visibleInLegend	boolean	optional
label	string	optional	Optional time series label in legend that overrules the default legend label. Since stable build 2014.01 this can contain location attribute ids, e.g. "@BASIN@", where tags between "@" signs refer to location attributes that are defined in the locationSets config file. The tags are replaced by actual attribute values. These attribute values can be different for different locations. If an attribute is missing for a location, then an error is logged and the default legend label will be used for that location. If required to use a "@" sign in this element without using locationAttributes, then need to add an extra escape character "@" before each "@" sign. In other words "@@" is replaced with a single "@" sign.
visibleInTable	boolean	optional	If a time series is marked with visibleInTable=false, the time series can be shown on the plot area, but will never show in the table. Not implemented for special plots Since stable build 2018.02. Because of a bug in an external library this should never be configured outside of a line, clusteredBars or area element.
visibleInPlot	boolean	optional	If a time series is marked with visibleInPlot=false, the time series can be shown on the table, but will never show in the plot. Not implemented for special plots Since stable build 2019.02. Because of a bug in an external library this should never be configured outside of a line, clusteredBars or area element.
statisticsEnsemble	StatisticsEnsembleFunctionComplexType	optional	Since 2024.02. Only for WebOC!! Define a statistical function which will be applied to the ensemble time series.
includeInStackPlot	boolean	optional	Available since 2026.02. This config option is only meant for subPlotType stack. If it's set to false, the line won't be added to the stack, but drawn as a simple line on top of the stack. Lines that are excluded from the stack have to be configured as last lines in the plot.
markerSize	markerSizeIntegerType	optional
markerStyle	markerStyleEnumStringType	required	One of: none, square, diamond, triangleup, triangledown, circle, x, +, rectangle
markerText	string	required
ratingAxis	ratingAxisComplexType	required
lookupAxis	LookupAxisComplexType	required	Since 2017.02 LookupAxis is an axis on the right side of the subplot. The ticks on this lookupAxis are created by the conversion of the left axis ticks, using the lookup tables (for example stage – storage table)
datumAxis	boolean	required	Since 2017.01 Datum axis is an axis on the right side of the subplot, and it shows left axis ticks in another datum : if left axis shows local datum then datum axis shows global datum and vice versa. To convert to global datum the location altitude (z) of the first location in the subplot is used.
axisLabel	nonEmptyStringType	optional	Since 2014.02 value axis label
axisScaleUnit	double	optional	Unit used for rounding the min and max value of the axis. If scale unit = 1 then a range of -3.8 to 4.9 will be rounded to a range of -4 to 5
lowerMarginPercentage	percentageType	optional
upperMarginPercentage	percentageType	optional
leftAxis	ChartAxisComplexType	required
rightAxis	ChartAxisComplexType	optional
classBreaksId	idStringType	required	Reference to class breaks configured in TimeSeriesDisplayConfig.xml.
classBreaks	ClassBreaksComplexType	required	Class breaks inlined

LocationLoopComplexType

Element	Type	Cardinality	Description
locationSetId	idStringType	required	Since 2015.01. Id of location set which locations will be looped over
includeChildren	boolean	optional	Since 2015.01. Include child locations of loop location
locationRelationId	idStringType	optional · repeats	Since 2015.01. Include all locations that have one of the specified relations to or from the loop location

DisplayComplexType

Attributes

Attribute	Use	Notes
id	optional
name	optional

Elements

Element	Type	Cardinality	Description
description	string	optional
viewPermission	string	optional	set a permission to control who can view this display
visibilityGroup	nonEmptyStringType	optional · repeats	Since 2026.01. Optional. Defines the order of the visibility groups in the dropdown box
editPermission	string	optional	Set a permission to control who can edit timeseries enumerated in this display (only editable timeseries can be editted)
enabledModifierGroups	EnabledModifierGroups	optional
plotPerForecast	boolean	optional	With this option it is possible to display each forecast in a separate plot
explorerFilterId	idStringType	optional · repeats	Since 2022.01 If a location in Filters is double clicked, then a shortcut display will be opened that matches both the clicked location and one of the configured explorerFilterId’s This functionality is there only if an option doubleClickLocationEnabled is true in ‘TimeSeriesDialog’ explorerTask.
explorerLocationId	idStringType	optional	When the shortcuts option is given to the TimeSeriesDialog (clicking on a location) the first display that contains the clicked location is shown. When you specify an explorer location id than than this display is always shown when the user clicks on the specified location
moduleInstanceId	idStringType	optional · repeats	Optional. One or more moduleInstanceIds to filter the time series that are shown. This makes it possible to reuse the same plot definition for multiple displays/charts. When no constraints are specified all moduleInstanceIds in the specified plot are visible. When using this filter, all module instances should be listed which should be shown in the display, even if some of these module instances are individually defined in a timeSeriesSet as part of the plot. Since stable build 2013.02.
not	TimeSeriesFilterNotComplexType	optional	Since 2015.01 Optional. One or more moduleInstanceIdPatterns to filter the time series that are shown. This makes it possible to reuse the same plot definition for multiple displays/charts. When no constraints are specified all moduleInstanceIds in the specified plot are visible. When using this filter, all module instances should be listed which should be shown in the display, even if some of these module instances are individually defined in a timeSeriesSet as part of the plot. Since stable build 2014.03.
locationConstraints	ConstraintsComplexType	optional	This makes it possible to reuse the same plot definition for multiple displays/charts section. When no constraints are specified all locations in the specified plot are visible
tickTimeStep	TimeStepComplexType	optional	Since 2016.02. Applicable only to scalar plots. When configured, the ticks are tied to this time step. For example if the time step is 6 hours, then the ticks are aligned with the synoptic times 00Z, 06Z, 12Z, 18Z.
relativeViewPeriodScroller	RelativeViewPeriodScrollerComplexType	optional	If a relativeViewPeriodScroller is configured a plot with the configured timeseries will be plotted underneath the configured plots.
displayViewType	viewType	optional	One of: table, chart
showAsVerticalProfile	boolean	required	SINCE 2011.02. When true vertical profile time series are calculated on the fly from the scalar time series at the child locations from the locations specified in the time series sets.
alwaysDisplayAsColorMap	boolean	optional	Available since 2024.01. If set to true, the plot will be displayed as a color map by default. A heatmap can only be displayed if the subplot has a classbreak configured. It can only be used in combination with showAsVerticalProfile = true. If it's set to true, toggling between vertical profile and heatmap will be disabled.
contourLineColor	colorStringType	optional	Available since 2025.01. Allows to configure a custom contour line colour for the heatmap. All contour lines in the same subplot will have the same color. Default is black.
relativeViewPeriod	TimeSeriesSetRelativePeriodComplexType	optional
startForwardLookingPeriod	monthDayType	required	When the current day month is before the start of the startForwardLookingPeriod in a year then the season of the previous year will be selected, otherwise the season of this year or the next year will be chosen. Note: using this option in combination with time series sets with readWriteMode set to "read complete forecast" will change the zoom period to also include the complete forecast (in addition to the season).
season	SeasonConditionComplexType	required
nrOfRecentForecasts	nonNegativeInteger	optional	By default only the current and selected forecasts forecast are visible, when specifying e.g. 5 you see also the 5 most recent forecasts with a time0 before or at the display time.
forecastSearchPeriod	RelativePeriodComplexType	optional · repeats	Shows for every specified forecastSearchPeriod the last available forecast. Duplicate found forecasts are filtered out.
locationId	idStringType	required
locationSetId	idStringType	required
parentLocationId	idStringType	required
parentLocationSetId	idStringType	required
thresholdLocationId	idStringType	required
thresholdLocationSetId	idStringType	required
plotId	idStringType	required
legendFontSize	positiveInteger	optional
axisTitleFontSize	positiveInteger	optional
tickLabelFontSize	positiveInteger	optional
synchronizeParameterAxis	boolean	optional	Since 2018.02. When configured, the parameter axis of different subplots showing time series from the same parameter group will be synchronized, i.e., they will show the same value range.
subplot	SubPlotComplexType	required · repeats
moduleInstanceIdPattern	nonEmptyStringType	optional · repeats	Since 2015.01. * and ? are allowed in the pattern
showAsScatterPlot	ShowAsScatterPlotComplexType	optional	Since 2014.02. FEWS-11245 Time series will be displayed in a scatter box, show the correlation between all different parameters. The interaction line is also displayed in the scatter box
addInteractionScatterPlot	InteractionScatterPlotComplexType	optional	Since 2023.02. If set to true, the time series display will show a regular time series, and the scatterplot will only appear if the info plot button is selected. The info plot button has to be enabled in the TieSeriesDisplayConfig.xml buttonsettings.
showElevationFunction	ShowElevationFunctionComplexType	optional	Since 2014.02. Selects the elevation statistical function.
statisticalFunctionId	idStringType	optional	Since 2021.02. Id of the statistical function configured in the system config file TimeSeriesDisplay.xml

TimeSeriesSetComplexType

Attributes

Attribute	Use	Notes
id	optional
name	optional

Elements

Element	Type	Cardinality	Description
description	string	optional
valueType	timeSeriesValueTypeStringType	required
parameterId	idStringType	required
domainParameterId	idStringType	optional · repeats	For a spectrum specify the frequency / wave length parameter. For a directional spectrum specify first the frequency parameter and secondly the directional parameter
qualifierId	idStringType	optional · repeats	Id that references an qualifier listed in the regionConfigFiles/Qualifiers.xsd
timeSeriesType	timeSeriesTypeStringType	required
timeStep	TimeStepComplexType	required
aggregationPeriod	RelativePeriodComplexType	optional	The value at a time represents the aggregated value over the aggregation period e.g when the aggregation period is -6 to 0 hour the value at 13:00 represents an aggregation (e.g. moving average) from 7:00 till 13:00 (including)
cycle	CalendarTimeSpanComplexType	optional	If cycle specified, then the data is repeated periodically with this cycle as the period length. There is original data for only one cycle. After that cycle the data will be repeated periodically. In other words, when cycle is defined, then a missing value is filled up with a value from the last available cycle before the missing value.
externalForecastSearchTimeStep	TimeStepComplexType	optional	Since 2024.01. Only time series with an external forecast time that match this time step are visible while searching
externalForecastTimeCardinalTimeStep	TimeStepComplexType	optional	When no external forecast exists in the data store younger that the specified age a new external forecast is returned with a minimum age that applies to the specified cardinal time step
qualifierAggregation	qualifierAggregationStringType	optional	When specified all the time series that have ALL the specified qualifiers are aggregated to a single time series on read. Can not be specified when this time series set is meant for writing
readWriteMode	timeSeriesReadWriteModeStringType	required	Note: this readWriteMode is only used in the TimeSeriesDisplay. Other modules ignore this readWriteMode.
synchLevel	intStringType	optional
expiryTime	CalendarTimeSpanComplexType	optional
delay	TimeShiftComplexType	optional
multiplier	floatStringType	optional
divider	floatStringType	optional
incrementer	floatStringType	optional
ensembleId	idStringType	optional	Optional field for running ensembles. Ensemble id's in a time series set will override ensemble id's defined in the workflow.
visibilityControllingFlagSourceColumnId	idStringType	optional	All values that not passed this validation step are removed on read. Set to missing for equidistant and removed for non-equidistant
onlyReliableFlagSourceColumnId	idStringType	optional	Since 2022.02. All values that passed this validation step and are reliable will be included other will be set to missing for equidistant and removed for non-equidistant. This will work as an "or" operation together with "visibilityControllingFlagSourceColumnId", so data should either have passed "visibilityControllingFlagSourceColumnId" or "onlyReliableFlagSourceColumnId".
locationRelationId	idStringType	required	Relation id to map the time series set locations to related locations. Instead of the time series set locations the related locations are used to read/write the time series.
skipLocationsWithoutRelation	boolean	optional	Since 2020.01 When true locations that do not have a related location will be skipped, when false all location must have a related location. Default is false
moduleInstanceId	idStringType	required · repeats
moduleInstanceSetId	idStringType	required	Query a single module instance in the data store that is available for this time series set
filterModuleInstanceSetId	idStringType	required	Query all module instances in the data store that are available for this time series set
locationId	idStringType	required · repeats
locationSetId	idStringType	required
chainageLocationSetId	idStringType	required	Id of location set which represents a chainage of locations. This can only be used in combination with readWriteMode readOnly
relativeViewPeriod	TimeSeriesSetRelativePeriodComplexType	optional	Period relative the time 0 of the workflow or the system time of the fews explorer
relativeForecastPeriod	TimeSeriesSetRelativePeriodComplexType	optional	Period relative to first time of a simulated or external forecast time series
ensembleMemberId	nonEmptyStringType	required · repeats	Optional field used for reading or writing one or more particular ensemble member
ensembleMemberIndex	nonNegativeIntegerStringType	required	Optional field used for reading or writing one particular ensemble member
ensembleMemberIndexRange	EnsembleMemberIndexRangeComplexType	required	Optional field used for reading or writing one particular sub set of the ensemble
relativeForecastSearchPeriod	TimeSeriesSetRelativePeriodComplexType	required	Since 2015.02. The latest available external forecast in this period will be read. By default the latest before time0 is returned
externalForecastTimeId	idStringType	required	Since 2018.01. Forecast time reference id configured in the forecast length estimator config. Can only be used in workflows and only after the forecast length estimator.
externalForecastMinAge	TimeSpanComplexType	optional	Since 2014.02. By default is there is no minimum age. All external forecasts after the time0 are ignored. The age of an external forecast is defined as the time span between the external forecast time and the time 0
externalForecastMaxAge	TimeSpanComplexType	optional	By default is there is no maximum age so the returned external forecast can be very old when there is no recent forecast available. All external forecasts after the time0 are ignored. The age of an external forecast is defined as the time span between the external forecast time and the time 0

TimeSpanComplexType

Attributes

Attribute	Use	Notes
unit	required
divider	optional
multiplier	optional

SubPlotLineComplexType

Element	Type	Cardinality	Description
viewPermission	string	optional	set a permission to control who can view this line
visibilityGroup	nonEmptyStringType	optional · repeats	Since 2019.01. When configured the user can easily switch between different visibility profiles and to quickly turn-on and turn-off groups of time series
descriptiveFunction	DescriptiveStatisticalFunctionComplexType	optional · repeats	Since 2013.01, FEWS-8603
timeSeriesSet	TimeSeriesSetComplexType	required
color	colorStringType	optional	Specify the color that overrules the color as specified with ParameterDisplayOptions.
lineStyle	chartLineStyleEnumStringType	optional	Specify the line style that overrules the lineStyle as specified with ParameterDisplayOptions. One of: none, solid, solid;thick, dashed, dashed;thick, dotted, dotted;thick, dashdot, dashdot;thick, bar, area, constant, verticalLine, verticalDotted, verticalDotted;thick
axis	chartAxisEnumStringType	optional	One of: left, right, both
visibleInLegend	boolean	optional
label	string	optional	Optional time series label in legend that overrules the default legend label. Since stable build 2014.01 this can contain location attribute ids, e.g. "@BASIN@", where tags between "@" signs refer to location attributes that are defined in the locationSets config file. The tags are replaced by actual attribute values. These attribute values can be different for different locations. If an attribute is missing for a location, then an error is logged and the default legend label will be used for that location. If required to use a "@" sign in this element without using locationAttributes, then need to add an extra escape character "@" before each "@" sign. In other words "@@" is replaced with a single "@" sign.
visibleInTable	boolean	optional	If a time series is marked with visibleInTable=false, the time series can be shown on the plot area, but will never show in the table. Not implemented for special plots Since stable build 2018.02. Because of a bug in an external library this should never be configured outside of a line, clusteredBars or area element.
visibleInPlot	boolean	optional	If a time series is marked with visibleInPlot=false, the time series can be shown on the table, but will never show in the plot. Not implemented for special plots Since stable build 2019.02. Because of a bug in an external library this should never be configured outside of a line, clusteredBars or area element.
statisticsEnsemble	StatisticsEnsembleFunctionComplexType	optional	Since 2024.02. Only for WebOC!! Define a statistical function which will be applied to the ensemble time series.
includeInStackPlot	boolean	optional	Available since 2026.02. This config option is only meant for subPlotType stack. If it's set to false, the line won't be added to the stack, but drawn as a simple line on top of the stack. Lines that are excluded from the stack have to be configured as last lines in the plot.
markerSize	markerSizeIntegerType	optional
markerStyle	markerStyleEnumStringType	required	One of: none, square, diamond, triangleup, triangledown, circle, x, +, rectangle
markerText	string	required
ratingAxis	ratingAxisComplexType	required
lookupAxis	LookupAxisComplexType	required	Since 2017.02 LookupAxis is an axis on the right side of the subplot. The ticks on this lookupAxis are created by the conversion of the left axis ticks, using the lookup tables (for example stage – storage table)
datumAxis	boolean	required	Since 2017.01 Datum axis is an axis on the right side of the subplot, and it shows left axis ticks in another datum : if left axis shows local datum then datum axis shows global datum and vice versa. To convert to global datum the location altitude (z) of the first location in the subplot is used.

SubPlotAreaComplexType

Element	Type	Cardinality	Description
viewPermission	string	optional	set a permission to control who can view this line
visibilityGroup	nonEmptyStringType	optional · repeats	Since 2019.01. When configured the user can easily switch between different visibility profiles and to quickly turn-on and turn-off groups of time series
visibleInTable	boolean	optional
visibleInPlot	boolean	optional
color	colorStringType	optional
opaquenessPercentage	percentageType	optional
defaultReferenceValue	float	optional	This option is only relevant if the subPlotArea has uneven number of series (e.g. one series) Then the area for the last series is drawn between the last series and this reference value. If the reference value is not configured, 0.0 is used.
includesZeros	boolean	optional	Deprecated option. Remove this option from your configuration (usage of this option has no effect)
label	string	optional	Since stable build 2014.01. Optional time series label in legend that overrules the default legend label. This can contain location attribute ids, e.g. "@BASIN@", where tags between "@" signs refer to location attributes that are defined in the locationSets config file. The tags are replaced by actual attribute values. These attribute values can be different for different locations. If an attribute is missing for a location, then an error is logged and the default legend label will be used for that location. If required to use a "@" sign in this element without using locationAttributes, then need to add an extra escape character "@" before each "@" sign. In other words "@@" is replaced with a single "@" sign.
descriptiveFunction	DescriptiveStatisticalFunctionComplexType	optional · repeats	Since 2013.01, FEWS-8603
statisticsEnsemble	StatisticsEnsembleFunctionComplexType	optional	Since 2024.02. Only for WebOC!! Define a statistical function which will be applied to the ensemble time series.
timeSeriesSet	TimeSeriesSetComplexType	required · repeats
lineStyle	chartLineStyleEnumStringType	required	One of: none, solid, solid;thick, dashed, dashed;thick, dotted, dotted;thick, dashdot, dashdot;thick, bar, area, constant, verticalLine, verticalDotted, verticalDotted;thick
lineWidth	nonNegativeDouble	optional

SubPlotClusteredBarsComplexType

Attributes

Attribute	Use	Notes
axis	optional

Elements

Element	Type	Cardinality	Description
viewPermission	string	optional	set a permission to control who can view this line
visibilityGroup	nonEmptyStringType	optional · repeats	Since 2019.01. When configured the user can easily switch between different visibility profiles and to quickly turn-on and turn-off groups of time series
bar	SubPlotClusteredBarComplexType	required · repeats
timeSeriesSet	TimeSeriesSetComplexType	required · repeats	Deprecated. Use 'bar' instead

SubPlotVariableLineWidthComplexType

Element	Type	Cardinality	Description
viewPermission	string	optional	set a permission to control who can view this line
visibilityGroup	nonEmptyStringType	optional · repeats	Since 2019.01. When configured the user can easily switch between different visibility profiles and to quickly turn-on and turn-off groups of time series
markerColor	colorStringType	optional	Since 2014.02. FEWS-11325. Option to set marker color different from line color
lineWidthScaleFactor	int	required	Since 2014.02. FEWS-11325. Factor to increase or decrease the line width
valueTimeSeriesSet	TimeSeriesSetComplexType	required	Since 2014.02. FEWS-11325. Time series for XY values in line plot
lineWidthTimeSeriesSet	TimeSeriesSetComplexType	optional	Since 2014.02. FEWS-11325. Time series for line width of the XY plot lines
lineColorTimeSeriesSet	TimeSeriesSetComplexType	optional	Since 2022.01. FEWS-26172. Time series for line color of the XY plot lines
color	colorStringType	optional	Specify the color that overrules the color as specified with ParameterDisplayOptions.
lineStyle	chartLineStyleEnumStringType	optional	Specify the line style that overrules the lineStyle as specified with ParameterDisplayOptions. One of: none, solid, solid;thick, dashed, dashed;thick, dotted, dotted;thick, dashdot, dashdot;thick, bar, area, constant, verticalLine, verticalDotted, verticalDotted;thick
axis	chartAxisEnumStringType	optional	One of: left, right, both
visibleInLegend	boolean	optional
label	string	optional	Optional time series label in legend that overrules the default legend label. Since stable build 2014.01 this can contain location attribute ids, e.g. "@BASIN@", where tags between "@" signs refer to location attributes that are defined in the locationSets config file. The tags are replaced by actual attribute values. These attribute values can be different for different locations. If an attribute is missing for a location, then an error is logged and the default legend label will be used for that location. If required to use a "@" sign in this element without using locationAttributes, then need to add an extra escape character "@" before each "@" sign. In other words "@@" is replaced with a single "@" sign.
visibleInTable	boolean	optional	If a time series is marked with visibleInTable=false, the time series can be shown on the plot area, but will never show in the table. Not implemented for special plots Since stable build 2018.02. Because of a bug in an external library this should never be configured outside of a line, clusteredBars or area element.
visibleInPlot	boolean	optional	If a time series is marked with visibleInPlot=false, the time series can be shown on the table, but will never show in the plot. Not implemented for special plots Since stable build 2019.02. Because of a bug in an external library this should never be configured outside of a line, clusteredBars or area element.
statisticsEnsemble	StatisticsEnsembleFunctionComplexType	optional	Since 2024.02. Only for WebOC!! Define a statistical function which will be applied to the ensemble time series.
includeInStackPlot	boolean	optional	Available since 2026.02. This config option is only meant for subPlotType stack. If it's set to false, the line won't be added to the stack, but drawn as a simple line on top of the stack. Lines that are excluded from the stack have to be configured as last lines in the plot.
markerSize	markerSizeIntegerType	optional
markerStyle	markerStyleEnumStringType	required	One of: none, square, diamond, triangleup, triangledown, circle, x, +, rectangle
markerText	string	required
ratingAxis	ratingAxisComplexType	required
lookupAxis	LookupAxisComplexType	required	Since 2017.02 LookupAxis is an axis on the right side of the subplot. The ticks on this lookupAxis are created by the conversion of the left axis ticks, using the lookup tables (for example stage – storage table)
datumAxis	boolean	required	Since 2017.01 Datum axis is an axis on the right side of the subplot, and it shows left axis ticks in another datum : if left axis shows local datum then datum axis shows global datum and vice versa. To convert to global datum the location altitude (z) of the first location in the subplot is used.

AdditionalDisplayGroupsTimeSeriesComplexType

Attributes

Attribute	Use	Notes
name	optional
separateSubPlot	optional	default: false.

Elements

Element	Type	Cardinality	Description
locationFunctionEquals	AdditionalTimeSeriesFunctionEquals	required	Element to define 2 attribute functions for the selected time series from the "normal" time series set and for the time series sets from 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. When it is desired that the additional time series are added only for the same locations then all locations should have an attribute that is equal to their id for example LOC_ID and the locationFunctionEquals element can be used as follows: selected="@LOC_ID@" additional="@LOC_ID@". If a different attribute is used for example additional="@XXX@" all timeseries from the additional time series set where the location has an attribute value of XXX which equals the LOC_ID attribute of the location of the normal time series set will be shown, this can be multiple or even 0.
timeSeriesSet	TimeSeriesSetComplexType	required
color	colorStringType	optional	Specify the color that overrules the color as specified with ParameterDisplayOptions.
lineStyle	chartLineStyleEnumStringType	optional	Specify the line style that overrules the lineStyle as specified with ParameterDisplayOptions. One of: none, solid, solid;thick, dashed, dashed;thick, dotted, dotted;thick, dashdot, dashdot;thick, bar, area, constant, verticalLine, verticalDotted, verticalDotted;thick
axis	chartAxisEnumStringType	optional	One of: left, right, both
visibleInLegend	boolean	optional
label	string	optional	Optional time series label in legend that overrules the default legend label. Since stable build 2014.01 this can contain location attribute ids, e.g. "@BASIN@", where tags between "@" signs refer to location attributes that are defined in the locationSets config file. The tags are replaced by actual attribute values. These attribute values can be different for different locations. If an attribute is missing for a location, then an error is logged and the default legend label will be used for that location. If required to use a "@" sign in this element without using locationAttributes, then need to add an extra escape character "@" before each "@" sign. In other words "@@" is replaced with a single "@" sign.
visibleInTable	boolean	optional	If a time series is marked with visibleInTable=false, the time series can be shown on the plot area, but will never show in the table. Not implemented for special plots Since stable build 2018.02. Because of a bug in an external library this should never be configured outside of a line, clusteredBars or area element.
visibleInPlot	boolean	optional	If a time series is marked with visibleInPlot=false, the time series can be shown on the table, but will never show in the plot. Not implemented for special plots Since stable build 2019.02. Because of a bug in an external library this should never be configured outside of a line, clusteredBars or area element.
statisticsEnsemble	StatisticsEnsembleFunctionComplexType	optional	Since 2024.02. Only for WebOC!! Define a statistical function which will be applied to the ensemble time series.
includeInStackPlot	boolean	optional	Available since 2026.02. This config option is only meant for subPlotType stack. If it's set to false, the line won't be added to the stack, but drawn as a simple line on top of the stack. Lines that are excluded from the stack have to be configured as last lines in the plot.
markerSize	markerSizeIntegerType	optional
markerStyle	markerStyleEnumStringType	required	One of: none, square, diamond, triangleup, triangledown, circle, x, +, rectangle
markerText	string	required
ratingAxis	ratingAxisComplexType	required
lookupAxis	LookupAxisComplexType	required	Since 2017.02 LookupAxis is an axis on the right side of the subplot. The ticks on this lookupAxis are created by the conversion of the left axis ticks, using the lookup tables (for example stage – storage table)
datumAxis	boolean	required	Since 2017.01 Datum axis is an axis on the right side of the subplot, and it shows left axis ticks in another datum : if left axis shows local datum then datum axis shows global datum and vice versa. To convert to global datum the location altitude (z) of the first location in the subplot is used.

DescriptiveStatisticalFunctionComplexType

Descriptive Statistical Function Complex Type: has a function name and optional parameter to be displayed in the feedback display. The ignore missings flag is optional and is false by default. True means that missing values will be ignored. Some functions are not affected by this flag. The functions 'min' and 'max' for instance always ignore missing values, 'count' and 'missings' never do that.

Attributes

Attribute	Use	Notes
function	required	completed = number of values that were missing and have been completed. corrected = number of values that were removed and have been corrected. count = number of values. doubtfuls = number of values that are doubtful due to validation limits. missings = number of values that are missing. reliables = number of values that are reliable. unreliables = number of values that are unreliable.
ignoreMissings	optional	default: false.

Elements

Element	Type	Cardinality	Description
value	percentageType	required · repeats	Used for the descriptive statistical function using a percentile to configure the different percentiles which are to be used.
timeSpan	TimeSpanComplexType	required · repeats	Used for the movingAccumulationMax statistical function to configure the time spans for which the maximum accumulation is to be calculated.

StatisticsEnsembleFunctionComplexType

Element	Type	Cardinality	Description
percentileExceedance	PercentileExceedanceComplexType	required
eventProbability	EventProbabilityComplexType	required
function	StatisticsFunctionEnumStringType	required	One of: sum, max, count, countFlags, kurtosis, mean, median, min, skewness, standardDeviation, rsquared, quartile, variance

ratingAxisComplexType

Element	Type	Cardinality	Description
parameterGroupId	fileStringType	required	Name of the parameterGroup which will be displayed on the right Axis. The units and name of the group will be used to display a unit name and units on the axis
transformationType	ratingCurveAxisChoice	required	This option will determine in which direction the lookup of ticks of the right axis will be performed. For example. Applying true for a plot with Discharge on the right axis will ensure that a Discharge to Stage transformation will be performed. One of: stageDischarge, dischargeStage
ratingCurve	RatingCurveLocationQualifierComplexType	optional

LookupAxisComplexType

Since 2017.02 Describes the conversion type, for example "stage to storage" or "storage to stage"

Element	Type	Cardinality	Description
inputColumnParameterId	idStringType	required	Lookup table parameter Id associated with the left axis. For example Stage if the stage ticks should be converted to ticks (e.g. storage ticks) on the right axis.
outputColumnParameterId	idStringType	required	Lookup table parameter Id associated with the right axis. For example Storage if the storage ticks should be computed from the ticks on the left axis
qualifierId	idStringType	optional · repeats	Optional, used to identify the lookup table

ChartAxisComplexType

Attributes

Attribute	Use	Notes
min	optional
max	optional

ClassBreaksComplexType

Element	Type	Cardinality	Description
description	string	optional
missingValueColor	colorStringType	optional	Color that is used to display missing values (NaN values) for point locations and tracks. Default is fully transparent.
missingValueOpaquenessPercentage	percentageType	optional	Opaqueness percentage that is used to display missing values (NaN values) for point locations and tracks. This overrules the opaqueness of the configured missingValueColor. If missingValueOpaquenessPercentage is not configured, then opaqueness of missingValueColor is used.
unitVisible	boolean	optional	Default is false. When true the display unit for the class break lowerValues is visible in the legend. The display unit can be configured in parameter group.
rescaleAroundOrdinalValue	float	optional	When using the right mouse "rescale classification" option, the rescaling will be based on new Min-Max values from which the defaults are based on zoom extent, with new breaks based on relative widths between lowerValues. Ordinal Value is required if rescaling should keep a fixed origin (e.g. zero). Example 1: when rescaling without an ordinal value, then all lowerValues will be transformed so that the lowest lowerValue coincides with the minimum value in the zoom extent, and that the highest lowerValue coincides with the maximum value in the zoom extent. Example 2: when rescaling with an ordinal value of 100, then each lowerValue will be transformed as follows. newLowerValue = ( {oldLowerValue - 100} * scalingFactor ) + 100 This means that values of 100 will stay in the same classBreak and keep the same color and symbolSize, while other values may not. The scalingFactor is changed to ensure that the lowest lowerValue below the ordinal value will be transformed to the min value in the zoom extent, while the highest lowerValue above the ordinal value will be transformed to the max value in the zoom extent.
belowRangeColor	colorStringType	required	Since 2017.01.01. Color that is used to display values below the lowerValue of the first class break. Default is fully transparent.
belowRangeOpaquenessPercentage	percentageType	optional	Since 2017.01.01. Opaqueness that is used to display values below the lowerValue of the first class break. Default is fully opaque.
aboveRangeColor	colorStringType	required	Since 2017.01.01. Color that is used to display values above the lowerValue of the last class break. Default is fully transparent.
aboveRangeOpaquenessPercentage	percentageType	optional	Since 2017.01.01. Opaqueness that is used to display values above the lowerValue of the last class break. Default is fully opaque.
color	ClassBreakComplexType	required	Deprecated, use break
break	ClassBreakComplexType	required
lowerColor	colorStringType	required
upperColor	colorStringType	required
lowerOpaquenessPercentage	percentageType	optional
upperOpaquenessPercentage	percentageType	optional
lowerSymbolSize	positiveInteger	optional
upperSymbolSize	positiveInteger	optional
lowerValue	float	required · repeats

EnabledModifierGroups

Element	Type	Cardinality	Description
groupId	idStringType	optional · repeats

TimeSeriesFilterNotComplexType

Element	Type	Cardinality	Description
moduleInstanceIdPattern	nonEmptyStringType	optional · repeats	Since 2015.01. * and ? are allowed in the pattern

ConstraintsComplexType

Element	Type	Cardinality	Description
not	ConstraintComplexType	required
anyValid	ConstraintsComplexType	required
allValid	ConstraintsComplexType	required
idStartsWith	IdStartsWithComplexType	required	Only the locations/parameters/qualifiers with an id that starts with the specified text will be included in the location set, other locations in the shape file or location sets are ignored
idEndsWith	IdEndsWithComplexType	required	Only the locations/parameters/qualifiers with an id that ends with the specified text will be included in the location set, other locations in the shape file or location sets are ignored
idContains	IdContainsComplexType	required	Only the locations/parameters/qualifiers with an id that contains the specified text will be included
relatedLocationExists	RelatedLocationExistsComplexType	required	Only the locations where the related location for the specified location relation is not NULL (empty, only spaces or NaN) will be included.
attributeExists	AttributeExistsComplexType	required	Only the locations/parameters/qualifiers where the attribute value is not NULL (empty, only spaces or NaN) will be included
attributeTextStartsWith	AttributeTextStartsWithComplexType	required	Only the locations with attribute value start with the specified text will be included.
attributeTextEndsWith	AttributeTextEndsWithComplexType	required	Only the locations/parameters/qualifiers with attribute value start with the specified text will be included.
attributeTextContains	AttributeTextContainsComplexType	required	Only the locations/parameters/qualifiers with attribute value contains the specified text will be included.
attributeTextEquals	AttributeTextEqualsComplexType	required	Only the locations/parameters/qualifiers with attribute value equals the specified text will be included in the location set, other locations in the shape file or location sets are ignored
attributeTrue	AttributeTrueOrFalseComplexType	required	Only the locations/parameters/qualifiers with attribute value equals true will be included in the location set, other locations in the shape file or location sets are ignored.
attributeFalse	AttributeTrueOrFalseComplexType	required	Only the locations/parameters/qualifiers with attribute value equals false will be included in the location set, other locations in the shape file or location sets are ignored.

RelativeViewPeriodScrollerComplexType

Element	Type	Cardinality	Description
timeSeriesSet	TimeSeriesSetComplexType	optional · repeats
relativeViewPeriod	TimeSeriesSetRelativePeriodComplexType	required
showAllData	boolean	required

TimeSeriesSetRelativePeriodComplexType

Defines a moving period in time. The start and end time are relative time to a certain time. When the start time is not specified it is determined by the start time of the state of the current run. When the start is overrulable the time is overruled by the start of search period or the start of cold state run when one of two is specified When the end is overrulable this time is overruled by the end of the forecast when specified

Attributes

Attribute	Use	Notes
unit	required
start	optional	e.g. -1 hour means one before time 0
end	required	e.g. 1 hour means one hour after time 0
startOverrulable	optional	default: false. When the running module (e.g. general adaptor) has exported a state the state time is used instead of the specified start time. This option is only available during a (forecast) run.
endOverrulable	optional	default: false. When a forecast length is specified (e.g. in the manual forecast dialog) the time 0 + forecast length is used instead of the specified end time This option is only available during a (forecast) run.

Elements

Element	Type	Cardinality	Description
description	string	optional

SeasonConditionComplexType

Element	Type	Cardinality	Description
startMonthDay	monthDayType	required	Start month and day of this season.
endMonthDay	monthDayType	required	End month and day of this season.

RelativePeriodComplexType

Defines a moving period in time. The start and end time are relative time to a certain time.

Attributes

Attribute	Use	Notes
start	required
end	required
startOverrulable	optional	default: false. When the running module (e.g. general adaptor) has exported a state the state time is used instead of the specified start time. This option is only available during a (forecast) run.
endOverrulable	optional	default: false. When a forecast length is specified (e.g. in the manual forecast dialog) the time 0 + forecast length is used instead of the specified end time This option is only available during a (forecast) run.
unit	required

Elements

Element	Type	Cardinality	Description
description	string	optional

ShowAsScatterPlotComplexType

Element	Type	Cardinality	Description
chartTitle	string	optional
referencePointsLegendLabel	string	optional
coloredBackgroundArea	ColoredBackgroundAreaComplexType	optional · repeats	Since 2020.02
xAxisRange	AxisRangeComplexType	optional
xAxisTitle	nameStringType	optional	Since 2017.02 optional element which can be used to define the title for the x-axis
yAxisRange	AxisRangeComplexType	optional
yAxisTitle	nameStringType	optional	Since 2017.02 optional element which can be used to define the title for the y-axis
overrulingSeriesLabel	string	optional · repeats
markerVisibility	markerVisibilityEnumStringType	optional	Since 2019.02 Choose whether all, none or only the last data point will have a marker, default all points will have a marker One of: all, none, onlyLast
referencePoints	ReferencePointsComplexType	optional · repeats
interactionLine	InteractionLineComplexType	optional · repeats	Since 2023.02. An interaction line is a line (consiting of pre-defined points insted of a time series) added to the scaterplot chart. Colour, width, style and individual legend label can be configured.
createPairsByMatchingParameter	boolean	optional	Since 2017.02 time series which have the same parameter are matched in the scatter plot, if this option is set to false they will be matched by location.
matchTimeSeriesPair	matchTimeSeriesPairBy	required	Since 2020.02 One of: location, parameter, timeSeriesOrder

InteractionScatterPlotComplexType

Element	Type	Cardinality	Description
dataLine	DataLineComplexType	optional
xAxisParameterId	idStringType	required
yAxisParameterId	idStringType	required
chartTitle	string	optional
referencePointsLegendLabel	string	optional
coloredBackgroundArea	ColoredBackgroundAreaComplexType	optional · repeats	Since 2020.02
xAxisRange	AxisRangeComplexType	optional
xAxisTitle	nameStringType	optional	Since 2017.02 optional element which can be used to define the title for the x-axis
yAxisRange	AxisRangeComplexType	optional
yAxisTitle	nameStringType	optional	Since 2017.02 optional element which can be used to define the title for the y-axis
overrulingSeriesLabel	string	optional · repeats
markerVisibility	markerVisibilityEnumStringType	optional	Since 2019.02 Choose whether all, none or only the last data point will have a marker, default all points will have a marker One of: all, none, onlyLast
referencePoints	ReferencePointsComplexType	optional · repeats
interactionLine	InteractionLineComplexType	optional · repeats	Since 2023.02. An interaction line is a line (consiting of pre-defined points insted of a time series) added to the scaterplot chart. Colour, width, style and individual legend label can be configured.
createPairsByMatchingParameter	boolean	optional	Since 2017.02 time series which have the same parameter are matched in the scatter plot, if this option is set to false they will be matched by location.
matchTimeSeriesPair	matchTimeSeriesPairBy	required	Since 2020.02 One of: location, parameter, timeSeriesOrder

ShowElevationFunctionComplexType

Element	Type	Cardinality	Description
errorBar	ErrorBarComplexType	required · repeats

CalendarTimeSpanComplexType

Attributes

Attribute	Use	Notes
unit	required
divider	optional
multiplier	optional

TimeShiftComplexType

Attributes

Attribute	Use	Notes
unit	required
divider	optional
multiplier	optional

EnsembleMemberIndexRangeComplexType

Attributes

Attribute	Use	Notes
start	required
end	optional

SubPlotClusteredBarComplexType

Element	Type	Cardinality	Description
timeSeriesSet	TimeSeriesSetComplexType	required
color	colorStringType	optional	Specify the color that overrules the color as specified with ParameterDisplayOptions.
ratingAxis	ratingAxisComplexType	optional
visibleInLegend	boolean	optional
visibleInTable	boolean	optional
visibleInPlot	boolean	optional
label	string	optional	Optional time series label in legend that overrules the default legend label. Since stable build 2014.01 this can contain location attribute ids, e.g. "@BASIN@", where tags between "@" signs refer to location attributes that are defined in the locationSets config file. The tags are replaced by actual attribute values. These attribute values can be different for different locations. If an attribute is missing for a location, then an error is logged and the default legend label will be used for that location. If required to use a "@" sign in this element without using locationAttributes, then need to add an extra escape character "@" before each "@" sign. In other words "@@" is replaced with a single "@" sign.

AdditionalTimeSeriesFunctionEquals

Attributes

Attribute	Use	Notes
selected	required
additional	required

PercentileExceedanceComplexType

Element	Type	Cardinality	Description
percentile	percentageType	required
adjustable	boolean	required

EventProbabilityComplexType

Element	Type	Cardinality	Description
eventLowerValue	float	required
eventUpperValue	float	required
adjustable	boolean	required

RatingCurveLocationQualifierComplexType

Element	Type	Cardinality	Description
locationId	idStringType	required
qualifierId	idStringType	optional

ClassBreakComplexType

Attributes

Attribute	Use	Notes
color	optional
opaquenessPercentage	optional
symbolSize	optional
lowerValue	required
label	optional
colorSmoothingEnabled	optional
icon	optional	Since 2014.02 implemented for Track Layer and since 2017.02 for esriShapeLayer with points.
hideValueLabels	optional	default: false. Since 2020.01 If set to true, labels of values which fall into the classBreak will not be displayed.

ConstraintComplexType

Element	Type	Cardinality	Description
not	ConstraintComplexType	required
anyValid	ConstraintsComplexType	required
allValid	ConstraintsComplexType	required
idStartsWith	IdStartsWithComplexType	required	Only the locations/parameters/qualifiers with an id that starts with the specified text will be included in the location set, other locations in the shape file or location sets are ignored
idEndsWith	IdEndsWithComplexType	required	Only the locations/parameters/qualifiers with an id that ends with the specified text will be included in the location set, other locations in the shape file or location sets are ignored
idContains	IdContainsComplexType	required	Only the locations/parameters/qualifiers with an id that contains the specified text will be included
relatedLocationExists	RelatedLocationExistsComplexType	required	Only the locations where the related location for the specified location relation is not NULL (empty, only spaces or NaN) will be included.
attributeExists	AttributeExistsComplexType	required	Only the locations/parameters/qualifiers where the attribute value is not NULL (empty, only spaces or NaN) will be included
attributeTextStartsWith	AttributeTextStartsWithComplexType	required	Only the locations with attribute value start with the specified text will be included.
attributeTextEndsWith	AttributeTextEndsWithComplexType	required	Only the locations/parameters/qualifiers with attribute value start with the specified text will be included.
attributeTextContains	AttributeTextContainsComplexType	required	Only the locations/parameters/qualifiers with attribute value contains the specified text will be included.
attributeTextEquals	AttributeTextEqualsComplexType	required	Only the locations/parameters/qualifiers with attribute value equals the specified text will be included in the location set, other locations in the shape file or location sets are ignored
attributeTrue	AttributeTrueOrFalseComplexType	required	Only the locations/parameters/qualifiers with attribute value equals true will be included in the location set, other locations in the shape file or location sets are ignored.
attributeFalse	AttributeTrueOrFalseComplexType	required	Only the locations/parameters/qualifiers with attribute value equals false will be included in the location set, other locations in the shape file or location sets are ignored.

RelatedLocationExistsComplexType

Attributes

Attribute	Use	Notes
locationRelationId	required	Id of the location relation (eg. UPSTREAM)

AttributeExistsComplexType

Attributes

Attribute	Use	Notes
id	required	Id of the attribute

AttributeTextStartsWithComplexType

Attributes

Attribute	Use	Notes
id	required	Id of the attribute
prefix	required	The text the attribute value should start with

AttributeTextEndsWithComplexType

Attributes

Attribute	Use	Notes
id	required	Id of the attribute
postfix	required	The text the attribute value should end with

AttributeTextContainsComplexType

Attributes

Attribute	Use	Notes
id	required	Id of the attribute
contains	required	The text the attribute value should contain

AttributeTextEqualsComplexType

Attributes

Attribute	Use	Notes
id	required	Id of the attribute
equals	required	The text the attribute value should match
modifierDependent	optional	When true the location set can change dynamically when a attribute is changed by a modifier. Only allowed in workflows and in the modifiers display

AttributeTrueOrFalseComplexType

Attributes

Attribute	Use	Notes
id	required	Id of the attribute
modifierDependent	optional	When true the location set can change dynamically when a attribute is changed by a modifier. Only allowed in workflows and in the modifiers display

ColoredBackgroundAreaComplexType

Element	Type	Cardinality	Description
label	string	required
color	colorEnumStringType	required	One of: alice blue, white, antique white, antique white1, antique white2, antique white3, antique white4, aquamarine, black, blanched almond, blue, blue violet, brown, cadet blue, cadet blue1, cadet blue2, cadet blue3, cadet blue4, coral, cornflower blue, cyan, dark goldenrod, dark goldenrod1, dark goldenrod2, dark goldenrod3, dark goldenrod4, dark green, dark khaki, dark olive green, dark olive green1, dark olive green2, dark olive green3, dark olive green4, dark orange, dark orange1, dark orange2, dark orange3, dark orange4, dark orchid, dark orchid1, dark orchid2, dark orchid3, dark orchid4, dark salmon, dark sea green, dark sea green1, dark sea green2, dark sea green3, dark sea green4, dark slate blue, dark slate gray, dark slate gray1, dark slate gray2, dark slate gray3, dark slate gray4, dark turquoise, dark violet, deep pink, deep pink2, deep pink3, deep pink4, deep sky blue, deep sky blue2, deep sky blue3, deep sky blue4, dim gray, dodger blue, dodger blue2, dodger blue3, dodger blue4, firebrick, floral white, forest green, ghost white, gold, goldenrod, gray, gray0, gray100, gray18, gray21, gray23, gray24, gray25, gray26, gray27, gray28, gray29, gray30, gray31, gray32, gray34, gray35, gray36, gray37, gray38, gray39, gray40, gray41, gray42, gray43, gray44, gray45, gray46, gray47, gray48, gray49, gray50, gray51, gray52, gray53, gray54, gray55, gray56, gray57, gray58, gray59, gray60, gray61, gray62, gray63, gray64, gray65, gray66, gray67, gray68, gray69, gray70, gray71, gray72, gray73, gray74, gray75, gray76, gray77, gray78, gray79, gray80, gray81, gray82, gray83, gray84, gray85, gray86, gray87, gray88, gray89, gray90, gray91, gray92, gray93, gray94, gray95, gray96, gray97, gray98, gray99, green, green yellow, hot pink, hot pink1, hot pink2, hot pink3, hot pink4, indian red, indian red1, indian red2, indian red3, indian red4, khaki, lavender blush, lavender blush2, lavender blush3, lavender blush4, lawn green, lemon chiffon, lemon chiffon2, lemon chiffon3, lemon chiffon4, light blue, light blue1, light blue2, light blue3, light blue4, light coral, light cyan, light cyan2, light cyan3, light cyan4, light goldenrod, light goldenrod1, light goldenrod2, light goldenrod3, light goldenrod4, light goldenrod yellow, light pink, light pink1, light pink2, light pink3, light pink4, light salmon, light salmon2, light salmon3, light salmon4, light sea green, light sky blue, light sky blue2, light sky blue3, light sky blue4, light slate blue, light slate gray, light steel blue, light steel blue1, light steel blue2, light steel blue3, light steel blue4, light yellow, light yellow2, light yellow3, light yellow4, lime green, magenta, maroon, medium aquamarine, medium blue, medium forest green, medium goldenrod, medium orchid, medium orchid1, medium orchid2, medium orchid3, medium orchid4, medium purple, medium purple1, medium purple2, medium purple3, medium purple4, medium sea green, medium slate blue, medium spring green, medium turquoise, medium violet red, midnight blue, mint cream, misty rose, misty rose2, misty rose3, misty rose4, navajo white, navajo white2, navajo white3, navajo white4, navy, old lace, olive drab, olive drab1, olive drab2, olive drab3, olive drab4, orange, orange red, orange red2, orange red3, orange red4, orchid, pale goldenrod, pale green, pale green1, pale green2, pale green3, pale green4, pale turquoise, pale turquoise1, pale turquoise2, pale turquoise3, pale turquoise4, pale violet red, pale violet red1, pale violet red2, pale violet red3, pale violet red4, papaya whip, peach puff, peach puff2, peach puff3, peach puff4, pink, plum, powder blue, red, rosy brown, rosy brown1, rosy brown2, rosy brown3, rosy brown4, royal blue, royal blue1, royal blue2, royal blue3, royal blue4, sandy brown, sea green, sea green1, sea green2, sea green3, sea green4, sienna, sky blue, sky blue1, sky blue2, sky blue3, sky blue4, slate blue, slate blue1, slate blue2, slate blue3, slate blue4, slate gray, slate gray1, slate gray2, slate gray3, slate gray4, spring green, spring green1, spring green2, spring green3, spring green4, steel blue, steel blue1, steel blue2, steel blue3, steel blue4, tan, thistle, turquoise, violet, violet red, violet red1, violet red2, violet red3, violet red4, wheat, yellow, yellow green, aquamarine1, aquamarine2, aquamarine3, aquamarine4, azure, azure2, azure3, azure4, beige, bisque, bisque2, bisque3, bisque4, blue1, blue2, blue3, blue4, brown1, brown2, brown3, burlywood1, burlywood2, burlywood3, burlywood4, chartreuse, chartreuse2, chartreuse3, chartreuse4, chocolate, coral2, coral3, coral4, cornsilk, cornsilk2, cornsilk3, cornsilk4, cyan1, cyan2, cyan3, cyan4, firebrick1, firebrick2, firebrick3, gainsboro, gold1, gold2, gold3, gold4, goldenrod1, goldenrod2, goldenrod3, goldenrod4, green1, green2, green3, green4, honeydew, honeydew2, honeydew3, honeydew4, ivory, ivory2, ivory3, ivory4, khaki1, khaki2, khaki3, khaki4, lavender, linen, magenta1, magenta2, magenta3, maroon1, maroon2, maroon3, maroon4, moccasin, orange1, orange2, orange3, orange4, orchid1, orchid2, orchid3, orchid4, peru, pink2, pink3, pink4, plum1, plum2, plum3, plum4, purple, purple1, purple2, purple3, purple4, red1, red2, salmon1, salmon2, salmon3, salmon4, seashell, seashell2, seashell3, seashell4, sienna1, sienna2, sienna3, sienna4, snow, snow2, snow3, snow4, tan1, tan2, thistle1, thistle2, thistle3, thistle4, tomato, tomato2, tomato3, turquoise1, turquoise2, turquoise3, turquoise4, wheat1, wheat2, wheat3, wheat4, yellow1
opaquenessPercentage	percentageType	required
point	ReferencePointComplexType	required · repeats
xAttributeId	nonEmptyStringType	required	Since 2023.02. Instead of predefined reference points, the x-coordinate of the points can be configured as values of a multi-value location attribute.
yAttributeId	nonEmptyStringType	required	Since 2023.02. Instead of predefined reference points, the y-coordinate of the points can be configured as values of a multi-value location attribute.

AxisRangeComplexType

Element	Type	Cardinality	Description
min	float	required
max	float	required

ReferencePointsComplexType

Element	Type	Cardinality	Description
point	ReferencePointComplexType	required · repeats
xAttributeId	nonEmptyStringType	required	Since 2023.02. Instead of predefined reference points, the x-coordinate of the points can be configured as values of a multi-value location attribute.
yAttributeId	nonEmptyStringType	required	Since 2023.02. Instead of predefined reference points, the y-coordinate of the points can be configured as values of a multi-value location attribute.

InteractionLineComplexType

Element	Type	Cardinality	Description
referencePoints	ReferencePointsComplexType	required
lineColor	colorStringType	optional
lineStyle	chartLineStyleEnumStringType	optional	One of: none, solid, solid;thick, dashed, dashed;thick, dotted, dotted;thick, dashdot, dashdot;thick, bar, area, constant, verticalLine, verticalDotted, verticalDotted;thick
lineWidth	nonNegativeDouble	optional
markerStyle	markerStyleEnumStringType	optional	One of: none, square, diamond, triangleup, triangledown, circle, x, +, rectangle
markerSize	markerSizeIntegerType	optional
labelText	string	optional

DataLineComplexType

Element	Type	Cardinality	Description
lineColor	colorStringType	optional
lineStyle	chartLineStyleEnumStringType	optional	One of: none, solid, solid;thick, dashed, dashed;thick, dotted, dotted;thick, dashdot, dashdot;thick, bar, area, constant, verticalLine, verticalDotted, verticalDotted;thick
lineWidth	nonNegativeDouble	optional
markerStyle	markerStyleEnumStringType	optional	One of: none, square, diamond, triangleup, triangledown, circle, x, +, rectangle
markerSize	markerSizeIntegerType	optional
labelText	string	optional

ErrorBarComplexType

Element	Type	Cardinality	Description
parameterID	string	required
qualifierID	string	optional · repeats

ReferencePointComplexType

Element	Type	Cardinality	Description
x	float	required
y	float	required

See also

• Task guide: Filters & display groups
• Reference: Filters file
• Schema: displayGroups.xsd