Versions Compared

Key

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

...

  • unit: a string containing the unit for the column (e.g. "cm" for a water level), which will also appear in the header of the column,
  • type: one of "string", "integer", "float", "boolean", or "dateTime", which indicates the type of data that is displayed in the column (for now, this key is not functional; all non-editable columns are treated as strings, all editable columns expect integer values),
  • isEditable: a flag with value true or false indicating whether the column is editable for the user (e.g. the user can enter the forecast in this column),
  • isExport: a flag with value true or false indicating whether the column must be exported to file if the forecast is published (editable columns are exported by default),
  • exportName: a string containing the name that must be used for exporting the column to file,
  • lang: a string that specifies the language of the header; this attribute behaves the same as for the title keys.

...

Code Block
xml
xml
<header>
   <column id="station">station</column>
   <column id="date">date</column>
   <column id="time">time</column>
   <column id="astro_level" isExport="true" exportName="H.tidal.astronomic" unit="cm">astronomical water level</column>
   <column id="water_level" isEditable="true" exportName="H.tidal.peak" unit="cm">water level</column>
   <column id="dischargeevacuate" isEditable="true" exportNametype="Q" unit="m^3/s">discharge<boolean">evacuate?</column>
</header>

Rows can be added to the forecast table by specifying the row key. The number of rows is arbitrary. For each row, an identifier must be specified using the id attribute. Content for a row is added using the cell key, where each cell must correspond to a column in the header. This can be achieved with the columnId attribute of the row key. For example:

...