terriajs
Version:
Geospatial data visualization platform.
7,655 lines • 117 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: TableStructure</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: TableStructure</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>TableStructure<span class="signature">(name<span class="signature-attributes">opt</span>, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="TableStructure"><span class="type-signature"></span>new TableStructure<span class="signature">(name<span class="signature-attributes">opt</span>, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
<p>TableStructure provides an abstraction of a data table, ie. a structure with rows and columns.
Its primary responsibility is to load and parse the data, from csvs or other.
It stores each column as a TableColumn, and saves the rows too if conversion to rows is requested.
Columns are also sorted by type for easier access.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Name to use in the NowViewing tab, defaults to 'Display Variable'.</p></td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Options:</p>
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>displayVariableTypes</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>Which variable types to show in the NowViewing tab. Defaults to ENUM, SCALAR, and ALT (not LAT, LON or TIME).</p></td>
</tr>
<tr>
<td class="name"><code>unallowedTypes</code></td>
<td class="type">
<span class="param-type">Array.<VarType></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>An array of types which should not be guessed. If not present, all types are allowed. Cannot include VarType.SCALAR.</p></td>
</tr>
<tr>
<td class="name"><code>initialTimeSource</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>A string specifiying the value of the animation timeline at start. Valid options are:
("present": closest to today's date,
"start": start of time range of animation,
"end": end of time range of animation,
An ISO8601 date e.g. "2015-08-08": specified date or nearest if date is outside range).</p></td>
</tr>
<tr>
<td class="name"><code>displayDuration</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>Passed on to TableColumn, unless overridden by options.columnOptions.</p></td>
</tr>
<tr>
<td class="name"><code>replaceWithNullValues</code></td>
<td class="type">
<span class="param-type">Array.<String></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>Passed on to TableColumn, unless overridden by options.columnOptions.</p></td>
</tr>
<tr>
<td class="name"><code>replaceWithZeroValues</code></td>
<td class="type">
<span class="param-type">Array.<String></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>Passed on to TableColumn, unless overridden by options.columnOptions.</p></td>
</tr>
<tr>
<td class="name"><code>columnOptions</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>An object with keys identifying columns (column names or indices),
and per-column properties displayDuration, replaceWithNullValues, replaceWithZeroValues, name, active, units and/or type.
For type, converts strings, which are case-insensitive keys of VarType, to their VarType integer.</p></td>
</tr>
<tr>
<td class="name"><code>getColorCallback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>Passed to DisplayVariableConcept.</p></td>
</tr>
<tr>
<td class="name"><code>sourceFeature</code></td>
<td class="type">
<span class="param-type">Entity</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>The feature to which this table applies, if any; not used internally by TableStructure or TableColumn.</p></td>
</tr>
<tr>
<td class="name"><code>idColumnNames</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>An array of column names/indexes/ids which identify unique features across rows
(see CsvCatalogItem.idColumns).</p></td>
</tr>
<tr>
<td class="name"><code>isSampled</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>Does this data correspond to "sampled" data?
See CsvCatalogItem.isSampled for an explanation.</p></td>
</tr>
<tr>
<td class="name"><code>shaveSeconds</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>How many seconds to shave off each time period so periods do not overlap. Defaults to 1 second.</p></td>
</tr>
<tr>
<td class="name"><code>finalEndJulianDate</code></td>
<td class="type">
<span class="param-type">JulianDate</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>If present, use this as the final end date for all points.</p></td>
</tr>
<tr>
<td class="name"><code>requireSomeActive</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>Set to true if at least one column must be selected at all times.</p></td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line66">line 66</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li><a href="DisplayVariablesConcept.html">DisplayVariablesConcept</a></li>
</ul>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id=".defaultDisplayVariableTypes"><span class="type-signature">(static) </span>defaultDisplayVariableTypes<span class="type-signature"> :Array</span></h4>
<div class="description">
<p>Expose the default display variable types.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line281">line 281</a>
</li></ul></dd>
</dl>
<h4 class="name" id="_activeTimeColumnNameIdOrIndex"><span class="type-signature"></span>_activeTimeColumnNameIdOrIndex<span class="type-signature"> :String|Number|Array.<String>|Array.<Number>|undefined</span></h4>
<div class="description">
<p>Gets or sets the active time column name, id or index.
If you pass an array of two such, eg. [0, 1], treats these as the start and end date column identifiers.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
|
<span class="param-type">Number</span>
|
<span class="param-type">Array.<String></span>
|
<span class="param-type">Array.<Number></span>
|
<span class="param-type">undefined</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line91">line 91</a>
</li></ul></dd>
</dl>
<h4 class="name" id="activeTimeColumn"><span class="type-signature"></span>activeTimeColumn<span class="type-signature"> :<a href="TableColumn.html">TableColumn</a></span></h4>
<div class="description">
<p>Gets the active time column for this structure. If two were provided (for the start and end times), return only the start date column.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="TableColumn.html">TableColumn</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line205">line 205</a>
</li></ul></dd>
</dl>
<h4 class="name" id="allowMultiple"><span class="type-signature"></span>allowMultiple<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets or sets a flag for whether more than one checkbox can be selected at a time.
Default false.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="DisplayVariablesConcept.html#allowMultiple">DisplayVariablesConcept#allowMultiple</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_DisplayVariablesConcept.js.html">Map/DisplayVariablesConcept.js</a>, <a href="Map_DisplayVariablesConcept.js.html#line43">line 43</a>
</li></ul></dd>
</dl>
<h4 class="name" id="color"><span class="type-signature"></span>color<span class="type-signature"> :String</span></h4>
<div class="description">
<p>String describing the color of this node, if applicable. This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="VariableConcept.html#color">VariableConcept#color</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_VariableConcept.js.html">Map/VariableConcept.js</a>, <a href="Map_VariableConcept.js.html#line53">line 53</a>
</li></ul></dd>
</dl>
<h4 class="name" id="columns"><span class="type-signature"></span>columns<span class="type-signature"> :Array.<<a href="TableColumn.html">TableColumn</a>></span></h4>
<div class="description">
<p>Gets or sets the columns for this structure.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<<a href="TableColumn.html">TableColumn</a>></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line118">line 118</a>
</li></ul></dd>
</dl>
<h4 class="name" id="exclusiveChildIds"><span class="type-signature"></span>exclusiveChildIds<span class="type-signature"> :Array.<String></span></h4>
<div class="description">
<p>Gets or sets a list of child ids which cannot be selected at the same time as any other child. Defaults to [].
Only relevant with allowMultiple = true.
Eg. Suppose the child concepts have ids "10" for 10 year olds, etc, plus "ALL" for all ages,
"U21" and "21PLUS" for under and over 21 year olds.
Then by specifying ["ALL", "U21", "21PLUS"], when the user selects one of these values, any other values will be unselected.
And when the user selects any other value (eg. "10"), if any of these values were selected, they will be unselected.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<String></span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="DisplayVariablesConcept.html#exclusiveChildIds">DisplayVariablesConcept#exclusiveChildIds</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_DisplayVariablesConcept.js.html">Map/DisplayVariablesConcept.js</a>, <a href="Map_DisplayVariablesConcept.js.html#line88">line 88</a>
</li></ul></dd>
</dl>
<h4 class="name" id="finishJulianDates"><span class="type-signature"></span>finishJulianDates<span class="type-signature"> :Array.<JulianDate></span></h4>
<div class="description">
<p>Returns an array of the finish Julian dates for each row. Only defined if there is an active time column.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<JulianDate></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line234">line 234</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getColorCallback"><span class="type-signature"></span>getColorCallback<span class="type-signature"> :function</span></h4>
<div class="description">
<p>Gets or sets a function with no arguments that returns a color for the VariableConcept. If undefined, no color is set (the default).</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">function</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="DisplayVariablesConcept.html#getColorCallback">DisplayVariablesConcept#getColorCallback</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_DisplayVariablesConcept.js.html">Map/DisplayVariablesConcept.js</a>, <a href="Map_DisplayVariablesConcept.js.html#line56">line 56</a>
</li></ul></dd>
</dl>
<h4 class="name" id="id"><span class="type-signature"></span>id<span class="type-signature"> :String</span></h4>
<div class="description">
<p>Gets or sets the id of the concept item. By default this is the same as the name.
It is allowed to be different eg. for csv files with tersely-named columns.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Concept.html#id">Concept#id</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_Concept.js.html">Map/Concept.js</a>, <a href="Map_Concept.js.html#line20">line 20</a>
</li></ul></dd>
</dl>
<h4 class="name" id="isActive"><span class="type-signature"></span>isActive<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets or sets a value indicating whether this variable is currently active.
This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="VariableConcept.html#isActive">VariableConcept#isActive</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_VariableConcept.js.html">Map/VariableConcept.js</a>, <a href="Map_VariableConcept.js.html#line41">line 41</a>
</li></ul></dd>
</dl>
<h4 class="name" id="isOpen"><span class="type-signature"></span>isOpen<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets or sets a value indicating whether this concept item is currently open. When an
item is open, its child items (if any) are visible. Default true.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="DisplayVariablesConcept.html#isOpen">DisplayVariablesConcept#isOpen</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_DisplayVariablesConcept.js.html">Map/DisplayVariablesConcept.js</a>, <a href="Map_DisplayVariablesConcept.js.html#line71">line 71</a>
</li></ul></dd>
</dl>
<h4 class="name" id="isSelectable"><span class="type-signature"></span>isSelectable<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets or sets a flag indicating whether this node is selectable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="DisplayVariablesConcept.html#isSelectable">DisplayVariablesConcept#isSelectable</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_DisplayVariablesConcept.js.html">Map/DisplayVariablesConcept.js</a>, <a href="Map_DisplayVariablesConcept.js.html#line77">line 77</a>
</li></ul></dd>
</dl>
<h4 class="name" id="isVisible"><span class="type-signature"></span>isVisible<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets or sets a value indicating whether this concept is visible. Defaults to true.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Concept.html#isVisible">Concept#isVisible</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_Concept.js.html">Map/Concept.js</a>, <a href="Map_Concept.js.html#line61">line 61</a>
</li></ul></dd>
</dl>
<h4 class="name" id="items"><span class="type-signature"></span>items<span class="type-signature"> :Array.<<a href="Concept.html">Concept</a>></span></h4>
<div class="description">
<p>Gets or sets the array of concepts contained in this group.
If options.items is present, each item's parent property is overridden with <code>this</code>.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<<a href="Concept.html">Concept</a>></span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="DisplayVariablesConcept.html#items">DisplayVariablesConcept#items</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_DisplayVariablesConcept.js.html">Map/DisplayVariablesConcept.js</a>, <a href="Map_DisplayVariablesConcept.js.html#line63">line 63</a>
</li></ul></dd>
</dl>
<h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :String</span></h4>
<div class="description">
<p>Gets or sets the name of the concept item. This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Concept.html#name">Concept#name</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_Concept.js.html">Map/Concept.js</a>, <a href="Map_Concept.js.html#line26">line 26</a>
</li></ul></dd>
</dl>
<h4 class="name" id="parent"><span class="type-signature"></span>parent<span class="type-signature"> :Array.<<a href="VariableConcept.html">VariableConcept</a>></span></h4>
<div class="description">
<p>Gets or sets the parent for a node. This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<<a href="VariableConcept.html">VariableConcept</a>></span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="VariableConcept.html#parent">VariableConcept#parent</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_VariableConcept.js.html">Map/VariableConcept.js</a>, <a href="Map_VariableConcept.js.html#line34">line 34</a>
</li></ul></dd>
</dl>
<h4 class="name" id="requireSomeActive"><span class="type-signature"></span>requireSomeActive<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets or sets a flag for whether at least one checkbox must be selected at all times.
Default false.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="DisplayVariablesConcept.html#requireSomeActive">DisplayVariablesConcept#requireSomeActive</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_DisplayVariablesConcept.js.html">Map/DisplayVariablesConcept.js</a>, <a href="Map_DisplayVariablesConcept.js.html#line50">line 50</a>
</li></ul></dd>
</dl>
<h4 class="name" id="timeIntervals"><span class="type-signature"></span>timeIntervals<span class="type-signature"> :Array.<TimeIntervalCollection></span></h4>
<div class="description">
<p>Returns an array describing when each row is visible. Only defined if there is an active time column.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<TimeIntervalCollection></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line219">line 219</a>
</li></ul></dd>
</dl>
<h4 class="name" id="toggleActiveCallback"><span class="type-signature"></span>toggleActiveCallback<span class="type-signature"> :function</span></h4>
<div class="description">
<p>Gets or sets a function which is called whenever a child item is successfully toggled.
Its sole argument is the toggled child item.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">function</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="DisplayVariablesConcept.html#toggleActiveCallback">DisplayVariablesConcept#toggleActiveCallback</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_DisplayVariablesConcept.js.html">Map/DisplayVariablesConcept.js</a>, <a href="Map_DisplayVariablesConcept.js.html#line95">line 95</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".fromCsv"><span class="type-signature">(static) </span>fromCsv<span class="signature">(csvString, result<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Create a TableStructure from a string in csv format.
Understands \r\n, \r and \n as newlines.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>csvString</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>String in csv format.</p></td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="TableStructure.html">TableStructure</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>A pre-existing TableStructure object; if not present, creates a new one.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line320">line 320</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".fromJson"><span class="type-signature">(static) </span>fromJson<span class="signature">(json, result<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Create a TableStructure from a JSON object, eg. [['x', 'y'], [1, 5], [3, 8], [4, -3]].</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>json</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>Table data as an object (in json format).</p></td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="TableStructure.html">TableStructure</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>A pre-existing TableStructure object; if not present, creates a new one.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line289">line 289</a>
</li></ul></dd>
</dl>
<h4 class="name" id="addColumn"><span class="type-signature"></span>addColumn<span class="signature">(name, values)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Add column to tableStructure.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>Name of column (column header).</p></td>
</tr>
<tr>
<td class="name"><code>values</code></td>
<td class="type">
<span class="param-type">Array.<Number></span>
</td>
<td class="description last"><p>Values of column to add to table.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line931">line 931</a>
</li></ul></dd>
</dl>
<h4 class="name" id="append"><span class="type-signature"></span>append<span class="signature">(table2, rowNumbers<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Appends table2 to this table. If rowNumbers are provided, only takes those
row numbers from table2.
Changes all the columns in one go, to avoid partial updates from tracked values.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>table2</code></td>
<td class="type">
<span class="param-type"><a href="TableStructure.html">TableStructure</a></span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The table to add to this one.</p></td>
</tr>
<tr>
<td class="name"><code>rowNumbers</code></td>
<td class="type">
<span class="param-type">Array.<Integer></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>The row numbers from table2 to add (defaults to all).</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line1016">line 1016</a>
</li></ul></dd>
</dl>
<h4 class="name" id="destroy"><span class="type-signature"></span>destroy<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Destroy the object and release resources. Is this necessary?</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line1286">line 1286</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getActiveColumns"><span class="type-signature"></span>getActiveColumns<span class="signature">()</span><span class="type-signature"> → {Array.<<a href="TableColumn.html">TableColumn</a>>}</span></h4>
<div class="description">
<p>Returns an array of active columns.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line390">line 390</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>An array of active columns.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<<a href="TableColumn.html">TableColumn</a>></span>
</dd>
</dl>
<h4 class="name" id="getChartDetailsForRowNumbers"><span class="type-signature"></span>getChartDetailsForRowNumbers<span class="signature">(rowNumbers<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Object}</span></h4>
<div class="description">
<p>Given an optional array of row numbers of the table which you would like to make into a chart,
returns the key information for that chart, ie. the data (in csv string format), units, and x and y labels.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>rowNumbers</code></td>
<td class="type">
<span class="param-type">Array.<Number></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>The row numbers.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line1217">line 1217</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>An object with xName, yName, csvData (Strings) and units (String[]) properties.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
<h4 class="name" id="getColumnAliases"><span class="type-signature"></span>getColumnAliases<span class="signature">()</span><span class="type-signature"> → {Array.<Object>}</span></h4>
<div class="description">
<p>Provide an array which maps ids to names, if they differ.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line757">line 757</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>An array of objects with 'id' and 'name' properties; only where the id and name differ.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<Object></span>
</dd>
</dl>
<h4 class="name" id="getColumnIndex"><span class="type-signature"></span>getColumnIndex<span class="signature">(id)</span><span class="type-signature"> → {Number}</span></h4>
<div class="description">
<p>Given an id, find the index of the column and return that.
Will return undefined if column with matching id cannot be found in tableStructure.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>Id of column to find index of.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line1201">line 1201</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>index of column.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Number</span>
</dd>
</dl>
<h4 class="name" id="getColumnNames"><span class="type-signature"></span>getColumnNames<span class="signature">()</span><span class="type-signature"> → {Array.<String>}</span></h4>
<div class="description">
<p>Get the column names.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line834">line 834</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Array of column names.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<String></span>
</dd>
</dl>
<h4 class="name" id="getColumnsWithFeatureRowsAtStartAndEndDates"><span class="type-signature"></span>getColumnsWithFeatureRowsAtStartAndEndDates<span class="signature">(timeColumnNameIdOrIndex, valueColumnNameIdOrIndex)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Returns new columns for this table structure that include rows for all features at the full table's start and end dates,
if they do not already exist. The data for all columns is copied from the feature's start and end date row,
except for the provided valueColumn, which is set to null.
Pass the time column explicitly if desired, to override this.activeTimeColumn. (Useful if you want to call this before setting it.)
It is recommended if you use this, to also set the table's finalEndJulianDate beforehand, so the new feature rows don't blow out the end dates.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>timeColumnNameIdOrIndex</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">Integer</span>
</td>
<td class="description last"><p>Name, id or index of the time column.</p></td>
</tr>
<tr>
<td class="name"><code>valueColumnNameIdOrIndex</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">Integer</span>
</td>
<td class="description last"><p>Name, id or index of the column which should be set to null at the table's start and end dates.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line1239">line 1239</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getColumnWithName"><span class="type-signature"></span>getColumnWithName<span class="signature">(name, columns<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="TableColumn.html">TableColumn</a>}</span></h4>
<div class="description">
<p>Returns the first column with the given name, or undefined if none match.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The column name.</p></td>
</tr>
<tr>
<td class="name"><code>columns</code></td>
<td class="type">
<span class="param-type">Array.<<a href="TableColumn.html">TableColumn</a>></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>If provided, test on these columns instead of this.columns.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line849">line 849</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The matching column.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="TableColumn.html">TableColumn</a></span>
</dd>
</dl>
<h4 class="name" id="getColumnWithNameIdOrIndex"><span class="type-signature"></span>getColumnWithNameIdOrIndex<span class="signature">(nameIdOrIndex)</span><span class="type-signature"> → {<a href="TableColumn.html">TableColumn</a>}</span></h4>
<div class="description">
<p>Returns the first column with the given name, id or index, or undefined if none match (or null is passed in).</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nameIdOrIndex</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">Integer</span>
|
<span class="param-type">null</span>
</td>
<td class="description last"><p>The column name, id or index.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line921">line 921</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The matching column.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="TableColumn.html">TableColumn</a></span>
</dd>
</dl>
<h4 class="name" id="getColumnWithNameOrId"><span class="type-signature"></span>getColumnWithNameOrId<span class="signature">(nameOrId)</span><span class="type-signature"> → {<a href="TableColumn.html">TableColumn</a>}</span></h4>
<div class="description">
<p>Returns the first column with the given name or id, or undefined if none match.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nameOrId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The column name or id.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line912">line 912</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The matching column.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="TableColumn.html">TableColumn</a></span>
</dd>
</dl>
<h4 class="name" id="getIdMapping"><span class="type-signature"></span>getIdMapping<span class="signature">(idColumnNames<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Object}</span></h4>
<div class="description">
<p>Returns a mapping from the idColumnNames to all the rows in the table with that id.
If no columnIdNames are defined, returns undefined.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>idColumnNames</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Provide if you wish to override this table's own idColumnNames.
This is supplied to getColumnWithNameIdOrIndex, so the "names" could be ids or indexes too.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line990">line 990</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>An object with keys equal to idStrings (use tableStructure.getIdStringForRowNumber(i) to get this)
and values equal to an array of rowNumbers.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
<h4 class="name" id="getIdStringForRowNumber"><span class="type-signature"></span>getIdStringForRowNumber<span class="signature">(rowNumber, idColumnNames<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Object}</span></h4>
<div class="description">
<p>Returns an id string for the given row, based on idColumns (defaulting to idColumnNames).
Use this to index into the result of this.getIdMapping().</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>rowNumber</code></td>
<td class="type">
<span class="param-type">Integer</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The row number.</p></td>
</tr>
<tr>
<td class="name"><code>idColumnNames</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>An array of id column names (or indexes or ids).</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line959">line 959</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>An id string for that row based on joining the id column values for that row such as "Newtown^^NSW".</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
<h4 class="name" id="getNodes"><span class="type-signature"></span>getNodes<span class="signature">(condition)</span><span class="type-signature"> → {Array.<<a href="Concept.html">Concept</a>>}</span></h4>
<div class="description">
<p>Gets a flat array of all of this concept's descendants, including itself, which meet a given condition.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>condition</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last"><p>A function of a concept, which returns a boolean.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="DisplayVariablesConcept.html#getNodes">DisplayVariablesConcept#getNodes</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_DisplayVariablesConcept.js.html">Map/DisplayVariablesConcept.js</a>, <a href="Map_DisplayVariablesConcept.js.html#line125">line 125</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<<a href="Concept.html">Concept</a>></span>
</dd>
</dl>
<h4 class="name" id="getUpdatedColumns"><span class="type-signature"></span>getUpdatedColumns<span class="signature">(updatedColumnValuesArrays)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Updates this table's columns with new ones, using the existing columns' metadata, and replacing the column values.
If a time column is present, reset it, which can involve sorting the columns.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>updatedColumnValuesArrays</code></td>
<td class="type">
<span class="param-type">Array.<Array></span>
</td>
<td class="description last"><p>Array of values arrays.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line1002">line 1002</a>
</li></ul></dd>
</dl>
<h4 class="name" id="loadFromCsv"><span class="type-signature"></span>loadFromCsv<span class="signature">(csvString)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Load a string in csv format into an existing TableStructure.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>csvString</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>String in csv format.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line382">line 382</a>
</li></ul></dd>
</dl>
<h4 class="name" id="loadFromJson"><span class="type-signature"></span>loadFromJson<span class="signature">(json)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Load a JSON object into an existing TableStructure.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>json</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>Table data as an object (in json format).</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line373">line 373</a>
</li></ul></dd>
</dl>
<h4 class="name" id="merge"><span class="type-signature"></span>merge<span class="signature">(table2)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Merges the rows of table2 into the rows of this table.
Uses this.idColumnNames (and this.activeTimeColumn, if present) to identify matching rows.
The columns must be in the same order in the two tables.
Changes all the columns in one go, to avoid partial updates from tracked values.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>table2</code></td>
<td class="type">
<span class="param-type"><a href="TableStructure.html">TableStructure</a></span>
</td>
<td class="description last"><p>The table to merge into this one.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line1077">line 1077</a>
</li></ul></dd>
</dl>
<h4 class="name" id="replaceRows"><span class="type-signature"></span>replaceRows<span class="signature">(table2, replacementMap)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Replace specific rows in this table with rows in table2.
Changes all the columns in one go, to avoid partial updates from tracked values.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>table2</code></td>
<td class="type">
<span class="param-type"><a href="TableStructure.html">TableStructure</a></span>
</td>
<td class="description last"><p>The table whose rows should replace this table's rows.</p></td>
</tr>
<tr>
<td class="name"><code>replacementMap</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>An object whose properties are {table 1 row number: table 2 row number}.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line1043">line 1043</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setActiveTimeColumn"><span class="type-signature"></span>setActiveTimeColumn<span class="signature">(nameIdOrIndex)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Sets the relevant active time column on the table structure, defaulting to the first time column present
unless the tableStyle has a 'timeColumn' property. A null timeColumn should explicitly not have a time column, even if one is present.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nameIdOrIndex</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">Number</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>A way to identify the column, eg. from tableStyle.timeColumn.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line1128">line 1128</a>
</li></ul></dd>
</dl>
<h4 class="name" id="sortBy"><span class="type-signature"></span>sortBy<span class="signature">(sortColumn, compareFunction<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Sorts the rows of the TableStructure by the provided column's values.
If the sortColumn is a date/time column, uses its julianDates to sort; otherwise, the values.
The tableStructure is given new TableColumns.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>sortColumn</code></td>
<td class="type">
<span class="param-type"><a href="TableColumn.html">TableColumn</a></span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>Column whose values should be sorted.</p></td>
</tr>
<tr>
<td class="name"><code>compareFunction</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>The compare function passed to Array.prototype.sort().</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line1191">line 1191</a>
</li></ul></dd>
</dl>
<h4 class="name" id="toArrayOfColumns"><span class="type-signature"></span>toArrayOfColumns<span class="signature">()</span><span class="type-signature"> → {Object}</span></h4>
<div class="description">
<p>Return data as an array of columns, eg. [ ['x', 1, 2, 3], ['y', 10, 20, 5] ].</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line611">line 611</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>An array of column arrays, each beginning with the column name.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
<h4 class="name" id="toArrayOfRows"><span class="type-signature"></span>toArrayOfRows<span class="signature">(dateFormatString<span class="signature-attributes">opt</span>, rowNumbers<span class="signature-attributes">opt</span>, formatScalars<span class="signature-attributes">opt</span>, quoteStringsIfNeeded<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Object}</span></h4>
<div class="description">
<p>Return data as an array of rows of formatted data, eg. [ ['x', 'y'], ['1', '12,345'], ['2.1', '20'] ].</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>dateFormatString</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>If present, override the standard date format with a string (see https://<a href="http://www.npmjs.com/package/dateformat">www.npmjs.com/package/dateformat</a>)
Eg. "isoDateTime" or "dd mmm yyyy HH:MM:ss".
"source" is a special override which uses the original source date format.</p></td>
</tr>
<tr>
<td class="name"><code>rowNumbers</code></td>
<td class="type">
<span class="param-type">Array.<Integer></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>An array of row numbers to return. Defaults to all rows.</p></td>
</tr>
<tr>
<td class="name"><code>formatScalars</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>True by default; if false, leave numbers as they are.</p></td>
</tr>
<tr>
<td class="name"><code>quoteStringsIfNeeded</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>False by default; if true, any strings which contain commas will be quoted (including column names).</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line631">line 631</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>An array of rows of formatted data, the first of which is the column names. If they contain commas, they are quoted.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
<h4 class="name" id="toCsvString"><span class="type-signature"></span>toCsvString<span class="signature">(dateFormatString<span class="signature-attributes">opt</span>, rowNumbers<span class="signature-attributes">opt</span>, formatScalars<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {String}</span></h4>
<div class="description">
<p>Return data as a csv string with formatted values, eg. 'x,y\n1,"12,345"\n2.1,20'.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>dateFormatString</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>If present, override the standard date format with a string (see https://<a href="http://www.npmjs.com/package/dateformat">www.npmjs.com/package/dateformat</a>)
Eg. "isoDateTime" or "dd mmm yyyy HH:MM:ss".
"source" is a special override which uses the original source date format.</p></td>
</tr>
<tr>
<td class="name"><code>rowNumbers</code></td>
<td class="type">
<span class="param-type">Array.<Integer></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>An array of row numbers to return. Defaults to all rows.</p></td>
</tr>
<tr>
<td class="name"><code>formatScalars</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>True by default; if false, leave numbers as they are.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line693">line 693</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Returns the data as a csv string, including the header row.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
<h4 class="name" id="toggleActive"><span class="type-signature"></span>toggleActive<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Toggles the <a href="VariableConcept.html#isActive">VariableConcept#isActive</a> property, by using the parent's toggleActiveItem (if defined), or else manually.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="VariableConcept.html#toggleActive">VariableConcept#toggleActive</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_VariableConcept.js.html">Map/VariableConcept.js</a>, <a href="Map_VariableConcept.js.html#line74">line 74</a>
</li></ul></dd>
</dl>
<h4 class="name" id="toggleActiveItem"><span class="type-signature"></span>toggleActiveItem<span class="signature">(concept)</span><span class="type-signature"></span></h4>
<div class="description">
<p>If appropriate, based on this.allowMultiple, this.requireSomeActive and this.exclusiveChildIds,
sets the <a href="VariableConcept.html#isActive">VariableConcept#isActive</a> property on all children, so that <em>only</em> the provided concept is activated.
This is called by the VariableConcept's toggleActive function.
If not appropriate, simply toggles the concept without changing any others.
(For backwards compatibility, VariableConcept does not call this function if there's no possibility it's needed.)</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>concept</code></td>
<td class="type">
<span class="param-type"><a href="VariableConcept.html">VariableConcept</a></span>
</td>
<td class="description last"><p>The concept to make active/inactive.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="DisplayVariablesConcept.html#toggleActiveItem">DisplayVariablesConcept#toggleActiveItem</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_DisplayVariablesConcept.js.html">Map/DisplayVariablesConcept.js</a>, <a href="Map_DisplayVariablesConcept.js.html#line148">line 148</a>
</li></ul></dd>
</dl>
<h4 class="name" id="toggleOpen"><span class="type-signature"></span>toggleOpen<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Toggles the <a href="Concept.html#isOpen">Concept#isOpen</a> property. If this item's list of children is open,
calling this method will close it. If the list is closed, calling this method will open it.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Concept.html#toggleOpen">Concept#toggleOpen</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_Concept.js.html">Map/Concept.js</a>, <a href="Map_Concept.js.html#line89">line 89</a>
</li></ul></dd>
</dl>
<h4 class="name" id="toPointArrays"><span class="type-signature"></span>toPointArrays<span class="signature">(xColumn<span class="signature-attributes">opt</span>, yColumns<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array.<Array>}</span></h4>
<div class="description">
<p>Returns the active columns as an array of arrays of objects with x and y properties, using js dates for x values if available.
Useful for plotting the data.
Eg. "a,b,c\n1,2,3\n4,5,6" => [[{x: 1, y: 2}, {x: 4, y: 5}], [{x: 1, y: 3}, {x: 4, y: 6}]].</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>xColumn</code></td>
<td class="type">
<span class="param-type"><a href="TableColumn.html">TableColumn</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Which column to use for the x values. Defaults to the first column.</p></td>
</tr>
<tr>
<td class="name"><code>yColumns</code></td>
<td class="type">
<span class="param-type">Array.<<a href="TableColumn.html">TableColumn</a>></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Which columns to use for the y values. Defaults to all columns excluding xColumn.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line811">line 811</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The data as arrays of objects.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<Array></span>
</dd>
</dl>
<h4 class="name" id="toRowDescriptions"><span class="type-signature"></span>toRowDescriptions<span class="signature">(featureInfoFields<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array.<String>}</span></h4>
<div class="description">
<p>Returns data as an array of html for each row.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>featureInfoFields</code></td>
<td class="type">
<span class="param-type">Array</span>
|
<span class="param-type">Object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Either an array of keys from the row objects, or an object that maps keys to names of keys.
If not provided, defaults to using all keys unaltered.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line789">line 789</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Array of html for each row.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<String></span>
</dd>
</dl>
<h4 class="name" id="toRowObjects"><span class="type-signature"></span>toRowObjects<span class="signature">()</span><span class="type-signature"> → {Array.<Object>}</span></h4>
<div class="description">
<p>Return data as an array of rows of objects, eg. [{'x': 1, 'y': 10}, {'x': 2, 'y': 20}, ...].
Note this won't work if a column name is a javascript reserved word.
Has the same arguments as TableStructure.prototype.toArrayOfRows.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line705">line 705</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Array of objects containing a property for each column of the row. If the table has no data, returns [].</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<Object></span>
</dd>
</dl>
<h4 class="name" id="toStringAndNumberRowObjects"><span class="type-signature"></span>toStringAndNumberRowObjects<span class="signature">(dateFormatString<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array.<Object>}</span></h4>
<div class="description">
<p>Return data as an array of rows of objects with string and number values, eg.
[{'string': {'x': '12,345', 'y': '10'}, 'number': {'x': 12345, 'y': 10}}, {'string': {'x':...}, ...}].</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>dateFormatString</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>If present, override the standard date format with a string (see https://<a href="http://www.npmjs.com/package/dateformat">www.npmjs.com/package/dateformat</a>)
Eg. "isoDateTime" or "dd mmm yyyy HH:MM:ss".
"source" is a special override which uses the original source date format.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line730">line 730</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Array of objects with "string" and "number" properties, whose properties are the column names.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<Object></span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AbsCode.html">AbsCode</a></li><li><a href="AbsConcept.html">AbsConcept</a></li><li><a href="AbsDataset.html">AbsDataset</a></li><li><a href="AbsIttCatalogGroup.html">AbsIttCatalogGroup</a></li><li><a href="AbsIttCatalogItem.html">AbsIttCatalogItem</a></li><li><a href="AddressGeocoder.html">AddressGeocoder</a></li><li><a href="ArcGisCatalogGroup.html">ArcGisCatalogGroup</a></li><li><a href="ArcGisFeatureServerCatalogGroup.html">ArcGisFeatureServerCatalogGroup</a></li><li><a href="ArcGisFeatureServerCatalogItem.html">ArcGisFeatureServerCatalogItem</a></li><li><a href="ArcGisMapServerCatalogGroup.html">ArcGisMapServerCatalogGroup</a></li><li><a href="ArcGisMapServerCatalogItem.html">ArcGisMapServerCatalogItem</a></li><li><a href="AugmentedVirtuality.html">AugmentedVirtuality</a></li><li><a href="BingMapsCatalogItem.html">BingMapsCatalogItem</a></li><li><a href="BooleanParameter.html">BooleanParameter</a></li><li><a href="BulkAddressGeocoderResult.html">BulkAddressGeocoderResult</a></li><li><a href="CameraView.html">CameraView</a></li><li><a href="Catalog.html">Catalog</a></li><li><a href="CatalogFunction.html">CatalogFunction</a></li><li><a href="CatalogGroup.html">CatalogGroup</a></li><li><a href="CatalogItem.html">CatalogItem</a></li><li><a href="CatalogMember.html">CatalogMember</a></li><li><a href="Cesium.html">Cesium</a></li><li><a href="Cesium3DTilesCatalogItem.html">Cesium3DTilesCatalogItem</a></li><li><a href="CesiumDragPoints.html">CesiumDragPoints</a></li><li><a href="CesiumTerrainCatalogItem.html">CesiumTerrainCatalogItem</a></li><li><a href="CkanCatalogGroup.html">CkanCatalogGroup</a></li><li><a href="CkanCatalogItem.html">CkanCatalogItem</a></li><li><a href="Clock.html">Clock</a></li><li><a href="CompositeCatalogItem.html">CompositeCatalogItem</a></li><li><a href="Concept.html">Concept</a></li><li><a href="CorsProxy.html">CorsProxy</a></li><li><a href="CsvCatalogItem.html">CsvCatalogItem</a></li><li><a href="CswCatalogGroup.html">CswCatalogGroup</a></li><li><a href="CustomComponentType.html">CustomComponentType</a></li><li><a href="CzmlCatalogItem.html">CzmlCatalogItem</a></li><li><a href="DataSourceCatalogItem.html">DataSourceCatalogItem</a></li><li><a href="DateTimeParameter.html">DateTimeParameter</a></li><li><a href="DisplayVariablesConcept.html">DisplayVariablesConcept</a></li><li><a href="EnumerationParameter.html">EnumerationParameter</a></li><li><a href="Feature.html">Feature</a></li><li><a href="FunctionParameter.html">FunctionParameter</a></li><li><a href="GeoJsonCatalogItem.html">GeoJsonCatalogItem</a></li><li><a href="GlobeOrMap.html">GlobeOrMap</a></li><li><a href="GnafAddressGeocoder.html">GnafAddressGeocoder</a></li><li><a href="GnafApi.html">GnafApi</a></li><li><a href="GnafSearchProviderViewModel.html">GnafSearchProviderViewModel</a></li><li><a href="GpxCatalogItem.html">GpxCatalogItem</a></li><li><a href="HelpScreen.html">HelpScreen</a></li><li><a href="HelpSequence.html">HelpSequence</a></li><li><a href="HelpSequences.html">HelpSequences</a></li><li><a href="HelpViewState.html">HelpViewState</a></li><li><a href="ImageryLayerCatalogItem____.html">ImageryLayerCatalogItem</a></li><li><a href="IonImageryCatalogItem.html">IonImageryCatalogItem</a></li><li><a href="KmlCatalogItem.html">KmlCatalogItem</a></li><li><a href="Leaflet.html">Leaflet</a></li><li><a href="LeafletDataSourceDisplay.html">LeafletDataSourceDisplay</a></li><li><a href="LeafletDragPoints.html">LeafletDragPoints</a></li><li><a href="LeafletGeomVisualizer.html">LeafletGeomVisualizer</a></li><li><a href="LegendHelper.html">LegendHelper</a></li><li><a href="LegendUrl.html">LegendUrl</a></li><li><a href="LineParameter.html">LineParameter</a></li><li><a href="MagdaCatalogItem.html">MagdaCatalogItem</a></li><li><a href="MapboxMapCatalogItem.html">MapboxMapCatalogItem</a></li><li><a href="MapInteractionMode.html">MapInteractionMode</a></li><li><a href="Metadata.html">Metadata</a></li><li><a href="MetadataItem.html">MetadataItem</a></li><li><a href="module.html#.exports">exports</a></li><li><a href="OgrCatalogItem.html">OgrCatalogItem</a></li><li><a href="OpenStreetMapCatalogItem.html">OpenStreetMapCatalogItem</a></li><li><a href="PlacesLikeMeCatalogfunction.html">PlacesLikeMeCatalogfunction</a></li><li><a href="PointParameter.html">PointParameter</a></li><li><a href="Polling.html">Polling</a></li><li><a href="PolygonParameter.html">PolygonParameter</a></li><li><a href="RectangleParameter.html">RectangleParameter</a></li><li><a href="RegionDataParameter.html">RegionDataParameter</a></li><li><a href="RegionMapping.html">RegionMapping</a></li><li><a href="RegionParameter.html">RegionParameter</a></li><li><a href="RegionProvider.html">RegionProvider</a></li><li><a href="RegionProviderList.html">RegionProviderList</a></li><li><a href="RegionTypeParameter.html">RegionTypeParameter</a></li><li><a href="ResultPendingCatalogItem.html">ResultPendingCatalogItem</a></li><li><a href="SdmxJsonCatalogItem.html">SdmxJsonCatalogItem</a></li><li><a href="SensorObservationServiceCatalogItem.html">SensorObservationServiceCatalogItem</a></li><li><a href="SocrataCatalogGroup.html">SocrataCatalogGroup</a></li><li><a href="SpatialDetailingCatalogFunction.html">SpatialDetailingCatalogFunction</a></li><li><a href="StringParameter.html">StringParameter</a></li><li><a href="SummaryConcept.html">SummaryConcept</a></li><li><a href="TableCatalogItem.html">TableCatalogItem</a></li><li><a href="TableColumn.html">TableColumn</a></li><li><a href="TableColumnStyle.html">TableColumnStyle</a></li><li><a href="TableDataSource.html">TableDataSource</a></li><li><a href="TableStructure.html">TableStructure</a></li><li><a href="TableStyle.html">TableStyle</a></li><li><a href="TerrainCatalogItem.html">TerrainCatalogItem</a></li><li><a href="Terria.html">Terria</a></li><li><a href="TerriaError.html">TerriaError</a></li><li><a href="TerriaJsonCatalogFunction.html">TerriaJsonCatalogFunction</a></li><li><a href="TimeSeriesStack.html">TimeSeriesStack</a></li><li><a href="UrlTemplateCatalogItem.html">UrlTemplateCatalogItem</a></li><li><a href="UrthecastCatalogGroup.html">UrthecastCatalogGroup</a></li><li><a href="UrthecastServerCatalogItem.html">UrthecastServerCatalogItem</a></li><li><a href="UserDrawing.html">UserDrawing</a></li><li><a href="VariableConcept.html">VariableConcept</a></li><li><a href="ViewerModes..html">ViewerModes.</a></li><li><a href="WebFeatureServiceCatalogGroup.html">WebFeatureServiceCatalogGroup</a></li><li><a href="WebFeatureServiceCatalogItem.html">WebFeatureServiceCatalogItem</a></li><li><a href="WebMapServiceCatalogGroup.html">WebMapServiceCatalogGroup</a></li><li><a href="WebMapServiceCatalogItem.html">WebMapServiceCatalogItem</a></li><li><a href="WebMapTileServiceCatalogGroup.html">WebMapTileServiceCatalogGroup</a></li><li><a href="WebMapTileServiceCatalogItem.html">WebMapTileServiceCatalogItem</a></li><li><a href="WebProcessingServiceCatalogFunction.html">WebProcessingServiceCatalogFunction</a></li><li><a href="WebProcessingServiceCatalogGroup.html">WebProcessingServiceCatalogGroup</a></li><li><a href="WebProcessingServiceCatalogItem.html">WebProcessingServiceCatalogItem</a></li><li><a href="WfsFeaturesCatalogGroup.html">WfsFeaturesCatalogGroup</a></li><li><a href="WhyAmISpecialCatalogFunction.html">WhyAmISpecialCatalogFunction</a></li></ul><h3>Global</h3><ul><li><a href="global.html#_bumpyTerrainProvider">_bumpyTerrainProvider</a></li><li><a href="global.html#_terrain">_terrain</a></li><li><a href="global.html#activeTimeColumnNameIdOrIndex">activeTimeColumnNameIdOrIndex</a></li><li><a href="global.html#addBoundingBox">addBoundingBox</a></li><li><a href="global.html#addMarker">addMarker</a></li><li><a href="global.html#addUserCatalogMember">addUserCatalogMember</a></li><li><a href="global.html#allFeaturesAvailablePromise">allFeaturesAvailablePromise</a></li><li><a href="global.html#allShareKeys">allShareKeys</a></li><li><a href="global.html#arrayProduct">arrayProduct</a></li><li><a href="global.html#barHeightMax">barHeightMax</a></li><li><a href="global.html#barHeightMin">barHeightMin</a></li><li><a href="global.html#barLeft">barLeft</a></li><li><a href="global.html#barTop">barTop</a></li><li><a href="global.html#buildEmptyAccumulator">buildEmptyAccumulator</a></li><li><a href="global.html#buildRequestData">buildRequestData</a></li><li><a href="global.html#buildShareLink">buildShareLink</a></li><li><a href="global.html#buildShortShareLink">buildShortShareLink</a></li><li><a href="global.html#calculateFinishDatesFromStartDates">calculateFinishDatesFromStartDates</a></li><li><a href="global.html#canShorten">canShorten</a></li><li><a href="global.html#categoryName">categoryName</a></li><li><a href="global.html#ChartData">ChartData</a></li><li><a href="global.html#color">color</a></li><li><a href="global.html#ColorMap">ColorMap</a></li><li><a href="global.html#combineData">combineData</a></li><li><a href="global.html#combineFilters">combineFilters</a></li><li><a href="global.html#combineRepeated">combineRepeated</a></li><li><a href="global.html#combineValueArrays">combineValueArrays</a></li><li><a href="global.html#computeRingWindingOrder">computeRingWindingOrder</a></li><li><a href="global.html#computeScreenSpacePosition">computeScreenSpacePosition</a></li><li><a href="global.html#config">config</a></li><li><a href="global.html#containsAny">containsAny</a></li><li><a href="global.html#convertLuceneHit">convertLuceneHit</a></li><li><a href="global.html#convertToDates">convertToDates</a></li><li><a href="global.html#correctEntityHeight">correctEntityHeight</a></li><li><a href="global.html#createCatalogItemFromFileOrUrl">createCatalogItemFromFileOrUrl</a></li><li><a href="global.html#createCatalogItemFromUrl">createCatalogItemFromUrl</a></li><li><a href="global.html#createCatalogMemberFromType">createCatalogMemberFromType</a></li><li><a href="global.html#createLeafletCredit">createLeafletCredit</a></li><li><a href="global.html#createParameterFromType">createParameterFromType</a></li><li><a href="global.html#createRegexDeserializer">createRegexDeserializer</a></li><li><a href="global.html#createRegexSerializer">createRegexSerializer</a></li><li><a href="global.html#cssClass">cssClass</a></li><li><a href="global.html#CustomComponents">CustomComponents</a></li><li><a href="global.html#deIndexWithDescendants">deIndexWithDescendants</a></li><li><a href="global.html#Description">Description</a></li><li><a href="global.html#direction">direction</a></li><li><a href="global.html#disposeSubscription">disposeSubscription</a></li><li><a href="global.html#EarthGravityModel1996">EarthGravityModel1996</a></li><li><a href="global.html#error">error</a></li><li><a href="global.html#extendLoad">extendLoad</a></li><li><a href="global.html#extent">extent</a></li><li><a href="global.html#featureClicked">featureClicked</a></li><li><a href="global.html#featureDataToGeoJson">featureDataToGeoJson</a></li><li><a href="global.html#featureMousedown">featureMousedown</a></li><li><a href="global.html#features">features</a></li><li><a href="global.html#findKeyForGroupElement">findKeyForGroupElement</a></li><li><a href="global.html#flattenCatalog">flattenCatalog</a></li><li><a href="global.html#formatDate">formatDate</a></li><li><a href="global.html#formatDateTime">formatDateTime</a></li><li><a href="global.html#formatNumberForLocale">formatNumberForLocale</a></li><li><a href="global.html#formatPropertyValue">formatPropertyValue</a></li><li><a href="global.html#formatTime">formatTime</a></li><li><a href="global.html#getAncestors">getAncestors</a></li><li><a href="global.html#getColumnOptions">getColumnOptions</a></li><li><a href="global.html#getColumnWithNameIdOrIndex">getColumnWithNameIdOrIndex</a></li><li><a href="global.html#getDataUriFormat">getDataUriFormat</a></li><li><a href="global.html#getGroupChildren">getGroupChildren</a></li><li><a href="global.html#getShareData">getShareData</a></li><li><a href="global.html#getTemporalFiltersContext">getTemporalFiltersContext</a></li><li><a href="global.html#getUniqueValues">getUniqueValues</a></li><li><a href="global.html#gmlToGeoJson">gmlToGeoJson</a></li><li><a href="global.html#gradientColorMap">gradientColorMap</a></li><li><a href="global.html#hasAddress">hasAddress</a></li><li><a href="global.html#hasChildren">hasChildren</a></li><li><a href="global.html#hasLatitudeAndLongitude">hasLatitudeAndLongitude</a></li><li><a href="global.html#hostInDomains">hostInDomains</a></li><li><a href="global.html#id">id</a></li><li><a href="global.html#infoWithoutSources">infoWithoutSources</a></li><li><a href="global.html#isBrowserCompatible">isBrowserCompatible</a></li><li><a href="global.html#isCommonMobilePlatform">isCommonMobilePlatform</a></li><li><a href="global.html#isLoading">isLoading</a></li><li><a href="global.html#isVisible">isVisible</a></li><li><a href="global.html#itemHeight">itemHeight</a></li><li><a href="global.html#itemHeightMin">itemHeightMin</a></li><li><a href="global.html#items">items</a></li><li><a href="global.html#itemSpacing">itemSpacing</a></li><li><a href="global.html#itemWidth">itemWidth</a></li><li><a href="global.html#Legend">Legend</a></li><li><a href="global.html#legendUrl">legendUrl</a></li><li><a href="global.html#map">map</a></li><li><a href="global.html#markdownToHtml">markdownToHtml</a></li><li><a href="global.html#markerVisible">markerVisible</a></li><li><a href="global.html#name">name</a></li><li><a href="global.html#NowViewing">NowViewing</a></li><li><a href="global.html#overrideProperty">overrideProperty</a></li><li><a href="global.html#pad">pad</a></li><li><a href="global.html#parseCustomHtmlToReact">parseCustomHtmlToReact</a></li><li><a href="global.html#parseCustomMarkdownToReact">parseCustomMarkdownToReact</a></li><li><a href="global.html#PickedFeatures">PickedFeatures</a></li><li><a href="global.html#pickPosition">pickPosition</a></li><li><a href="global.html#point">point</a></li><li><a href="global.html#points">points</a></li><li><a href="global.html#position">position</a></li><li><a href="global.html#prettifyCoordinates">prettifyCoordinates</a></li><li><a href="global.html#prettifyProjection">prettifyProjection</a></li><li><a href="global.html#printWindow">printWindow</a></li><li><a href="global.html#processAddress">processAddress</a></li><li><a href="global.html#Proj4Definitions">Proj4Definitions</a></li><li><a href="global.html#propertyGetTimeValues">propertyGetTimeValues</a></li><li><a href="global.html#readJson">readJson</a></li><li><a href="global.html#rectangle">rectangle</a></li><li><a href="global.html#rectangleToLatLngBounds">rectangleToLatLngBounds</a></li><li><a href="global.html#RegionDataValue">RegionDataValue</a></li><li><a href="global.html#regionDetails">regionDetails</a></li><li><a href="global.html#registerCustomComponentTypes">registerCustomComponentTypes</a></li><li><a href="global.html#rememberRejections">rememberRejections</a></li><li><a href="global.html#removeMarker">removeMarker</a></li><li><a href="global.html#replaceUnderscores">replaceUnderscores</a></li><li><a href="global.html#sanitiseAddressNumber">sanitiseAddressNumber</a></li><li><a href="global.html#selectBaseMap">selectBaseMap</a></li><li><a href="global.html#serializeToJson">serializeToJson</a></li><li><a href="global.html#ServerConfig">ServerConfig</a></li><li><a href="global.html#setClockCurrentTime">setClockCurrentTime</a></li><li><a href="global.html#shareKeyIndex">shareKeyIndex</a></li><li><a href="global.html#shouldBeUpdated">shouldBeUpdated</a></li><li><a href="global.html#showSelection">showSelection</a></li><li><a href="global.html#sortByFirst">sortByFirst</a></li><li><a href="global.html#sortedIndices">sortedIndices</a></li><li><a href="global.html#splitIntoBatches">splitIntoBatches</a></li><li><a href="global.html#supportsIntervals">supportsIntervals</a></li><li><a href="global.html#supportsWebGL">supportsWebGL</a></li><li><a href="global.html#TerriaViewer">TerriaViewer</a></li><li><a href="global.html#Title">Title</a></li><li><a href="global.html#toArrayOfRows">toArrayOfRows</a></li><li><a href="global.html#Tooltip">Tooltip</a></li><li><a href="global.html#triggerResize">triggerResize</a></li><li><a href="global.html#unionRectangleArray">unionRectangleArray</a></li><li><a href="global.html#unionRectangles">unionRectangles</a></li><li><a href="global.html#units">units</a></li><li><a href="global.html#up">up</a></li><li><a href="global.html#updateApplicationOnHashChange">updateApplicationOnHashChange</a></li><li><a href="global.html#updateFromJson">updateFromJson</a></li><li><a href="global.html#updateRectangleFromRegion">updateRectangleFromRegion</a></li><li><a href="global.html#variableNameLeft">variableNameLeft</a></li><li><a href="global.html#variableNameTop">variableNameTop</a></li><li><a href="global.html#ViewerMode">ViewerMode</a></li><li><a href="global.html#width">width</a></li><li><a href="global.html#yAxisMax">yAxisMax</a></li><li><a href="global.html#yAxisMin">yAxisMin</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Sep 21 2018 12:26:28 GMT+1000 (AUS Eastern Standard Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>