Versions Compared

Key

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

...

What

TimeSeriesDisplayConfig.xml

Config group

SystemConfigFiles

Required

no

Description

Configuration file for the time series display (line styles etc)

schema location

httphttps://fewsfewsdocs.wldelftdeltares.nl/schemas/version1.0/timeSeriesDisplay.xsd

Table of Contents

Introduction

...

With the use of legendFormat you can customise what information you wish to see on the legend of a graph plot. Use the following tags in the legendformat, they will be automatically replaced with the correct values:  

  • %LOCATION_ID%
  • %LOCATION_NAME%
  • %LOCATION_SHORTNAME%
  • %PARAMETER_ID%
  • %PARAMETER_NAME%
  • %FORECAST_INDEX%
  • %MODULE_INSTANCE%
  • %ENSEMBLE_ID%
  • %ENSEMBLE_MEMBER_ID%
  • %QUALIFIER_NAME%
  • %ADDITIONAL_PREFIX%
  • %HISTORICAL_EVENT_NAME%
  • %MODIFIED%
  • %CUSTOM_LABEL_EXTENSION%
  • %FUNCTION_LABEL%
  • %POSTPROCESSING%

Tags are case sensitive. If a tag configured that does not exist in the given time series, it will be replaced by an empty string. Example:
<legendTextFunction>%PARAMETER_NAME% %ENSEMBLEMEMBERID% measured at %LOCATION_NAME%</legendTextFunction>  → Water level measured at Lobith H105 
LegendTextFunction does not work with timeseries header label function.

...

Multiple legendTooltip elements as show in this example can be added to the tooltips config element, the tooltip text can be formatted in HTML by putting it in a CDATA block and %property% and/or @attribute@ tags can be inserted, with support for user defined attributes for locations, parameters and modifiers as well as the following standard properties:

  • %LOCATION_ID%
  • %LOCATION_NAME%
  • %LOCATION_SHORTNAME%
  • %LOCATION_DESCRIPTION%
  • %PARAMETER_ID%
  • %PARAMETER_NAME%
  • %PARAMETER_SHORTNAME%
  • %PARAMETER_DESCRIPTION%
  • %PARAMETER_UNIT%
  • %QUALIFIER_NAME%
  • %MODULE_INSTANCE_ID%
  • %MODULE_INSTANCE_NAME%
  • %MODULE_INSTANCE_DESCRIPTION%

Time Markers Display Configuration

...