Versions Compared

Key

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

...

What

Locations.xml

Required

yes

Description

Definitions of all locations

schema location

http

https://

fews

fewsdocs.

wldelft

deltares.nl/schemas/version1.0/locations.xsd

DELFT-FEWS is a location oriented system. All time series data must be referenced to a (geographic) location. This location must be identified by its geographic coordinates within the coordinate system used. When available on the file system, the name of the XML file is for example:

Locations 1.00 default.xml

Locations

Fixed file name for the locations configuration

1.00

Version number

default

Flag to indicate the version is the default configuration (otherwise omitted)


Figure 23 Elements in the Locations configuration

...

Optional short name for the location. This string when available will replace the name in the time series display legend.

label

optional element to customize the location label in the main map display.
You can use the following tags:
%ID%, %NAME%, %DESCRIPTION%, %LAST_VALUE%, %LAST_VALUE_TIME%,
%FORECAST_START_TIME%, %MAXIMUM_VALUE%, %MAXIMUM_VALUE_TIME%, %MINIMUM_VALUE%, %MINIMUM_VALUE_TIME%

An example:

No Format
<label>%NAME%  %LAST_VALUE%   %LAST_VALUE_TIME%</label>

or

No Format
<label>%NAME%   max:%MAXIMUM_VALUE%  min: %MINIMUM_VALUE% </label>
toolTip

optional element to customize the tooltip shown when hovering over a location in the main map display.

...

%ID%, %NAME%, %DESCRIPTION%, %LAST_VALUE%, %LAST_VALUE_TIME%,
%FORECAST_START_TIME%, %MAXIMUM_VALUE%, %MAXIMUM_VALUE_TIME%, %MINIMUM_VALUE%, %MINIMUM_VALUE_TIME%

The tooltip supports html including images and hyperlinks.    The url in the hyper link hyperlink can be an internet url, an executable file, a document file, or a folder. Use the CDATA xml tag to include html in a xml file. Check the available HTML functionalities here.

Info
titleOpening tooltip hyperlinks in Web Browser Display

Delft-FEWS' Web Browser Display is the internal web browser of Delft-FEWS which is opened as a tab just like any other display in Delft-FEWS. You can set this browser as being the default and once whitelisted, all URLs specified in e.g. the topology or in tooltips will be opened in the Web browser display tab. For more details, visit the Web Browser Display pages.


By default (if not defined) the following tool tip is used.

No Format

Name: %NAME%\n
Desc: %DESCRIPTION%\n
Last value \[%LAST_VALUE%\] Time \[%LAST_VALUE_TIME%\]\n
Forecast Start Time \[%FORECAST_START_TIME%\]\n
Maximum \[%MAXIMUM_VALUE%\] Time \[%MAXIMUM_VALUE_TIME%\]

A more advanced example is, using HTML (use the <BR> tag to start new line):

No Format

<toolTip><![CDATA[<html>
    <table id="details">
      <tr>
	<td width="50" valign="top">ID</td>
	<td width="5" valign="top">:</td>
	<td width="200" valign="top">%ID%</td>
      </tr>
      <tr>
	<td width="50" valign="top">Naam</td>
	<td width="5" valign="top">:</td>
	<td width="200" valign="top">%NAME%</td>
      </tr>
      <tr>
	<td width="50" valign="top">Type</td>
	<td width="5" valign="top">:</td>
	<td width="200" valign="top">%DESCRIPTION%</td>
      </tr>
      <tr>
	<td width="50" valign="top">Foto</td>
	<td width="5" valign="top">:</td>
	<td width="200" valign="top">
	   <a href="file:/$FOTOSDIR$/%ID%.jpg" >
		<img src="file:/$FOTOSDIR$/thumbs/%ID%.jpg" border="0">
	   </a>
	</td>
      </tr>
      <tr>
	<td width="50" valign="top">Documentatie</td>
	<td width="5" valign="top">:</td>
	<td width="200" valign="top">
	   <a href="file:/$PDFDIR$/%ID%.pdf">%ID%.pdf</a>
	</td>
      </tr>
    </table>
</html>
  ]]></toolTip>

Please find below another example of a html tooltip containing a hyperlink. This hyperlink consists of a fixed and a dynamic part. The dynamic part is filled in with location attributes

No Format
<toolTip><![CDATA[<html>
	<table id="details">
	  <tr>
	<td width="160" valign="top">Peilbuis</td>
	<td width="505" valign="top">:</td>
	<td width="200" valign="top">%ID%</td>
	  </tr>
	  <tr>
	<td width="160" valign="top">Naam</td>
	<td width="5" valign="top">:</td>
	<td width="200" valign="top">%REGION% - %ID%</td>
	  </tr>
	  <tr>
	<td width="160" valign="top">Regio</td>
	<td width="5" valign="top">:</td>
	<td width="200" valign="top">%REGION%</td>
	  </tr>
	  <tr>
	<td width="160" valign="top">XY</td>
	<td width="5" valign="top">:</td>
	<td width="200" valign="top">(%X%, %Y%)</td>
	  </tr>
	  <tr>
	<td width="160" valign="top">Documentatie<>Ellitrack serienummer</td>
	<td width="5" valign="top">:</td>
	<td width="200" valign="top">%IMPORT_ID%</td>
	  </tr>
	  <tr>
	<td width="160" valign="top">BRO GMN ID</td>
	<td width="5" valign="top">:</td>
	<td width="200" valign="top">onbekend</td>
	  </tr>
	  <tr>
	<td width="160" valign="top">BRO GMW ID</td>
	<td width="5" valign="top">:</td>
	<td  <awidth="200" valign="top"><b><a href="filehttps:/$PDFDIR$/%ID%.pdf">%ID%.pdf</a>              
	</td>
      </tr>
    </www.broloket.nl/ondergrondgegevens?bro-id=%BRO_GMW_ID%">%BRO_GMW_ID%</a></b></td>
	  </tr>
	  <tr>
	<td width="160" valign="top">BRO GLD ID</td>
	<td width="5" valign="top">:</td>
	<td width="200" valign="top">%BRO_GLD_ID%</td>
	  </tr>
	  <tr>
	<td width="160" valign="top">Hoogte bk peilbuis [m NAP]</td>
	<td width="5" valign="top">:</td>
	<td width="200" valign="top">%H_BK_PEILBUIS%</td>
		</tr>
	  <tr>	<td width="160" valign="top">Hoogte bk staaf [m NAP]</td>	<td width="5" valign="top">:</td>	<td width="200" valign="top">%H_BK_STAAF%</td>	  </tr>
	  <tr>	<td width="160" valign="top">Hoogte groef t.o.v. bk staaf [m]</td>	<td width="5" valign="top">:</td>	<td width="200" valign="top">%H_GROEF_TOV_STAAF%</td>	  </tr>
	  <tr>	<td width="160" valign="top">Hoogte groef [m NAP]</td>	<td width="5" valign="top">:</td>	<td width="200" valign="top">%H_GROEF%</td>	  </tr>
	  <tr>	<td width="160" valign="top">Hoogte maaiveld [m NAP]</td>	<td width="5" valign="top">:</td>	<td width="200" valign="top">%H_MAAIVELD%</td>	  </tr>
	  <tr>	<td width="160" valign="top">Kabel-lengte [m]</td>	<td width="5" valign="top">:</td>	<td width="200" valign="top">%KABEL_LENGTE%</td>	  </tr>
	  <tr>	<td width="160" valign="top">Filter-diepte [m-mv]</td>	<td width="5" valign="top">:</td>	<td width="200" valign="top">%FILTER_DIEPTE%</td>	  </tr>
	  <tr>	<td width="160" valign="top">Diepte stalen fundering [m-mv]</td>	<td width="5" valign="top">:</td>	<td width="200" valign="top">%DIEPTE_STALEN_FUNDERING%</td>	  </tr>

	  <tr>
	<td width="160" valign="top">Opmerking</td>
	<td width="5" valign="top">:</td>
	<td width="200" valign="top">%OPMERKING%</td>
	  </tr>
	</table>
</html>
  ]]></toolTip>

parentLocationId 

Optional Id of a location that functions as a parent. In the filters child locations (locations that refer to a parent) are normally invisible. However, they are displayed in the graphs whenever a parent is selected. 

...

  • startDateTime: the date and time of the start of the visibility period. The start of the period is inclusive. If startDateTime is not defined, then the location is visible for all times before endDateTime.
  • endDateTime: the date and time of the end of the visibility period. The end of the period is inclusive. If endDateTime is not defined, then the location is visible for all times after startDateTime.

Remark: the datetime pattern should be added to the locationSet definition! This (optional) dateTimePattern tag is used to define the pattern for the dateTimes defined in the DBF file. If dateTimePattern is not specified, then the default pattern "yyyyMMdd" is used, which is the internal format that a DBF file uses for columns of type 'D' (date columns).

x

Geographic coordinate of the location (Easting)

...