terriajs
Version:
Geospatial data visualization platform.
21,544 lines • 280 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Global</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">Global</h1>
<section>
<header>
<h2></h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="_bumpyTerrainProvider"><span class="type-signature"></span>_bumpyTerrainProvider<span class="type-signature"></span></h4>
<div class="description">
<p>A terrain provider used when ViewerMode === ViewerMode.CesiumTerrain</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ViewModels_TerriaViewer.js.html">ViewModels/TerriaViewer.js</a>, <a href="ViewModels_TerriaViewer.js.html#line117">line 117</a>
</li></ul></dd>
</dl>
<h4 class="name" id="_terrain"><span class="type-signature"></span>_terrain<span class="type-signature"></span></h4>
<div class="description">
<p>The terrain provider currently being used - can be either a bumpy terrain provider or a smooth EllipsoidTerrainProvider</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ViewModels_TerriaViewer.js.html">ViewModels/TerriaViewer.js</a>, <a href="ViewModels_TerriaViewer.js.html#line120">line 120</a>
</li></ul></dd>
</dl>
<h4 class="name" id="activeTimeColumnNameIdOrIndex"><span class="type-signature"></span>activeTimeColumnNameIdOrIndex<span class="type-signature"> :String|Integer|Array.<String>|Array.<Integer>|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">Integer</span>
|
<span class="param-type">Array.<String></span>
|
<span class="param-type">Array.<Integer></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#line160">line 160</a>
</li></ul></dd>
</dl>
<h4 class="name" id="allFeaturesAvailablePromise"><span class="type-signature"></span>allFeaturesAvailablePromise<span class="type-signature"> :Promise</span></h4>
<div class="description">
<p>Gets or sets a promise that indicates, when it resolves, that all picked features are available in the
{@see PickedFeatures#features} array.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Promise</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_PickedFeatures.js.html">Map/PickedFeatures.js</a>, <a href="Map_PickedFeatures.js.html#line15">line 15</a>
</li></ul></dd>
</dl>
<h4 class="name" id="allShareKeys"><span class="type-signature"></span>allShareKeys<span class="type-signature"></span></h4>
<div class="description">
<p>All keys that have historically been used to resolve this member - the current uniqueId + past shareKeys.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogMember.js.html">Models/CatalogMember.js</a>, <a href="Models_CatalogMember.js.html#line358">line 358</a>
</li></ul></dd>
</dl>
<h4 class="name" id="barHeightMax"><span class="type-signature"></span>barHeightMax<span class="type-signature"> :Number</span></h4>
<div class="description">
<p>Gets or sets the maximum height of the whole color bar, unless very many items.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>130</li>
</ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_Legend.js.html">Map/Legend.js</a>, <a href="Map_Legend.js.html#line46">line 46</a>
</li></ul></dd>
</dl>
<h4 class="name" id="barHeightMin"><span class="type-signature"></span>barHeightMin<span class="type-signature"> :Number</span></h4>
<div class="description">
<p>Gets or sets the minimum height of the whole color bar.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>30</li>
</ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_Legend.js.html">Map/Legend.js</a>, <a href="Map_Legend.js.html#line53">line 53</a>
</li></ul></dd>
</dl>
<h4 class="name" id="barLeft"><span class="type-signature"></span>barLeft<span class="type-signature"> :Number</span></h4>
<div class="description">
<p>Gets or sets the spacing to the left of the color bar.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>5</li>
</ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_Legend.js.html">Map/Legend.js</a>, <a href="Map_Legend.js.html#line88">line 88</a>
</li></ul></dd>
</dl>
<h4 class="name" id="barTop"><span class="type-signature"></span>barTop<span class="type-signature"> :Number</span></h4>
<div class="description">
<p>Gets or sets the spacing between the title and color bar.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>5</li>
</ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_Legend.js.html">Map/Legend.js</a>, <a href="Map_Legend.js.html#line95">line 95</a>
</li></ul></dd>
</dl>
<h4 class="name" id="categoryName"><span class="type-signature"></span>categoryName<span class="type-signature"> :String</span></h4>
<div class="description">
<p>Name of the category for this set of points., eg. the source catalog item.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Charts_ChartData.js.html">Charts/ChartData.js</a>, <a href="Charts_ChartData.js.html#line44">line 44</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>CSS color code for this set of points.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Charts_ChartData.js.html">Charts/ChartData.js</a>, <a href="Charts_ChartData.js.html#line62">line 62</a>
</li></ul></dd>
</dl>
<h4 class="name" id="computeScreenSpacePosition"><span class="type-signature"></span>computeScreenSpacePosition<span class="type-signature"> :SelectionIndicatorViewModel~ComputeScreenSpacePosition</span></h4>
<div class="description">
<p>Gets or sets the function for converting the world position of the object to the screen space position.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">SelectionIndicatorViewModel~ComputeScreenSpacePosition</span>
</li>
</ul>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>SceneTransforms.wgs84ToWindowCoordinates</li>
</ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_CesiumSelectionIndicator.js.html">Map/CesiumSelectionIndicator.js</a>, <a href="Map_CesiumSelectionIndicator.js.html#line71">line 71</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>selectionIndicatorViewModel.computeScreenSpacePosition = function(position, result) {
return Cesium.SceneTransforms.wgs84ToWindowCoordinates(scene, position, result);
};</code></pre>
<h4 class="name" id="config"><span class="type-signature"></span>config<span class="type-signature"> :Object</span></h4>
<div class="description">
<p>Contains configuration information retrieved from the server. The attributes are defined by TerriaJS-Server but include:
version: current version of server
proxyAllDomains: whether all domains can be proxied
allowProxyFrom: array of domains that can be proxied
maxConversionSize: maximum size, in bytes, of files that can be uploaded to conversion service
newShareUrlPrefix: if defined, the share URL service is active
shareUrlPrefixes: object defining share URL prefixes that can be resolved</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Core_ServerConfig.js.html">Core/ServerConfig.js</a>, <a href="Core_ServerConfig.js.html#line23">line 23</a>
</li></ul></dd>
</dl>
<h4 class="name" id="cssClass"><span class="type-signature"></span>cssClass<span class="type-signature"> :String</span></h4>
<div class="description">
<p>Gets or sets the CSS class that will be applied to the legend when it is displayed.
This is used to ensure that the correct font is used when measuring text for word wrapping.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_Legend.js.html">Map/Legend.js</a>, <a href="Map_Legend.js.html#line123">line 123</a>
</li></ul></dd>
</dl>
<h4 class="name" id="CustomComponents"><span class="type-signature">(constant) </span>CustomComponents<span class="type-signature"></span></h4>
<div class="description">
<p>A store of registered custom component types, eg. <chart>.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ReactViews_Custom_CustomComponents.js.html">ReactViews/Custom/CustomComponents.js</a>, <a href="ReactViews_Custom_CustomComponents.js.html#line14">line 14</a>
</li></ul></dd>
</dl>
<h4 class="name" id="Description"><span class="type-signature">(constant) </span>Description<span class="type-signature"></span></h4>
<div class="description">
<p>CatalogItem description.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ReactViews_Preview_Description.js.html">ReactViews/Preview/Description.js</a>, <a href="ReactViews_Preview_Description.js.html#line20">line 20</a>
</li></ul></dd>
</dl>
<h4 class="name" id="direction"><span class="type-signature"></span>direction<span class="type-signature"> :Cartesian3</span></h4>
<div class="description">
<p>Gets the look direction of the camera in the Earth-centered Fixed frame.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Cartesian3</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CameraView.js.html">Models/CameraView.js</a>, <a href="Models_CameraView.js.html#line70">line 70</a>
</li></ul></dd>
</dl>
<h4 class="name" id="error"><span class="type-signature"></span>error<span class="type-signature"> :String</span></h4>
<div class="description">
<p>Gets or sets a message describing an error that occurred while picking features.
If this property is undefined, no error occurred.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_PickedFeatures.js.html">Map/PickedFeatures.js</a>, <a href="Map_PickedFeatures.js.html#line41">line 41</a>
</li></ul></dd>
</dl>
<h4 class="name" id="extent"><span class="type-signature"></span>extent<span class="type-signature"> :Rectangle</span></h4>
<div class="description">
<p>Gets a Rectangle covering the extent of the data, based on lat & lon columns. (It could be based on regions too eventually.)</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Rectangle</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_TableDataSource.js.html">Models/TableDataSource.js</a>, <a href="Models_TableDataSource.js.html#line184">line 184</a>
</li></ul></dd>
</dl>
<h4 class="name" id="extent"><span class="type-signature"></span>extent<span class="type-signature"> :Rectangle</span></h4>
<div class="description">
<p>Gets a Rectangle covering the extent of the data, based on lat & lon columns. (It could be based on regions too eventually.)</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Rectangle</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_RegionMapping.js.html">Models/RegionMapping.js</a>, <a href="Models_RegionMapping.js.html#line164">line 164</a>
</li></ul></dd>
</dl>
<h4 class="name" id="featureClicked"><span class="type-signature"></span>featureClicked<span class="type-signature"> :CesiumEvent</span></h4>
<div class="description">
<p>Gets or sets an event that is raised when a feature is clicked on the Leaflet map.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">CesiumEvent</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_LeafletScene.js.html">Map/LeafletScene.js</a>, <a href="Map_LeafletScene.js.html#line17">line 17</a>
</li></ul></dd>
</dl>
<h4 class="name" id="featureMousedown"><span class="type-signature"></span>featureMousedown<span class="type-signature"> :CesiumEvent</span></h4>
<div class="description">
<p>Gets or sets an event that is raised when a mousedown event occurs on the Leaflet map.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">CesiumEvent</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_LeafletScene.js.html">Map/LeafletScene.js</a>, <a href="Map_LeafletScene.js.html#line23">line 23</a>
</li></ul></dd>
</dl>
<h4 class="name" id="features"><span class="type-signature"></span>features<span class="type-signature"> :Array.<Entity></span></h4>
<div class="description">
<p>Gets or sets the array of picked features. The array is observable and may be updated up until the point that
{@see PickedFeatures#allFeaturesAvailablePromise} resolves.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<Entity></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_PickedFeatures.js.html">Map/PickedFeatures.js</a>, <a href="Map_PickedFeatures.js.html#line34">line 34</a>
</li></ul></dd>
</dl>
<h4 class="name" id="gradientColorMap"><span class="type-signature"></span>gradientColorMap<span class="type-signature"> :<a href="global.html#ColorMap">ColorMap</a></span></h4>
<div class="description">
<p>Gets or sets a color map used to draw a smooth gradient instead of discrete color boxes.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="global.html#ColorMap">ColorMap</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_Legend.js.html">Map/Legend.js</a>, <a href="Map_Legend.js.html#line39">line 39</a>
</li></ul></dd>
</dl>
<h4 class="name" id="hasAddress"><span class="type-signature"></span>hasAddress<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets a flag which states whether this data has address data.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</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#line148">line 148</a>
</li></ul></dd>
</dl>
<h4 class="name" id="hasChildren"><span class="type-signature"></span>hasChildren<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets a value indicating whether this item has child items.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_AbsCode.js.html">Map/AbsCode.js</a>, <a href="Map_AbsCode.js.html#line84">line 84</a>
</li></ul></dd>
</dl>
<h4 class="name" id="hasChildren"><span class="type-signature"></span>hasChildren<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets a value indicating whether this item has child items.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_MetadataItem.js.html">Models/MetadataItem.js</a>, <a href="Models_MetadataItem.js.html#line48">line 48</a>
</li></ul></dd>
</dl>
<h4 class="name" id="hasChildren"><span class="type-signature"></span>hasChildren<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets a value indicating whether this item has child items.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_AbsConcept.js.html">Map/AbsConcept.js</a>, <a href="Map_AbsConcept.js.html#line98">line 98</a>
</li></ul></dd>
</dl>
<h4 class="name" id="hasChildren"><span class="type-signature"></span>hasChildren<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets a value indicating whether this item has child items.
If your subclass can return true, it must also define isOpen & items properties, and a toggleOpen function.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<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#line78">line 78</a>
</li></ul></dd>
</dl>
<h4 class="name" id="hasLatitudeAndLongitude"><span class="type-signature"></span>hasLatitudeAndLongitude<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets a flag which states whether this data has latitude and longitude data.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</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#line136">line 136</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>Unique id for this set of points.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Charts_ChartData.js.html">Charts/ChartData.js</a>, <a href="Charts_ChartData.js.html#line38">line 38</a>
</li></ul></dd>
</dl>
<h4 class="name" id="infoWithoutSources"><span class="type-signature"></span>infoWithoutSources<span class="type-signature"></span></h4>
<div class="description">
<p>A filtered view of <a href="CatalogMember.html#info">CatalogMember#info</a> that excludes info items that divulge details about the data's
source, as determined by CatalogMember#__sourceInfoItemNames.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogMember.js.html">Models/CatalogMember.js</a>, <a href="Models_CatalogMember.js.html#line376">line 376</a>
</li></ul></dd>
</dl>
<h4 class="name" id="isLoading"><span class="type-signature"></span>isLoading<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets or sets a value indicating whether the list of picked features is still loading.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_PickedFeatures.js.html">Map/PickedFeatures.js</a>, <a href="Map_PickedFeatures.js.html#line21">line 21</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 the visibility of the position indicator. This can be false even if an
object is selected, when the selected object has no position.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_CesiumSelectionIndicator.js.html">Map/CesiumSelectionIndicator.js</a>, <a href="Map_CesiumSelectionIndicator.js.html#line52">line 52</a>
</li></ul></dd>
</dl>
<h4 class="name" id="itemHeight"><span class="type-signature"></span>itemHeight<span class="type-signature"> :Number</span></h4>
<div class="description">
<p>Gets or sets the forced height of each color box. Better to leave unset.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>the smaller of `props.barHeightMax / props.items.length` and 30.</li>
</ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_Legend.js.html">Map/Legend.js</a>, <a href="Map_Legend.js.html#line74">line 74</a>
</li></ul></dd>
</dl>
<h4 class="name" id="itemHeightMin"><span class="type-signature"></span>itemHeightMin<span class="type-signature"> :Number</span></h4>
<div class="description">
<p>Gets or sets the asbolute minimum height of each color box, overruling barHeightMax.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>12</li>
</ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_Legend.js.html">Map/Legend.js</a>, <a href="Map_Legend.js.html#line67">line 67</a>
</li></ul></dd>
</dl>
<h4 class="name" id="items"><span class="type-signature"></span>items<span class="type-signature"> :Array.<Object></span></h4>
<div class="description">
<p>Gets or sets the list of items, ordered from bottom to top, with properties:</p>
<ul>
<li><code>color</code>: CSS color description,</li>
<li><code>multipleColors</code>: An array of CSS color descriptions. A grid of these colors will be displayed in the box to the left of the item label.</li>
<li><code>title</code>: label placed level with middle of box</li>
<li><code>titleAbove</code>: label placed level with top of box</li>
<li><code>titleBelow</code>: label placed level with bottom of box</li>
<li><code>imageUrl</code>: url of image that will be drawn instead of a coloured box</li>
<li><code>imageWidth</code>, <code>imageHeight</code>: image dimensions</li>
<li><code>spacingAbove</code>: adds to itemSpacing for this item only.</li>
</ul>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<Object></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_Legend.js.html">Map/Legend.js</a>, <a href="Map_Legend.js.html#line33">line 33</a>
</li></ul></dd>
</dl>
<h4 class="name" id="items"><span class="type-signature"></span>items<span class="type-signature"> :Array.<<a href="CatalogItem.html">CatalogItem</a>></span></h4>
<div class="description">
<p>Gets the list of items that we are "now viewing". It is recommended that you use
the methods on this instance instead of manipulating the list of items directly.
This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<<a href="CatalogItem.html">CatalogItem</a>></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_NowViewing.js.html">Models/NowViewing.js</a>, <a href="Models_NowViewing.js.html#line26">line 26</a>
</li></ul></dd>
</dl>
<h4 class="name" id="itemSpacing"><span class="type-signature"></span>itemSpacing<span class="type-signature"> :Number</span></h4>
<div class="description">
<p>Gets or sets the gap between each pair of color boxes.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>0</li>
</ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_Legend.js.html">Map/Legend.js</a>, <a href="Map_Legend.js.html#line81">line 81</a>
</li></ul></dd>
</dl>
<h4 class="name" id="itemWidth"><span class="type-signature"></span>itemWidth<span class="type-signature"> :Number</span></h4>
<div class="description">
<p>Gets or sets the width of each color box (and hence, the color bar)</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>30</li>
</ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_Legend.js.html">Map/Legend.js</a>, <a href="Map_Legend.js.html#line60">line 60</a>
</li></ul></dd>
</dl>
<h4 class="name" id="legendUrl"><span class="type-signature"></span>legendUrl<span class="type-signature"> :String</span></h4>
<div class="description">
<p>Gets a URL for the legend for this data.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_RegionMapping.js.html">Models/RegionMapping.js</a>, <a href="Models_RegionMapping.js.html#line174">line 174</a>
</li></ul></dd>
</dl>
<h4 class="name" id="legendUrl"><span class="type-signature"></span>legendUrl<span class="type-signature"> :String</span></h4>
<div class="description">
<p>Gets a URL for the legend for this data.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_TableDataSource.js.html">Models/TableDataSource.js</a>, <a href="Models_TableDataSource.js.html#line194">line 194</a>
</li></ul></dd>
</dl>
<h4 class="name" id="map"><span class="type-signature"></span>map<span class="type-signature"> :L.map</span></h4>
<div class="description">
<p>Gets or sets the Leaflet map.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">L.map</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_LeafletScene.js.html">Map/LeafletScene.js</a>, <a href="Map_LeafletScene.js.html#line11">line 11</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>Name for this set of points.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Charts_ChartData.js.html">Charts/ChartData.js</a>, <a href="Charts_ChartData.js.html#line50">line 50</a>
</li></ul></dd>
</dl>
<h4 class="name" id="pickPosition"><span class="type-signature"></span>pickPosition<span class="type-signature"> :Cartesian3</span></h4>
<div class="description">
<p>Gets or sets the ground position that was picked, if any.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Cartesian3</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_PickedFeatures.js.html">Map/PickedFeatures.js</a>, <a href="Map_PickedFeatures.js.html#line27">line 27</a>
</li></ul></dd>
</dl>
<h4 class="name" id="point"><span class="type-signature"></span>point<span class="type-signature"> :Object</span></h4>
<div class="description">
<p>A selected point from the array above. Used internally by charting functions for hover/clicking functionality.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Charts_ChartData.js.html">Charts/ChartData.js</a>, <a href="Charts_ChartData.js.html#line32">line 32</a>
</li></ul></dd>
</dl>
<h4 class="name" id="points"><span class="type-signature"></span>points<span class="type-signature"> :Array.<Object></span></h4>
<div class="description">
<p>The array of points. Each point should have the format {x: X, y: Y}.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<Object></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Charts_ChartData.js.html">Charts/ChartData.js</a>, <a href="Charts_ChartData.js.html#line26">line 26</a>
</li></ul></dd>
</dl>
<h4 class="name" id="position"><span class="type-signature"></span>position<span class="type-signature"> :Cartesian3</span></h4>
<div class="description">
<p>Gets the position of the camera in the Earth-centered Fixed frame.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Cartesian3</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CameraView.js.html">Models/CameraView.js</a>, <a href="Models_CameraView.js.html#line60">line 60</a>
</li></ul></dd>
</dl>
<h4 class="name" id="position"><span class="type-signature"></span>position<span class="type-signature"> :Cartesian3</span></h4>
<div class="description">
<p>Gets or sets the world position of the object for which to display the selection indicator.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Cartesian3</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_CesiumSelectionIndicator.js.html">Map/CesiumSelectionIndicator.js</a>, <a href="Map_CesiumSelectionIndicator.js.html#line33">line 33</a>
</li></ul></dd>
</dl>
<h4 class="name" id="Proj4Definitions"><span class="type-signature"></span>Proj4Definitions<span class="type-signature"> :Object</span></h4>
<div class="description">
<p>Defines the built-in proj4 projection definitions known to TerriaJS. Additional projections can be added
to this object literal.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_Proj4Definitions.js.html">Map/Proj4Definitions.js</a>, <a href="Map_Proj4Definitions.js.html#line9">line 9</a>
</li></ul></dd>
</dl>
<h4 class="name" id="rectangle"><span class="type-signature"></span>rectangle<span class="type-signature"> :Rectangle</span></h4>
<div class="description">
<p>Gets the rectangular extent of the view. If CameraView#position, CameraView#direction,
and CameraView#up are specified, this property will be ignored for viewers that support those parameters
(e.g. Cesium). This property must always be supplied, however, for the benefit of viewers that do not understand
these parameters (e.g. Leaflet).</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Rectangle</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CameraView.js.html">Models/CameraView.js</a>, <a href="Models_CameraView.js.html#line50">line 50</a>
</li></ul></dd>
</dl>
<h4 class="name" id="regionDetails"><span class="type-signature"></span>regionDetails<span class="type-signature"> :Array.<Object></span></h4>
<div class="description">
<p>Once loaded, gets the region details (an array of "regionDetail" objects, with regionProvider, columnName and disambigColumnName properties).
By checking if defined, can be used as the region-mapping equivalent to "hasLatitudeAndLongitude".</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<Object></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_RegionMapping.js.html">Models/RegionMapping.js</a>, <a href="Models_RegionMapping.js.html#line185">line 185</a>
</li></ul></dd>
</dl>
<h4 class="name" id="shareKeyIndex"><span class="type-signature"></span>shareKeyIndex<span class="type-signature"> :Object</span></h4>
<div class="description">
<p>A flat index of all catalog member in this catalog by their share keys. Because items can have multiple share keys
to preserve backwards compatibility, multiple entries in this index will lead to the same catalog member.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_Catalog.js.html">Models/Catalog.js</a>, <a href="Models_Catalog.js.html#line81">line 81</a>
</li></ul></dd>
</dl>
<h4 class="name" id="showSelection"><span class="type-signature"></span>showSelection<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets or sets the visibility of the selection indicator.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_CesiumSelectionIndicator.js.html">Map/CesiumSelectionIndicator.js</a>, <a href="Map_CesiumSelectionIndicator.js.html#line39">line 39</a>
</li></ul></dd>
</dl>
<h4 class="name" id="supportsIntervals"><span class="type-signature"></span>supportsIntervals<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets a value indicating whether this <a href="ImageryLayerCatalogItem____.html">ImageryLayerCatalogItem</a> supports the <a href="ImageryLayerCatalogItem.html#intervals">ImageryLayerCatalogItem#intervals</a>
property for configuring time-dynamic imagery.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_WebMapTileServiceCatalogItem.js.html">Models/WebMapTileServiceCatalogItem.js</a>, <a href="Models_WebMapTileServiceCatalogItem.js.html#line186">line 186</a>
</li></ul></dd>
</dl>
<h4 class="name" id="supportsIntervals"><span class="type-signature"></span>supportsIntervals<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets a value indicating whether this <a href="ImageryLayerCatalogItem____.html">ImageryLayerCatalogItem</a> supports the <a href="ImageryLayerCatalogItem.html#intervals">ImageryLayerCatalogItem#intervals</a>
property for configuring time-dynamic imagery.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_WebMapServiceCatalogItem.js.html">Models/WebMapServiceCatalogItem.js</a>, <a href="Models_WebMapServiceCatalogItem.js.html#line382">line 382</a>
</li></ul></dd>
</dl>
<h4 class="name" id="supportsIntervals"><span class="type-signature"></span>supportsIntervals<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets a value indicating whether this <a href="ImageryLayerCatalogItem____.html">ImageryLayerCatalogItem</a> supports the <a href="ImageryLayerCatalogItem.html#intervals">ImageryLayerCatalogItem#intervals</a>
property for configuring time-dynamic imagery.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_ImageryLayerCatalogItem.js.html">Models/ImageryLayerCatalogItem.js</a>, <a href="Models_ImageryLayerCatalogItem.js.html#line206">line 206</a>
</li></ul></dd>
</dl>
<h4 class="name" id="Title"><span class="type-signature">(constant) </span>Title<span class="type-signature"></span></h4>
<div class="description">
<p>Handles the drawing of the chart title, which may be a string or a legend.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Charts_Title.js.html">Charts/Title.js</a>, <a href="Charts_Title.js.html#line19">line 19</a>
</li></ul></dd>
</dl>
<h4 class="name" id="Tooltip"><span class="type-signature">(constant) </span>Tooltip<span class="type-signature"></span></h4>
<div class="description">
<p>Handles the drawing of the chart tooltip, which shows the values of the selected data in a legend.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Charts_Tooltip.js.html">Charts/Tooltip.js</a>, <a href="Charts_Tooltip.js.html#line29">line 29</a>
</li></ul></dd>
</dl>
<h4 class="name" id="units"><span class="type-signature"></span>units<span class="type-signature"> :String</span></h4>
<div class="description">
<p>Units of this set of points.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Charts_ChartData.js.html">Charts/ChartData.js</a>, <a href="Charts_ChartData.js.html#line56">line 56</a>
</li></ul></dd>
</dl>
<h4 class="name" id="up"><span class="type-signature"></span>up<span class="type-signature"> :Cartesian3</span></h4>
<div class="description">
<p>Gets the up vector direction of the camera in the Earth-centered Fixed frame.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Cartesian3</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CameraView.js.html">Models/CameraView.js</a>, <a href="Models_CameraView.js.html#line80">line 80</a>
</li></ul></dd>
</dl>
<h4 class="name" id="variableNameLeft"><span class="type-signature"></span>variableNameLeft<span class="type-signature"> :Number</span></h4>
<div class="description">
<p>Gets or sets the horizontal offset of variable title.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>5</li>
</ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_Legend.js.html">Map/Legend.js</a>, <a href="Map_Legend.js.html#line109">line 109</a>
</li></ul></dd>
</dl>
<h4 class="name" id="variableNameTop"><span class="type-signature"></span>variableNameTop<span class="type-signature"> :Number</span></h4>
<div class="description">
<p>Gets or sets the vertical offset of variable title.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>17</li>
</ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_Legend.js.html">Map/Legend.js</a>, <a href="Map_Legend.js.html#line116">line 116</a>
</li></ul></dd>
</dl>
<h4 class="name" id="ViewerMode"><span class="type-signature"></span>ViewerMode<span class="type-signature"></span></h4>
<div class="description">
<p>Identifies the map viewer mode to use.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_ViewerMode.js.html">Models/ViewerMode.js</a>, <a href="Models_ViewerMode.js.html#line7">line 7</a>
</li></ul></dd>
</dl>
<h4 class="name" id="width"><span class="type-signature"></span>width<span class="type-signature"> :Number</span></h4>
<div class="description">
<p>Gets or sets the forced total width of the legend.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>315</li>
</ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_Legend.js.html">Map/Legend.js</a>, <a href="Map_Legend.js.html#line102">line 102</a>
</li></ul></dd>
</dl>
<h4 class="name" id="yAxisMax"><span class="type-signature"></span>yAxisMax<span class="type-signature"> :String</span></h4>
<div class="description">
<p>Maximum value for y axis to display, overriding maximum value in data.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Charts_ChartData.js.html">Charts/ChartData.js</a>, <a href="Charts_ChartData.js.html#line74">line 74</a>
</li></ul></dd>
</dl>
<h4 class="name" id="yAxisMin"><span class="type-signature"></span>yAxisMin<span class="type-signature"> :String</span></h4>
<div class="description">
<p>Minimum value for y axis to display, overriding minimum value in data.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Charts_ChartData.js.html">Charts/ChartData.js</a>, <a href="Charts_ChartData.js.html#line68">line 68</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="addBoundingBox"><span class="type-signature"></span>addBoundingBox<span class="signature">(requestData, rectangle)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Adds a bounding box filter to the search query for elastic search. This simply modifies requestData and returns nothing.</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>requestData</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>Request data to modify</p></td>
</tr>
<tr>
<td class="name"><code>rectangle</code></td>
<td class="type">
<span class="param-type">Rectangle</span>
</td>
<td class="description last"><p>rectangle to source the bounding box from.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_GnafApi.js.html">Models/GnafApi.js</a>, <a href="Models_GnafApi.js.html#line235">line 235</a>
</li></ul></dd>
</dl>
<h4 class="name" id="addMarker"><span class="type-signature"></span>addMarker<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Adds a location marker to the map with the position supplied in the result, adding a data source to terria if one hasn't
already been added, and removing all previously added markers in that data source. This data source is stored in
terria.locationMarker.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_LocationMarkerUtils.js.html">Models/LocationMarkerUtils.js</a>, <a href="Models_LocationMarkerUtils.js.html#line20">line 20</a>
</li></ul></dd>
</dl>
<h4 class="name" id="addUserCatalogMember"><span class="type-signature"></span>addUserCatalogMember<span class="signature">(terria, newCatalogItemOrPromise, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
<div class="description">
<p>Adds a user's catalog item or group to the catalog.</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>terria</code></td>
<td class="type">
<span class="param-type"><a href="Terria.html">Terria</a></span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The Terria instance to contain the catalog member.</p></td>
</tr>
<tr>
<td class="name"><code>newCatalogItemOrPromise</code></td>
<td class="type">
<span class="param-type"><a href="CatalogItem.html">CatalogItem</a></span>
|
<span class="param-type">Promise</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The catalog member to add, or a promise for a catalog member.</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>An object with the following members:</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>enable</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>True to enable the newly-added member if it is an item; otherwise, false.</p></td>
</tr>
<tr>
<td class="name"><code>open</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>True to open the newly-added member if it is a group; otherwise, false.</p></td>
</tr>
<tr>
<td class="name"><code>zoomTo</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>True to zoom and use the clock of the newly-added member if it is an item; otherwise, false.</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="Models_addUserCatalogMember.js.html">Models/addUserCatalogMember.js</a>, <a href="Models_addUserCatalogMember.js.html#line22">line 22</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A promise that resolves to the catalog item when loaded successfully, or to a <a href="TerriaError.html">TerriaError</a> if loading fails. The <a href="TerriaError.html">TerriaError</a> is reported
by raising <a href="Terria.html#error">Terria#error</a> prior to resolving. The promise never rejects.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="arrayProduct"><span class="type-signature"></span>arrayProduct<span class="signature">(pools)</span><span class="type-signature"> → {Array.<Array>}</span></h4>
<div class="description">
<p>Find the "product" of a set of arrays, equivalent to the python one-liner: list(itertools.product(*pools)).
Eg. [[a,b,c], [d], [e,f]] => [[a,d,e], [a,d,f], [b,d,e], [b,d,f], [c,d,e], [c,d,f]].</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>pools</code></td>
<td class="type">
<span class="param-type">Array.<Array></span>
</td>
<td class="description last"><p>The arrays of 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="Core_arrayProduct.js.html">Core/arrayProduct.js</a>, <a href="Core_arrayProduct.js.html#line12">line 12</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The product of the arrays.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<Array></span>
</dd>
</dl>
<h4 class="name" id="buildEmptyAccumulator"><span class="type-signature"></span>buildEmptyAccumulator<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Builds an empty accumulator object - each location for custom elements will have an empty array in the return object</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ReactViews_StandardUserInterface_processCustomElements.js.html">ReactViews/StandardUserInterface/processCustomElements.js</a>, <a href="ReactViews_StandardUserInterface_processCustomElements.js.html#line35">line 35</a>
</li></ul></dd>
</dl>
<h4 class="name" id="buildRequestData"><span class="type-signature"></span>buildRequestData<span class="signature">(searchTerm, maxResults)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Builds the data to be POSTed to elastic search.</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>searchTerm</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The plain-text query to search for.</p></td>
</tr>
<tr>
<td class="name"><code>maxResults</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The max number of results to search for.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_GnafApi.js.html">Models/GnafApi.js</a>, <a href="Models_GnafApi.js.html#line199">line 199</a>
</li></ul></dd>
</dl>
<h4 class="name" id="buildShareLink"><span class="type-signature"></span>buildShareLink<span class="signature">(terria)</span><span class="type-signature"> → {String}</span></h4>
<div class="description">
<p>Builds a share link that reflects the state of the passed Terria instance.</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>terria</code></td>
<td class="type">
</td>
<td class="description last"><p>The terria instance to serialize.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ReactViews_Map_Panels_SharePanel_BuildShareLink.js.html">ReactViews/Map/Panels/SharePanel/BuildShareLink.js</a>, <a href="ReactViews_Map_Panels_SharePanel_BuildShareLink.js.html#line20">line 20</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A URI that will rebuild the current state when viewed in a browser.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
<h4 class="name" id="buildShortShareLink"><span class="type-signature"></span>buildShortShareLink<span class="signature">()</span><span class="type-signature"> → {Promise.<String>}</span></h4>
<div class="description">
<p>Like <a href="global.html#buildShareLink">buildShareLink</a>, but shortens the result using <a href="Terria.html#urlShortener">Terria#urlShortener</a>.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ReactViews_Map_Panels_SharePanel_BuildShareLink.js.html">ReactViews/Map/Panels/SharePanel/BuildShareLink.js</a>, <a href="ReactViews_Map_Panels_SharePanel_BuildShareLink.js.html#line62">line 62</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A promise that will return the shortened url when complete.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<String></span>
</dd>
</dl>
<h4 class="name" id="calculateFinishDatesFromStartDates"><span class="type-signature"></span>calculateFinishDatesFromStartDates<span class="signature">(startJulianDates, localDefaultFinalDurationSeconds<span class="signature-attributes">opt</span>, shaveSeconds<span class="signature-attributes">opt</span>, finalEndJulianDate<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array.<JulianDate>}</span></h4>
<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>startJulianDates</code></td>
<td class="type">
<span class="param-type">Array.<JulianDate></span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>An array of start dates.</p></td>
</tr>
<tr>
<td class="name"><code>localDefaultFinalDurationSeconds</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>The duration to use if there is only one date in the list. Defaults to defaultFinalDurationSeconds.</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="description last"><p>Subtract this many seconds from the end dates so they don't overlap (defaults to zero). If duration < 20 * shaveSeconds, use 5% of duration.</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="description last"><p>If present, use this for the final end date.</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#line423">line 423</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>An array of end dates which correspond to the array of start dates.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<JulianDate></span>
</dd>
</dl>
<h4 class="name" id="canShorten"><span class="type-signature"></span>canShorten<span class="signature">(terria)</span><span class="type-signature"> → {Boolean}</span></h4>
<div class="description">
<p>Is it currently possible to generate short URLs?</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>terria</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>The Terria object.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ReactViews_Map_Panels_SharePanel_BuildShareLink.js.html">ReactViews/Map/Panels/SharePanel/BuildShareLink.js</a>, <a href="ReactViews_Map_Panels_SharePanel_BuildShareLink.js.html#line53">line 53</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id="ChartData"><span class="type-signature"></span>ChartData<span class="signature">(points<span class="signature-attributes">opt</span>, parameters<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
<p>A container to pass data to a d3 chart.
For documentation on the custom <chart> tag, see lib/Models/registerCustomComponentTypes.js.</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>points</code></td>
<td class="type">
<span class="param-type">Array.<Object></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>The array of points. Each point should have the format {x: X, y: Y}. Defaults to [].</p></td>
</tr>
<tr>
<td class="name"><code>parameters</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Further parameters.</p>
<h6>Properties</h6>
<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>id</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Unique id for this set of points.</p></td>
</tr>
<tr>
<td class="name"><code>categoryName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Name of the category for this set of points., eg. the source catalog item.</p></td>
</tr>
<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 for this set of points.</p></td>
</tr>
<tr>
<td class="name"><code>units</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Units of this set of points.</p></td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>CSS color code for this set of points.</p></td>
</tr>
<tr>
<td class="name"><code>yAxisMin</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Minimum value for y axis to display, overriding minimum value in data.</p></td>
</tr>
<tr>
<td class="name"><code>yAxisMax</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Maximum value for y axis to display, overriding maximum value in data.</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="Charts_ChartData.js.html">Charts/ChartData.js</a>, <a href="Charts_ChartData.js.html#line20">line 20</a>
</li></ul></dd>
</dl>
<h4 class="name" id="ColorMap"><span class="type-signature"></span>ColorMap<span class="signature">(param)</span><span class="type-signature"></span></h4>
<div class="description">
<p>A one-dimensional scale of colours used to visually represent a numerical value.
Implemented as an Array of {color, offset} objects, where the first object has an offset of 0,
the last has an offset of 1, and the others are ordered in between.
It can be instantiated directly from three formats:</p>
<ul>
<li>String, eg. 'red-black'</li>
<li>Array of strings, eg. ['red', 'black']</li>
<li>Array of objects with the properties 'color' and 'offset', eg. [{color: 'red', offset: 0}, ...].</li>
</ul>
</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>param</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">Array.<String></span>
|
<span class="param-type">Array.<Object></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_ColorMap.js.html">Map/ColorMap.js</a>, <a href="Map_ColorMap.js.html#line21">line 21</a>
</li></ul></dd>
</dl>
<h4 class="name" id="combineData"><span class="type-signature"></span>combineData<span class="signature">(array)</span><span class="type-signature"> → {Array.<Number>|Array.<Date>}</span></h4>
<div class="description">
<p>Combines two data arrays, each with the format [[x1, y1], [x2, y2], ...]
maintaining the order of the x's.
The x and y can be anything with order (integers, floats, dates, etc)</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>array</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last"><p>Array of arrays, eg. [[[x1, y1], [x2, y2]], [[a1, b1], [a2, b2]]]</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Core_combineData.js.html">Core/combineData.js</a>, <a href="Core_combineData.js.html#line10">line 10</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Combined array.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<Number></span>
|
<span class="param-type">Array.<Date></span>
</dd>
</dl>
<h4 class="name" id="combineFilters"><span class="type-signature"></span>combineFilters<span class="signature">(filters)</span><span class="type-signature"> → {function}</span></h4>
<div class="description">
<p>Combines a number of functions that return a boolean into a single function that executes all of them and returns
true only if all them do. Maintains an set of filter functions, so if the same function is combined
more than once, it is only executed one time. This means that it is also safe to call combineFilter on its own result
to combine the result with another filter - the set of filters from the previous result will simply
be merged into that of the new result so that only individual filter functions are executed.</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>filters</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last"><p>A number of functions to combine into one logical function.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Core_combineFilters.js.html">Core/combineFilters.js</a>, <a href="Core_combineFilters.js.html#line15">line 15</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The resulting function.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">function</span>
</dd>
</dl>
<h4 class="name" id="combineRepeated"><span class="type-signature"></span>combineRepeated<span class="signature">(sortedJulianDateOrValueArrays, firstColumnType<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array.<Array>}</span></h4>
<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>sortedJulianDateOrValueArrays</code></td>
<td class="type">
<span class="param-type">Array.<Array></span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The array of arrays of values to combine. These must be sortedByFirst. Dates must be JulianDates.</p></td>
</tr>
<tr>
<td class="name"><code>firstColumnType</code></td>
<td class="type">
<span class="param-type">Integer</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Eg. VarType.TIME.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ReactViews_Custom_Chart_downloadHrefWorker.js.html">ReactViews/Custom/Chart/downloadHrefWorker.js</a>, <a href="ReactViews_Custom_Chart_downloadHrefWorker.js.html#line78">line 78</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The values, with any repeats in the first column combined into one. Dates are converted to ISO8601 string representation.</p>
<p>Eg.
var x = [['a', 'b', 'b', 'c'], [1, 2, undefined, 3], [4, undefined, 5, undefined]];
combineRepeated(x);</p>
<h1>x is [['a', 'b', 'c'], [1, 2, 3], [4, 5, undefined]].</h1>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<Array></span>
</dd>
</dl>
<h4 class="name" id="combineValueArrays"><span class="type-signature"></span>combineValueArrays<span class="signature">(valueArrays)</span><span class="type-signature"> → {Array.<Array>}</span></h4>
<div class="description">
<p>Create combined arrays from arrays of column values, eg. [[values1, values2, values3], [values4, values5]].
The first columns of each array must be of the same type (in the above example, values1 and values4).
These are combined and sorted into a single column.
Then the subsequent columns are added, filling with null where missing. (This could be an option in future.)
Eg. if the values of each col are: values1=[1,3]; values2=[10,30]; values3=[100,300]; values4=[1,2]; values5=[-1,-2];
then the resulting array of column values are, in order, [1,2,3]; [10,null,30]; [100,null,300]; [-1,-2,null].</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>valueArrays</code></td>
<td class="type">
<span class="param-type">Array.<Array></span>
</td>
<td class="description last"><p>See description above.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ReactViews_Custom_Chart_downloadHrefWorker.js.html">ReactViews/Custom/Chart/downloadHrefWorker.js</a>, <a href="ReactViews_Custom_Chart_downloadHrefWorker.js.html#line17">line 17</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The synthesized values which could be passed to a table structure.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<Array></span>
</dd>
</dl>
<h4 class="name" id="computeRingWindingOrder"><span class="type-signature"></span>computeRingWindingOrder<span class="signature">(ring)</span><span class="type-signature"> → {WindingOrder}</span></h4>
<div class="description">
<p>Determine the winding order of a polygon ring.
See https://github.com/mapbox/vector-tile-spec/tree/master/2.0#4344-polygon-geometry-type && https://en.wikipedia.org/wiki/Shoelace_formula</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>ring</code></td>
<td class="type">
<span class="param-type">Array.<Point></span>
</td>
<td class="description last"><p>The polygon ring as an array of '@mapbox/point-geometry' Points (or any points conforming to {x: number, y: 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_computeRingWindingOrder.js.html">Map/computeRingWindingOrder.js</a>, <a href="Map_computeRingWindingOrder.js.html#line12">line 12</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The winding order of the polygon ring.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">WindingOrder</span>
</dd>
</dl>
<h4 class="name" id="containsAny"><span class="type-signature"></span>containsAny<span class="signature">(s, possibleStrings)</span><span class="type-signature"> → {Boolean}</span></h4>
<div class="description">
<p>Determins is a given string contains any of a number of possible strings.</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>s</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The string to test.</p></td>
</tr>
<tr>
<td class="name"><code>possibleStrings</code></td>
<td class="type">
<span class="param-type">Array.<String></span>
</td>
<td class="description last"><p>The possible strings to test <code>s</code> for.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Core_containsAny.js.html">Core/containsAny.js</a>, <a href="Core_containsAny.js.html#line13">line 13</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>true if <code>s</code> contains any of the strings in <code>possibleStrings</code>; otherwise, false.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id="convertLuceneHit"><span class="type-signature"></span>convertLuceneHit<span class="signature">(locational, item)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Converts from the Lucene schema to a neater one better suited to addresses.</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>locational</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>Whether to set locational to true - this is set for results that came up within the bounding box
passed to #geoCode.</p></td>
</tr>
<tr>
<td class="name"><code>item</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The lucene schema object to convert.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_GnafApi.js.html">Models/GnafApi.js</a>, <a href="Models_GnafApi.js.html#line155">line 155</a>
</li></ul></dd>
</dl>
<h4 class="name" id="convertToDates"><span class="type-signature"></span>convertToDates<span class="signature">(tableColumn)</span><span class="type-signature"> → {Object}</span></h4>
<div class="description">
<p>Simple check to try to guess date format, based on max value of first position.
If dates are consistent with US format, it will use US format (mm-dd-yyyy).</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>tableColumn</code></td>
<td class="type">
<span class="param-type"><a href="TableColumn.html">TableColumn</a></span>
</td>
<td class="description last"><p>The column.</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_TableColumn.js.html">Map/TableColumn.js</a>, <a href="Map_TableColumn.js.html#line532">line 532</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Object with keys:
subtype: The identified subtype, or undefined.
jsDates: The values as javascript dates.
julianDates: The values as JulianDates.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
<h4 class="name" id="correctEntityHeight"><span class="type-signature"></span>correctEntityHeight<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Gets the most detailed height from terrainProvider at currentCartographicPosition and updates entity position.
It starts querying at levelHint and makes its way down to level zero.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_LocationMarkerUtils.js.html">Models/LocationMarkerUtils.js</a>, <a href="Models_LocationMarkerUtils.js.html#line58">line 58</a>
</li></ul></dd>
</dl>
<h4 class="name" id="createCatalogItemFromFileOrUrl"><span class="type-signature"></span>createCatalogItemFromFileOrUrl<span class="signature">(terria, fileOrUrl, dataType<span class="signature-attributes">opt</span>, confirmConversion<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
<div class="description">
<p>Asynchronously creates and loads a catalog item for a given file. The returned promise does not resolve until
the catalog item is successfully loaded, and it rejects if the file is not in the expected format or
another error occurs during loading. If the OGR-based conversion service needs to be invoked to convert the file or URL
to a compatible format, the user</p>
</div>
<h5>Parameters:</h5>
<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>terria</code></td>
<td class="type">
<span class="param-type"><a href="Terria.html">Terria</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The Terria instance in which to create the item.</p></td>
</tr>
<tr>
<td class="name"><code>fileOrUrl</code></td>
<td class="type">
<span class="param-type">File</span>
|
<span class="param-type">String</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The file or URL for which to create a catalog item.</p></td>
</tr>
<tr>
<td class="name"><code>dataType</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
'auto'
</td>
<td class="description last"><p>The type of catalog item to create. If 'auto', the type is deduced from the URL or filename.
If 'other', the OGR-based conversion service is used. This can also be any valid catalog item
<a href="CatalogItem.html#type">CatalogItem#type</a>.</p></td>
</tr>
<tr>
<td class="name"><code>confirmConversion</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>If true, and the OGR-based conversion service needs to be invoked, the user will first
be asked for permission to upload the file to the conversion service. If false, the
user will not be asked for permission. If the user denies the request, the promise
will be rejected with the string 'The user declined to use the conversion service.'.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_createCatalogItemFromFileOrUrl.js.html">Models/createCatalogItemFromFileOrUrl.js</a>, <a href="Models_createCatalogItemFromFileOrUrl.js.html#line30">line 30</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A promise that resolves to the created catalog item.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="createCatalogItemFromUrl"><span class="type-signature"></span>createCatalogItemFromUrl<span class="signature">(url, terria, allowLoad)</span><span class="type-signature"> → {<a href="CatalogMember.html">CatalogMember</a>}</span></h4>
<div class="description">
<p>Creates a type derived from <a href="CatalogMember.html">CatalogMember</a> based on a given URL.</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>url</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The derived type name.</p></td>
</tr>
<tr>
<td class="name"><code>terria</code></td>
<td class="type">
<span class="param-type"><a href="Terria.html">Terria</a></span>
</td>
<td class="description last"><p>The Terria instance.</p></td>
</tr>
<tr>
<td class="name"><code>allowLoad</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="description last"><p>Whether it's ok to attempt to load the URL and detect failures. We generally do this for WMS type services, but not for local files.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_createCatalogItemFromUrl.js.html">Models/createCatalogItemFromUrl.js</a>, <a href="Models_createCatalogItemFromUrl.js.html#line13">line 13</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The constructed data item or promise, or undefined if the URL is not supported.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CatalogMember.html">CatalogMember</a></span>
</dd>
</dl>
<h4 class="name" id="createCatalogMemberFromType"><span class="type-signature"></span>createCatalogMemberFromType<span class="signature">(type, terria)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Creates a type derived from <a href="CatalogMember.html">CatalogMember</a> based on a given type string.</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>type</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The derived type name.</p></td>
</tr>
<tr>
<td class="name"><code>terria</code></td>
<td class="type">
<span class="param-type"><a href="Terria.html">Terria</a></span>
</td>
<td class="description last"><p>The Terria instance.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_createCatalogMemberFromType.js.html">Models/createCatalogMemberFromType.js</a>, <a href="Models_createCatalogMemberFromType.js.html#line17">line 17</a>
</li></ul></dd>
</dl>
<h4 class="name" id="createLeafletCredit"><span class="type-signature"></span>createLeafletCredit<span class="signature">(attribution)</span><span class="type-signature"> → {String}</span></h4>
<div class="description">
<p>A convenient function for handling leaflet credit display</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>attribution</code></td>
<td class="type">
<span class="param-type">Credit</span>
</td>
<td class="description last"><p>the original attribution object for leaflet to display as text or link</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_Leaflet.js.html">Models/Leaflet.js</a>, <a href="Models_Leaflet.js.html#line659">line 659</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The sanitized HTML for the credit.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
<h4 class="name" id="createParameterFromType"><span class="type-signature"></span>createParameterFromType<span class="signature">(type, options)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Creates a type derived from <a href="FunctionParameter.html">FunctionParameter</a> based on a given type string.</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>type</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The derived type name.</p></td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>Options to pass to the constructor.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_createParameterFromType.js.html">Models/createParameterFromType.js</a>, <a href="Models_createParameterFromType.js.html#line34">line 34</a>
</li></ul></dd>
</dl>
<h4 class="name" id="createRegexDeserializer"><span class="type-signature"></span>createRegexDeserializer<span class="signature">(fieldName)</span><span class="type-signature"> → {function}</span></h4>
<div class="description">
<p>Deserializes a regex like ".foo" into a case-insensitive regex /.foo/i.</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>fieldName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The name of the field to serialize.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_createRegexDeserializer.js.html">Models/createRegexDeserializer.js</a>, <a href="Models_createRegexDeserializer.js.html#line12">line 12</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The deserialization function.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">function</span>
</dd>
</dl>
<h4 class="name" id="createRegexSerializer"><span class="type-signature"></span>createRegexSerializer<span class="signature">(fieldName)</span><span class="type-signature"> → {function}</span></h4>
<div class="description">
<p>Serializes a regex like /.foo/i into ".foo".</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>fieldName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The name of the field to serialize.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_createRegexSerializer.js.html">Models/createRegexSerializer.js</a>, <a href="Models_createRegexSerializer.js.html#line12">line 12</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The deserialization function.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">function</span>
</dd>
</dl>
<h4 class="name" id="deIndexWithDescendants"><span class="type-signature"></span>deIndexWithDescendants<span class="signature">(items, index)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Removes all passed items to the passed index, and all the children of those items recursively.</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>items</code></td>
<td class="type">
<span class="param-type">Array.<<a href="CatalogMember.html">CatalogMember</a>></span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogGroup.js.html">Models/CatalogGroup.js</a>, <a href="Models_CatalogGroup.js.html#line364">line 364</a>
</li></ul></dd>
</dl>
<h4 class="name" id="disposeSubscription"><span class="type-signature"></span>disposeSubscription<span class="signature">(component)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Disposes of all subscriptions that a component currently has.</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>component</code></td>
<td class="type">
</td>
<td class="description last"><p>The component to find and dispose subscriptions on.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ReactViews_ObserveModelMixin.js.html">ReactViews/ObserveModelMixin.js</a>, <a href="ReactViews_ObserveModelMixin.js.html#line87">line 87</a>
</li></ul></dd>
</dl>
<h4 class="name" id="EarthGravityModel1996"><span class="type-signature"></span>EarthGravityModel1996<span class="signature">(gridFileUrl)</span><span class="type-signature"></span></h4>
<div class="description">
<p>The Earth Gravity Model 1996 (EGM96) geoid.</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>gridFileUrl</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The URL of the WW15MGH.DAC file.</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_EarthGravityModel1996.js.html">Map/EarthGravityModel1996.js</a>, <a href="Map_EarthGravityModel1996.js.html#line13">line 13</a>
</li></ul></dd>
</dl>
<h4 class="name" id="extendLoad"><span class="type-signature"></span>extendLoad<span class="signature">(catalogMember, f)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Extends a catalog member's <code>load</code> method with another, potentially asynchronous.
load function. The catalog member will not be fully loaded until both the original
and the new load return and their promises resolve.</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>catalogMember</code></td>
<td class="type">
<span class="param-type"><a href="CatalogMember.html">CatalogMember</a></span>
</td>
<td class="description last"><p>The catalog member for which to extend the loading process.</p></td>
</tr>
<tr>
<td class="name"><code>f</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last"><p>The additional load function. This function will be called with <code>this</code> set to the <code>catalogMember</code>.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_extendLoad.js.html">Models/extendLoad.js</a>, <a href="Models_extendLoad.js.html#line13">line 13</a>
</li></ul></dd>
</dl>
<h4 class="name" id="featureDataToGeoJson"><span class="type-signature"></span>featureDataToGeoJson<span class="signature">(featureData)</span><span class="type-signature"> → {Object}</span></h4>
<div class="description">
<p>Converts feature data, such as from a WMS GetFeatureInfo or an Esri Identify, to
GeoJSON. The set of feature data formats supported by this function can be extended
by adding to featureDataToGeoJson#supportedFormats.</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>featureData</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>The feature data to convert to GeoJSON.</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_featureDataToGeoJson.js.html">Map/featureDataToGeoJson.js</a>, <a href="Map_featureDataToGeoJson.js.html#line18">line 18</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The GeoJSON representation of this feature data, or undefined if it cannot be converted to GeoJSON.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
<h4 class="name" id="findKeyForGroupElement"><span class="type-signature"></span>findKeyForGroupElement<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Finds the associated key string for the grouping element provided - e.g. a <Nav> element will resolve to 'nav'</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ReactViews_StandardUserInterface_processCustomElements.js.html">ReactViews/StandardUserInterface/processCustomElements.js</a>, <a href="ReactViews_StandardUserInterface_processCustomElements.js.html#line43">line 43</a>
</li></ul></dd>
</dl>
<h4 class="name" id="flattenCatalog"><span class="type-signature"></span>flattenCatalog<span class="signature">()</span><span class="type-signature"> → {Array}</span></h4>
<div class="description">
<p>Takes the hierarchy of serialized catalog members returned by <a href="global.html#serializeToJson">serializeToJson</a> and flattens it into an Array.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ReactViews_Map_Panels_SharePanel_BuildShareLink.js.html">ReactViews/Map/Panels/SharePanel/BuildShareLink.js</a>, <a href="ReactViews_Map_Panels_SharePanel_BuildShareLink.js.html#line279">line 279</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array</span>
</dd>
</dl>
<h4 class="name" id="formatDate"><span class="type-signature"></span>formatDate<span class="signature">(d, locale<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {string}</span></h4>
<div class="description">
<p>Formats a date according to the locale if provided, otherwise in a dd/mm/yyyy format.</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>d</code></td>
<td class="type">
<span class="param-type">Date</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>the date to format</p></td>
</tr>
<tr>
<td class="name"><code>locale</code></td>
<td class="type">
<span class="param-type">Locale</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>the locale to use for formatting</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ReactViews_BottomDock_Timeline_DateFormats.js.html">ReactViews/BottomDock/Timeline/DateFormats.js</a>, <a href="ReactViews_BottomDock_Timeline_DateFormats.js.html#line12">line 12</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A formatted date.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="formatDateTime"><span class="type-signature"></span>formatDateTime<span class="signature">(d, locale<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {string}</span></h4>
<div class="description">
<p>Combines #formatDate and #formatTime.</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>d</code></td>
<td class="type">
<span class="param-type">Date</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>the date to format</p></td>
</tr>
<tr>
<td class="name"><code>locale</code></td>
<td class="type">
<span class="param-type">Locale</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>the locale to use for formatting</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ReactViews_BottomDock_Timeline_DateFormats.js.html">ReactViews/BottomDock/Timeline/DateFormats.js</a>, <a href="ReactViews_BottomDock_Timeline_DateFormats.js.html#line40">line 40</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A formatted date and time with a comma separating them.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="formatNumberForLocale"><span class="type-signature"></span>formatNumberForLocale<span class="signature">(number, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Format the number using the locale format.
When Intl is not available (includes Safari), applies commas to separate thousands, eg. 912345.6789 => '912,345.6789'.
Nulls are returned as an empty string, not 0.</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>number</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The number to format.</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>A subset of the options of Javascript's Intl NumberFormat,
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toLocaleString .
Note we default useGrouping to false (not true) and maximumFractionDigits to 20 (not 3).</p>
<h6>Properties</h6>
<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>useGrouping</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>A flag for whether to separate thousands. Defaults to false.</p></td>
</tr>
<tr>
<td class="name"><code>minimumFractionDigits</code></td>
<td class="type">
<span class="param-type">Integer</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Minimum number of decimal places. Defaults to 0.</p></td>
</tr>
<tr>
<td class="name"><code>maximumFractionDigits</code></td>
<td class="type">
<span class="param-type">Integer</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Maximum number of decimal places. Defaults to 20.</p></td>
</tr>
<tr>
<td class="name"><code>style</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Pass 'percent' to format 0.83 as 83%.</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="Core_formatNumberForLocale.js.html">Core/formatNumberForLocale.js</a>, <a href="Core_formatNumberForLocale.js.html#line41">line 41</a>
</li></ul></dd>
</dl>
<h4 class="name" id="formatPropertyValue"><span class="type-signature"></span>formatPropertyValue<span class="signature">(value, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Format the value for the description, used by the Feature Info Panel.
Strings have markdown applied to them. Anything else is returned as-is.</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>value</code></td>
<td class="type">
</td>
<td class="attributes">
</td>
<td class="description last"><p>The value to format.</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>Number formatting options, passed to formatNumberForLocale.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Core_formatPropertyValue.js.html">Core/formatPropertyValue.js</a>, <a href="Core_formatPropertyValue.js.html#line14">line 14</a>
</li></ul></dd>
</dl>
<h4 class="name" id="formatTime"><span class="type-signature"></span>formatTime<span class="signature">(d, locale<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {string}</span></h4>
<div class="description">
<p>Formats the time according to the locale if provided, otherwise in a hh:mm:ss format.</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>d</code></td>
<td class="type">
<span class="param-type">Date</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>the date to format</p></td>
</tr>
<tr>
<td class="name"><code>locale</code></td>
<td class="type">
<span class="param-type">Locale</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>the locale to use for formatting</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ReactViews_BottomDock_Timeline_DateFormats.js.html">ReactViews/BottomDock/Timeline/DateFormats.js</a>, <a href="ReactViews_BottomDock_Timeline_DateFormats.js.html#line26">line 26</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A formatted time.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="getAncestors"><span class="type-signature"></span>getAncestors<span class="signature">(member)</span><span class="type-signature"> → {Array.<<a href="CatalogMember.html">CatalogMember</a>>}</span></h4>
<div class="description">
<p>Return the ancestors in the data catalog of the given catalog member, recursively using "member.parent".
The "Root Group" is not included.</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>member</code></td>
<td class="type">
<span class="param-type"><a href="CatalogMember.html">CatalogMember</a></span>
</td>
<td class="description last"><p>The catalog member.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_getAncestors.js.html">Models/getAncestors.js</a>, <a href="Models_getAncestors.js.html#line12">line 12</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The members' ancestors in its parent tree, starting at the top, not including this member.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<<a href="CatalogMember.html">CatalogMember</a>></span>
</dd>
</dl>
<h4 class="name" id="getColumnOptions"><span class="type-signature"></span>getColumnOptions<span class="signature">(name, tableStructure, columnNumber)</span><span class="type-signature"> → {Object}</span></h4>
<div class="description">
<p>Return column options object, using defaults where appropriate.</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</p></td>
</tr>
<tr>
<td class="name"><code>tableStructure</code></td>
<td class="type">
<span class="param-type"><a href="TableStructure.html">TableStructure</a></span>
</td>
<td class="description last"><p>TableStructure to use to calculate values.</p></td>
</tr>
<tr>
<td class="name"><code>columnNumber</code></td>
<td class="type">
<span class="param-type">Int</span>
</td>
<td class="description last"><p>Which column should be used as template for default column options</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#line1298">line 1298</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Column options that TableColumn's constructor understands</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
<h4 class="name" id="getColumnWithNameIdOrIndex"><span class="type-signature"></span>getColumnWithNameIdOrIndex<span class="signature">(nameIdOrIndex, columns)</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>
<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="description last"><p>Test on these 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#line897">line 897</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="getDataUriFormat"><span class="type-signature"></span>getDataUriFormat<span class="signature">(dataUri)</span><span class="type-signature"> → {String}</span></h4>
<div class="description">
<p>Read the format from the start of a data uri, eg. data:attachment/csv,...</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>dataUri</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The data URI.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ReactViews_Preview_Description.js.html">ReactViews/Preview/Description.js</a>, <a href="ReactViews_Preview_Description.js.html#line199">line 199</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The format string, eg. 'csv', or undefined if none found.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
<h4 class="name" id="getGroupChildren"><span class="type-signature"></span>getGroupChildren<span class="signature">(isSmallScreen, groupElement)</span><span class="type-signature"> → {Array.<Element>}</span></h4>
<div class="description">
<p>Gets the children out of a grouping element and sanitises them - e.g. plain strings are converted to <span>s and
elements that need to know about whether we're in small screen configuration are provided with that prop.</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>isSmallScreen</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>Is the screen small?</p></td>
</tr>
<tr>
<td class="name"><code>groupElement</code></td>
<td class="type">
<span class="param-type">Element</span>
</td>
<td class="description last"><p>a grouping element to get children from.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ReactViews_StandardUserInterface_processCustomElements.js.html">ReactViews/StandardUserInterface/processCustomElements.js</a>, <a href="ReactViews_StandardUserInterface_processCustomElements.js.html#line55">line 55</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>a collection of processed children.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<Element></span>
</dd>
</dl>
<h4 class="name" id="getShareData"><span class="type-signature"></span>getShareData<span class="signature">(terria)</span><span class="type-signature"> → {Object}</span></h4>
<div class="description">
<p>Returns just the JSON that defines the current view.</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>terria</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>The Terria object.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ReactViews_Map_Panels_SharePanel_BuildShareLink.js.html">ReactViews/Map/Panels/SharePanel/BuildShareLink.js</a>, <a href="ReactViews_Map_Panels_SharePanel_BuildShareLink.js.html#line34">line 34</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
<h4 class="name" id="getTemporalFiltersContext"><span class="type-signature"></span>getTemporalFiltersContext<span class="signature">(item, procedure<span class="signature-attributes">opt</span>, observableProperty<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array.<Object>}</span></h4>
<div class="description">
<p>Return the Mustache template context "temporalFilters" for this item.
If a "defaultDuration" parameter (eg. 60d or 12h) exists on either
procedure or observableProperty, restrict to that duration from item.endDate.</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>item</code></td>
<td class="type">
<span class="param-type"><a href="SensorObservationServiceCatalogItem.html">SensorObservationServiceCatalogItem</a></span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>This catalog item.</p></td>
</tr>
<tr>
<td class="name"><code>procedure</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>An element from the item.procedures array.</p></td>
</tr>
<tr>
<td class="name"><code>observableProperty</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>An element from the item.observableProperties array.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_SensorObservationServiceCatalogItem.js.html">Models/SensorObservationServiceCatalogItem.js</a>, <a href="Models_SensorObservationServiceCatalogItem.js.html#line417">line 417</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>An array of {index, startDate, endDate}, or undefined.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<Object></span>
</dd>
</dl>
<h4 class="name" id="getUniqueValues"><span class="type-signature"></span>getUniqueValues<span class="signature">(values)</span><span class="type-signature"> → {Array}</span></h4>
<div class="description">
<p>Return only the unique values of an array.</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>values</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last"><p>An array of anything.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Core_getUniqueValues.js.html">Core/getUniqueValues.js</a>, <a href="Core_getUniqueValues.js.html#line8">line 8</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The same array with only the first occurence of each value included.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array</span>
</dd>
</dl>
<h4 class="name" id="gmlToGeoJson"><span class="type-signature"></span>gmlToGeoJson<span class="signature">(xml)</span><span class="type-signature"> → {Object}</span></h4>
<div class="description">
<p>Converts a GML v3.1.1 simple features document to GeoJSON.</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>xml</code></td>
<td class="type">
<span class="param-type">Document</span>
|
<span class="param-type">String</span>
</td>
<td class="description last"><p>The GML document.</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_gmlToGeoJson.js.html">Map/gmlToGeoJson.js</a>, <a href="Map_gmlToGeoJson.js.html#line14">line 14</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The GeoJSON object.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
<h4 class="name" id="hostInDomains"><span class="type-signature"></span>hostInDomains<span class="signature">(host, domains)</span><span class="type-signature"> → {boolean}</span></h4>
<div class="description">
<p>Determines whether this host is, or is a subdomain of, an item in the provided array.</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>host</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The host to search for</p></td>
</tr>
<tr>
<td class="name"><code>domains</code></td>
<td class="type">
<span class="param-type">Array.<String></span>
</td>
<td class="description last"><p>The array of domains to look in</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Core_CorsProxy.js.html">Core/CorsProxy.js</a>, <a href="Core_CorsProxy.js.html#line175">line 175</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The result.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id="isBrowserCompatible"><span class="type-signature"></span>isBrowserCompatible<span class="signature">()</span><span class="type-signature"> → {Boolean}</span></h4>
<div class="description">
<p>Determines if this browser has any hope of running TerriaJS. Specifically, this function checks for the presence
of the basic ECMAScript 5 function "Object.create".</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Core_isBrowserCompatible.js.html">Core/isBrowserCompatible.js</a>, <a href="Core_isBrowserCompatible.js.html#line10">line 10</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>true if this web browser has a chance of running TerriaJS, or false if the browser is so old (pre-IE9)
that there is no chance of a good result.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id="isCommonMobilePlatform"><span class="type-signature"></span>isCommonMobilePlatform<span class="signature">(userAgentString<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Boolean}</span></h4>
<div class="description">
<p>Determines if this is a common mobile platform such as iOS, Android, or Windows Phone.</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>userAgentString</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>The user agent string to check. If this property is not specified, <code>window.navigator.userAgent</code> is used.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Core_isCommonMobilePlatform.js.html">Core/isCommonMobilePlatform.js</a>, <a href="Core_isCommonMobilePlatform.js.html#line11">line 11</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>[description]</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id="Legend"><span class="type-signature"></span>Legend<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Legend object for generating and displaying a legend.
Constructor: new Legend(props), where props is an object containing many properties.
Other than the "items" property, it is preferable to leave other properties to their defaults
for style consistency.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_Legend.js.html">Map/Legend.js</a>, <a href="Map_Legend.js.html#line16">line 16</a>
</li></ul></dd>
</dl>
<h4 class="name" id="markdownToHtml"><span class="type-signature"></span>markdownToHtml<span class="signature">(markdownString, allowUnsafeHtml, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {String}</span></h4>
<div class="description">
<p>Convert a String in markdown format (which includes html) into html format.</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>markdownString</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>String in markdown format.</p></td>
</tr>
<tr>
<td class="name"><code>allowUnsafeHtml</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>Pass true to allow unsafe html. Defaults to false.</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 to pass to DOMPurify, eg. {ADD_TAGS: ['ying', 'yang']} (https://github.com/cure53/DOMPurify).</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Core_markdownToHtml.js.html">Core/markdownToHtml.js</a>, <a href="Core_markdownToHtml.js.html#line22">line 22</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>HTML-formatted string.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
<h4 class="name" id="markerVisible"><span class="type-signature"></span>markerVisible<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Determines whether the location marker is visible previously added in #addMarker.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_LocationMarkerUtils.js.html">Models/LocationMarkerUtils.js</a>, <a href="Models_LocationMarkerUtils.js.html#line75">line 75</a>
</li></ul></dd>
</dl>
<h4 class="name" id="NowViewing"><span class="type-signature"></span>NowViewing<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>The model for the "Now Viewing" pane.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_NowViewing.js.html">Models/NowViewing.js</a>, <a href="Models_NowViewing.js.html#line16">line 16</a>
</li></ul></dd>
</dl>
<h4 class="name" id="overrideProperty"><span class="type-signature"></span>overrideProperty<span class="signature">(owner, propertyName, descriptor)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Overrides a Knockout property definition. Change notification is raised on the old property, if any, to encourage
listeners to subscribe to the new one.</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>owner</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>The owner of the property.</p></td>
</tr>
<tr>
<td class="name"><code>propertyName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The name of the property.</p></td>
</tr>
<tr>
<td class="name"><code>descriptor</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>The property descriptor, just like the one that would be passed to <code>knockout.defineProperty</code>
or <code>Object.defineProperty</code>.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Core_overrideProperty.js.html">Core/overrideProperty.js</a>, <a href="Core_overrideProperty.js.html#line16">line 16</a>
</li></ul></dd>
</dl>
<h4 class="name" id="pad"><span class="type-signature"></span>pad<span class="signature">(s)</span><span class="type-signature"> → {string}</span></h4>
<div class="description">
<p>Puts a leading 0 in front of a number of it's less than 10.</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>s</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>A number to pad</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ReactViews_BottomDock_Timeline_DateFormats.js.html">ReactViews/BottomDock/Timeline/DateFormats.js</a>, <a href="ReactViews_BottomDock_Timeline_DateFormats.js.html#line50">line 50</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A string representing a two-digit number.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="parseCustomHtmlToReact"><span class="type-signature"></span>parseCustomHtmlToReact<span class="signature">(html, context<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {ReactElement}</span></h4>
<div class="description">
<p>Return html as a React Element.</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>html</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>context</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Provide any further information that custom components need to know here, eg. which feature and catalogItem they come from.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ReactViews_Custom_parseCustomHtmlToReact.js.html">ReactViews/Custom/parseCustomHtmlToReact.js</a>, <a href="ReactViews_Custom_parseCustomHtmlToReact.js.html#line86">line 86</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">ReactElement</span>
</dd>
</dl>
<h4 class="name" id="parseCustomMarkdownToReact"><span class="type-signature"></span>parseCustomMarkdownToReact<span class="signature">(raw, context<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {ReactElement}</span></h4>
<div class="description">
<p>Converts a string from markdown format (of which html is a subset) into a ReactElement.</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>raw</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>String in markdown or html.</p></td>
</tr>
<tr>
<td class="name"><code>context</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Provide any further information that custom components need to know here, eg. which feature and catalogItem they come from.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ReactViews_Custom_parseCustomMarkdownToReact.js.html">ReactViews/Custom/parseCustomMarkdownToReact.js</a>, <a href="ReactViews_Custom_parseCustomMarkdownToReact.js.html#line11">line 11</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">ReactElement</span>
</dd>
</dl>
<h4 class="name" id="PickedFeatures"><span class="type-signature"></span>PickedFeatures<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Holds the vector and raster features that the user picked by clicking the mouse on the map.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_PickedFeatures.js.html">Map/PickedFeatures.js</a>, <a href="Map_PickedFeatures.js.html#line9">line 9</a>
</li></ul></dd>
</dl>
<h4 class="name" id="prettifyCoordinates"><span class="type-signature"></span>prettifyCoordinates<span class="signature">(longitude, latitude, options)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Turns the longitude / latitude in degrees into a human readable pretty strings.</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>longitude</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The longitude to format.</p></td>
</tr>
<tr>
<td class="name"><code>latitude</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The latitude to format.</p></td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>Object with the following properties:</p>
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>height</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The height.</p></td>
</tr>
<tr>
<td class="name"><code>errorBar</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The error +/- for the height.</p></td>
</tr>
<tr>
<td class="name"><code>digits</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The number of digits to fix the lat / lon to.</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_prettifyCoordinates.js.html">Map/prettifyCoordinates.js</a>, <a href="Map_prettifyCoordinates.js.html#line16">line 16</a>
</li></ul></dd>
</dl>
<h4 class="name" id="prettifyProjection"><span class="type-signature"></span>prettifyProjection<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Turns the longitude / latitude in degrees into a human readable pretty UTM zone representation.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Map_prettifyProjection.js.html">Map/prettifyProjection.js</a>, <a href="Map_prettifyProjection.js.html#line8">line 8</a>
</li></ul></dd>
</dl>
<h4 class="name" id="printWindow"><span class="type-signature"></span>printWindow<span class="signature">(windowToPrint)</span><span class="type-signature"> → {Promise}</span></h4>
<div class="description">
<p>Tells the web browser to print a given window, which my be an iframe window, and
returns a promise that resolves when printing is safely over so that, for example
the window can be removed.</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>windowToPrint</code></td>
<td class="type">
<span class="param-type">Window</span>
</td>
<td class="description last"><p>The window to print.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Core_printWindow.js.html">Core/printWindow.js</a>, <a href="Core_printWindow.js.html#line12">line 12</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A promise that resolves when printing is safely over. The prommise is rejected if
there is no indication that the browser's print</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="processAddress"><span class="type-signature"></span>processAddress<span class="signature">(address)</span><span class="type-signature"> → {string}</span></h4>
<div class="description">
<p>Processes a single address to make it more palatable for the search engine.</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>address</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Address to process</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_GnafApi.js.html">Models/GnafApi.js</a>, <a href="Models_GnafApi.js.html#line224">line 224</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Processed address</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="propertyGetTimeValues"><span class="type-signature"></span>propertyGetTimeValues<span class="signature">(properties, currentTime)</span><span class="type-signature"> → {Object}</span></h4>
<div class="description">
<p>Gets the values from a Entity's properties object for the time on the current clock.</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>properties</code></td>
<td class="type">
</td>
<td class="description last"><p>An entity's property object</p></td>
</tr>
<tr>
<td class="name"><code>currentTime</code></td>
<td class="type">
<span class="param-type">JulianDate</span>
</td>
<td class="description last"><p>The current time if it is a time varying catalog item.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Core_propertyGetTimeValues.js.html">Core/propertyGetTimeValues.js</a>, <a href="Core_propertyGetTimeValues.js.html#line12">line 12</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>a simple key-value object of properties.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
<h4 class="name" id="readJson"><span class="type-signature"></span>readJson<span class="signature">(file)</span><span class="type-signature"> → {Object}</span></h4>
<div class="description">
<p>Try to read the file as JSON. If that fails, try JSON5.</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>file</code></td>
<td class="type">
<span class="param-type">File</span>
</td>
<td class="description last"><p>The file.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Core_readJson.js.html">Core/readJson.js</a>, <a href="Core_readJson.js.html#line14">line 14</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The JSON or json5 object described by the file.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
<h4 class="name" id="rectangleToLatLngBounds"><span class="type-signature"></span>rectangleToLatLngBounds<span class="signature">(rectangle)</span><span class="type-signature"> → {L.latLngBounds}</span></h4>
<div class="description">
<p>Converts a Cesium Rectangle into a Leaflet LatLngBounds.</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>rectangle</code></td>
<td class="type">
<span class="param-type">Rectangle</span>
</td>
<td class="description last"><p>The rectangle to convert.</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_rectangleToLatLngBounds.js.html">Map/rectangleToLatLngBounds.js</a>, <a href="Map_rectangleToLatLngBounds.js.html#line12">line 12</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The equivalent Leaflet latLngBounds.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">L.latLngBounds</span>
</dd>
</dl>
<h4 class="name" id="RegionDataValue"><span class="type-signature"></span>RegionDataValue<span class="signature">(regionCodes, columnHeadings, table, singleSelectValues)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Holds a collection of region data.</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>regionCodes</code></td>
<td class="type">
<span class="param-type">Array.<String></span>
</td>
<td class="description last"><p>The list of region codes.</p></td>
</tr>
<tr>
<td class="name"><code>columnHeadings</code></td>
<td class="type">
<span class="param-type">Array.<String></span>
</td>
<td class="description last"><p>The list of column headings describing the values associated with each region.</p></td>
</tr>
<tr>
<td class="name"><code>table</code></td>
<td class="type">
<span class="param-type">Array.<Array.<Number>></span>
</td>
<td class="description last"><p>An array of arrays where each array in the outer array corresponds to a single region in the regionCodes list
and each inner array has a value corresponding to each colum in columnHeadings. For a RegionDataParameter#singleSelect
parameter, this property should be undefined.</p></td>
</tr>
<tr>
<td class="name"><code>singleSelectValues</code></td>
<td class="type">
<span class="param-type">Array.<Number></span>
</td>
<td class="description last"><p>The single value for each region. For a parameter that is not RegionDataParameter#singleSelect, this
property should be undefined.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_RegionDataValue.js.html">Models/RegionDataValue.js</a>, <a href="Models_RegionDataValue.js.html#line14">line 14</a>
</li></ul></dd>
</dl>
<h4 class="name" id="registerCustomComponentTypes"><span class="type-signature"></span>registerCustomComponentTypes<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Registers custom component types.</p>
<p>Here we define the following:</p>
<ul>
<li><chart></li>
<li><collapsible>
You can define your own by replacing this file with your own version.</li>
</ul>
<p><collapsible> displays a collapsible section (see Collapsible.jsx) around its children components.
It has two allowed attributes:</p>
<ul>
<li>title: The title of the section.</li>
<li>[open]: true or false (the default).</li>
</ul>
<p><chart> displays an interactive chart (see Chart.jsx), along with "expand" and "download" buttons (ChartExpandAndDownloadButtons.jsx).
This button enables a catalog item based on the data, for display in the Chart Panel (ChartPanel.jsx).
It also detects if it appears in the second column of a <table> and, if so, rearranges itself to span two columns.</p>
<p>It can have the following attributes. Currently URLs must point to csv (not json) data; but inline json data is supported.
Note if you change any of these, also update the chartAttributes array above, or they won't make it here.</p>
<ul>
<li>[title]: The title of the chart. If not supplied, defaults to the name of the context-supplied feature, if available, or else simply "Chart".</li>
<li>[x-column]: The x column name or number to show in the preview, if not the first appropriate column. NOT FULLY IMPLEMENTED YET.</li>
<li>[y-column]: The y column name or number to show in the preview, if not the first scalar column.</li>
<li>[y-columns]: Comma-separated list of y column names or numbers to show in the preview. Overrides "y-column" if provided.</li>
<li>[colors]: Comma-separated list of css colors to apply to data columns.</li>
<li>[column-names]: Comma-separated list of column names to override those in the source data; empty strings retain the original column name.<pre class="prettyprint source"><code> Eg. column-names="Time,Height,Speed"</code></pre></li>
<li>[column-units]: Comma-separated list of the units for each column. Empty strings are ok.<pre class="prettyprint source"><code> Eg. column-units=",m,km/h"</code></pre></li>
<li>[preview-x-label]: The preview chart x-axis label. Defaults to empty string. Eg. long-names="Last 24 hours,Last 5 days,Time".</li>
<li>[id]: An id for the chart; give different charts from the same feature different ids. The actual catalogItem.id used for the expanded chart will<pre class="prettyprint source"><code> also incorporate the chart title and the catalog item name it came from.</code></pre></li>
<li>[styling]: Defaults to 'feature-info'. Can also be 'histogram'. TODO: improve.</li>
<li>[highlight-x]: An x-coordinate to highlight.</li>
<li>[poll-seconds]: If present, the chart is updated from [poll-sources] every [poll-seconds] seconds.<pre class="prettyprint source"><code> TODO: Returned data is merged into existing data and shown.</code></pre></li>
<li>[poll-sources]: Comma-separated list of URLs to poll every [poll-seconds] seconds. Defaults to sources.</li>
<li>[poll-replace]: Either 'true' or 'false' (case sensitive). Pass 'true' to completely replace the data, 'false' to update<pre class="prettyprint source"><code> the existing data. Defaults to false (updating).</code></pre></li>
<li>[can-download]: 'false' to hide the Download button on the chart. By default true and for any other value, the download button is shown.</li>
<li>[hide-buttons]: 'true' to hide the Expand and Download buttons on the chart. By default and for any other value, the buttons are shown when applicable.<pre class="prettyprint source"><code> Overrides can-download.</code></pre></li>
</ul>
<p>Provide the data in one of these four ways:</p>
<ul>
<li>[sources]: Comma-separated URLs for data at each available time range. The first in the list is shown in the feature info panel preview.<pre class="prettyprint source"><code> Eg. sources="http://example.com/series?offset=1d,http://example.com/series?offset=5d,http://example.com/series?all"</code></pre></li>
<li>[source-names]: Comma-separated display names for each available time range, used in the expand-chart dropdown button.<pre class="prettyprint source"><code> Eg. source-names="1d,5d,30d".</code></pre></li>
<li>[downloads]: Same as sources, but for download only. Defaults to the same as sources.<pre class="prettyprint source"><code> Eg. sources="http://example.com/series?offset=1d,http://example.com/series?offset=5d,http://example.com/series?all"</code></pre></li>
<li>[download-names]: Same as source-names, but for download only. Defaults to the same as source-names.<pre class="prettyprint source"><code> Eg. source-names="1d,5d,30d,max".</code></pre>Or:</li>
<li>[src]: The URL of the data to show in the chart panel, once "expand" is clicked. Eg. src="http://example.com/full_time_series.csv".</li>
<li>[src-preview]: The URL of the data to show in the feature info panel. Defaults to src. Eg. src-preview="http://example.com/preview_time_series.csv".
Or:</li>
<li>[data]: csv-formatted data, with \n for newlines. Eg. data="time,a,b\n2016-01-01,2,3\n2016-01-02,5,6".<pre class="prettyprint source"><code> or json-formatted string data, with \quot; for quotes, eg. data="[[\quot;a\quot;,\quot;b\quot;],[2,3],[5,6]]".</code></pre>Or:</li>
<li>None of the above, but supply csv or json-formatted data as the content of the chart data, with \n for newlines.<pre class="prettyprint source"><code> Eg. <chart>time,a,b\n2016-01-01,2,3\n2016-01-02,5,6</chart>.
or <chart>[["x","y","z"],[1,10,3],[2,15,9],[3,8,12],[5,25,4]]</chart>.</code></pre></li>
</ul>
<p>See CustomComponentType for more details.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ReactViews_Custom_registerCustomComponentTypes.js.html">ReactViews/Custom/registerCustomComponentTypes.js</a>, <a href="ReactViews_Custom_registerCustomComponentTypes.js.html#line122">line 122</a>
</li></ul></dd>
</dl>
<h4 class="name" id="rememberRejections"><span class="type-signature"></span>rememberRejections<span class="signature">(filterFn)</span><span class="type-signature"> → {Object}</span></h4>
<div class="description">
<p>Wraps around a filter function and records all items that are excluded by it. Does not modify the function 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>filterFn</code></td>
<td class="type">
</td>
<td class="description last"><p>The fn to wrap around</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ReactViews_Map_Panels_SharePanel_BuildShareLink.js.html">ReactViews/Map/Panels/SharePanel/BuildShareLink.js</a>, <a href="ReactViews_Map_Panels_SharePanel_BuildShareLink.js.html#line258">line 258</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The resulting filter function that remembers rejections, and an array
array of the rejected items. As the filter function is used, the rejections array with be populated.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
<h4 class="name" id="removeMarker"><span class="type-signature"></span>removeMarker<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Removes a marker previously added in #addMarker.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_LocationMarkerUtils.js.html">Models/LocationMarkerUtils.js</a>, <a href="Models_LocationMarkerUtils.js.html#line69">line 69</a>
</li></ul></dd>
</dl>
<h4 class="name" id="replaceUnderscores"><span class="type-signature"></span>replaceUnderscores<span class="signature">(string)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Replace all underscores in the string with spaces. If the argument is not a string, return it unchanged.</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>string</code></td>
<td class="type">
</td>
<td class="description last"><p>The string to replace. If the argument is not a string, does nothing.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Core_replaceUnderscores.js.html">Core/replaceUnderscores.js</a>, <a href="Core_replaceUnderscores.js.html#line8">line 8</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The argument with all underscores replaced with spaces. If the argument is not a string, returns the argument unchanged.</p>
</div>
<h4 class="name" id="sanitiseAddressNumber"><span class="type-signature"></span>sanitiseAddressNumber<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Sanitises a number (e.g. flat number, unit number etc) from lucene - these are set to -1 if they don't exist,
we'd prefer if they were undefined.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_GnafApi.js.html">Models/GnafApi.js</a>, <a href="Models_GnafApi.js.html#line189">line 189</a>
</li></ul></dd>
</dl>
<h4 class="name" id="selectBaseMap"><span class="type-signature"></span>selectBaseMap<span class="signature">(terria, baseMaps, defaultBaseMapName, useStoredPreference)</span><span class="type-signature"> → {BaseMapViewModel}</span></h4>
<div class="description">
<p>Selects a base map by name from a list of base map options. The name is specified by <code>terria.baseMapName</code>, or,
if that property is undefined, by the specified <code>defaultBaseMapName</code>. In addition to setting <code>terria.baseMap</code>,
this function subscribes to be notified when <code>terria.baseMapName</code> changes and updates <code>terria.baseMap</code>
accordingly. If a base map with the name is not in the <code>baseMaps</code> list, this method leaves the
<code>terria.baseMap</code> property unmodified.</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>terria</code></td>
<td class="type">
<span class="param-type"><a href="Terria.html">Terria</a></span>
</td>
<td class="description last"><p>The TerriaJS application.</p></td>
</tr>
<tr>
<td class="name"><code>baseMaps</code></td>
<td class="type">
<span class="param-type">Array.<BaseMapViewModel></span>
</td>
<td class="description last"><p>The list of possible base maps.</p></td>
</tr>
<tr>
<td class="name"><code>defaultBaseMapName</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The name of the base map to search for.</p></td>
</tr>
<tr>
<td class="name"><code>useStoredPreference</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>If true, look for and use a localStorage preference instead.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ViewModels_selectBaseMap.js.html">ViewModels/selectBaseMap.js</a>, <a href="ViewModels_selectBaseMap.js.html#line20">line 20</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The matching base map, or undefined if not found.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">BaseMapViewModel</span>
</dd>
</dl>
<h4 class="name" id="serializeToJson"><span class="type-signature"></span>serializeToJson<span class="signature">(target, filterFunction, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Object}</span></h4>
<div class="description">
<p>Serializes an object to JSON.</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>target</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The object to serialize.</p></td>
</tr>
<tr>
<td class="name"><code>filterFunction</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>A function that, when passed the name of a property as its only parameter, returns true if that property should be serialized and false otherwise.</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>Optional parameters to custom serializers.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Core_serializeToJson.js.html">Core/serializeToJson.js</a>, <a href="Core_serializeToJson.js.html#line13">line 13</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>An object literal corresponding to the serialized object, ready to pass to <code>JSON.stringify</code>.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
<h4 class="name" id="ServerConfig"><span class="type-signature"></span>ServerConfig<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Provides information about the configuration of the Terria server, by querying /serverconfig</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Core_ServerConfig.js.html">Core/ServerConfig.js</a>, <a href="Core_ServerConfig.js.html#line12">line 12</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setClockCurrentTime"><span class="type-signature"></span>setClockCurrentTime<span class="signature">(clock, initialTimeSource)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Sets the current time of the clock, using a string defined specification for the time point to use.</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>clock</code></td>
<td class="type">
<span class="param-type">DataSourceClock</span>
</td>
<td class="description last"><p>clock to set the current time on.</p></td>
</tr>
<tr>
<td class="name"><code>initialTimeSource</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>A string specifiying the value to use when setting the currentTime of the clock. 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>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_setClockCurrentTime.js.html">Models/setClockCurrentTime.js</a>, <a href="Models_setClockCurrentTime.js.html#line41">line 41</a>
</li></ul></dd>
</dl>
<h4 class="name" id="shouldBeUpdated"><span class="type-signature"></span>shouldBeUpdated<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Determines whether this property is valid for updating.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Core_updateFromJson.js.html">Core/updateFromJson.js</a>, <a href="Core_updateFromJson.js.html#line36">line 36</a>
</li></ul></dd>
</dl>
<h4 class="name" id="sortByFirst"><span class="type-signature"></span>sortByFirst<span class="signature">(valueArrays)</span><span class="type-signature"> → {Array.<Array>}</span></h4>
<div class="description">
<p>Eg. sortByFirst([['b', 'a', 'c'], [1, 2, 3]]) = [['a', 'b', 'c'], [2, 1, 3]].</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>valueArrays</code></td>
<td class="type">
<span class="param-type">Array.<Array></span>
</td>
<td class="description last"><p>The array of arrays of values to 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="ReactViews_Custom_Chart_downloadHrefWorker.js.html">ReactViews/Custom/Chart/downloadHrefWorker.js</a>, <a href="ReactViews_Custom_Chart_downloadHrefWorker.js.html#line60">line 60</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The values sorted by the first column.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<Array></span>
</dd>
</dl>
<h4 class="name" id="sortedIndices"><span class="type-signature"></span>sortedIndices<span class="signature">(array, compareFunction<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array}</span></h4>
<div class="description">
<p>Returns indices such that array[indices[i]] = sortedArray[i].
Eg. sortedIndices(['c', 'a', 'b', 'd']) => [1, 2, 0, 3]. (The sorted array is [a, b, c, d], and "a" was in position 1, "b" in position 2, etc.)</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>array</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The array to sort.</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 usual compare function, eg. function(a, b) { return a - b }.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Core_sortedIndices.js.html">Core/sortedIndices.js</a>, <a href="Core_sortedIndices.js.html#line10">line 10</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The sorted indices, such that array[sortedIndices[0]] = sortedArray[0].</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array</span>
</dd>
</dl>
<h4 class="name" id="splitIntoBatches"><span class="type-signature"></span>splitIntoBatches<span class="signature">(arrayToSplit, batchSize)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Breaks an array into pieces, putting them in another array.</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>arrayToSplit</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last"><p>array to split</p></td>
</tr>
<tr>
<td class="name"><code>batchSize</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>maximum number of items in each array at end</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_GnafApi.js.html">Models/GnafApi.js</a>, <a href="Models_GnafApi.js.html#line251">line 251</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>array containing other arrays, which contain a maxiumum number of items in each.</p>
</div>
<h4 class="name" id="supportsWebGL"><span class="type-signature"></span>supportsWebGL<span class="signature">()</span><span class="type-signature"> → {Boolean|String}</span></h4>
<div class="description">
<p>Determines if the current browser supports WebGL.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Core_supportsWebGL.js.html">Core/supportsWebGL.js</a>, <a href="Core_supportsWebGL.js.html#line14">line 14</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>False if WebGL is not supported at all, 'slow' if WebGL is supported
but it has a major performance caveat (e.g. software rendering), and True
if WebGL is available without a major performance caveat.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
|
<span class="param-type">String</span>
</dd>
</dl>
<h4 class="name" id="TerriaViewer"><span class="type-signature"></span>TerriaViewer<span class="signature">(terria, options)</span><span class="type-signature"></span></h4>
<div class="description">
<p>The Terria map viewer, utilizing Cesium and Leaflet.</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>terria</code></td>
<td class="type">
<span class="param-type"><a href="Terria.html">Terria</a></span>
</td>
<td class="description last"><p>The Terria instance.</p></td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>Object with the following properties:</p>
<h6>Properties</h6>
<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>developerAttribution</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Attribution for the map developer, displayed at the bottom of the map. This is an
object with two properties, <code>text</code> and <code>link</code>. <code>link</code> is optional and is the URL to open when the user
clicks on the attribution.</p></td>
</tr>
<tr>
<td class="name"><code>terrain</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">TerrainProvider</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>The terrain to use in the 3D view. This may be a string, in which case it is loaded using
<code>CesiumTerrainProvider</code>, or it may be a <code>TerrainProvider</code>. If this property is undefined, STK World Terrain
is used.</p></td>
</tr>
<tr>
<td class="name"><code>maximumLeafletZoomLevel</code></td>
<td class="type">
<span class="param-type">Integer</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>The maximum level to which to allow Leaflet to zoom to.
If this property is undefined, Leaflet defaults to level 18.</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="ViewModels_TerriaViewer.js.html">ViewModels/TerriaViewer.js</a>, <a href="ViewModels_TerriaViewer.js.html#line75">line 75</a>
</li></ul></dd>
</dl>
<h4 class="name" id="toArrayOfRows"><span class="type-signature"></span>toArrayOfRows<span class="signature">(columnValueArrays, columnNames)</span><span class="type-signature"> → {Array.<Array>}</span></h4>
<div class="description">
<p>Convert an array of column values, with column names, to an array of row 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>columnValueArrays</code></td>
<td class="type">
<span class="param-type">Array.<Array></span>
</td>
<td class="description last"><p>Array of column values, eg. [[1,2,3], [4,5,6]].</p></td>
</tr>
<tr>
<td class="name"><code>columnNames</code></td>
<td class="type">
<span class="param-type">Array.<String></span>
</td>
<td class="description last"><p>Array of column names, eg ['x', 'y'].</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ReactViews_Custom_Chart_downloadHrefWorker.js.html">ReactViews/Custom/Chart/downloadHrefWorker.js</a>, <a href="ReactViews_Custom_Chart_downloadHrefWorker.js.html#line106">line 106</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Array of rows, starting with the column names, eg. [['x', 'y'], [1, 4], [2, 5], [3, 6]].</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<Array></span>
</dd>
</dl>
<h4 class="name" id="triggerResize"><span class="type-signature"></span>triggerResize<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Trigger a window resize event.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Core_triggerResize.js.html">Core/triggerResize.js</a>, <a href="Core_triggerResize.js.html#line6">line 6</a>
</li></ul></dd>
</dl>
<h4 class="name" id="unionRectangleArray"><span class="type-signature"></span>unionRectangleArray<span class="signature">(rectangles)</span><span class="type-signature"> → {Rectangle}</span></h4>
<div class="description">
<p>Computes the union of an array of rectangles. This function is not 180-meridian safe.</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>rectangles</code></td>
<td class="type">
<span class="param-type">Array.<Rectangle></span>
</td>
<td class="description last"><p>The array of rectangles to union.</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_unionRectangleArray.js.html">Map/unionRectangleArray.js</a>, <a href="Map_unionRectangleArray.js.html#line13">line 13</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The union of the rectangles, or undefined if the array of rectangles is empty.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Rectangle</span>
</dd>
</dl>
<h4 class="name" id="unionRectangles"><span class="type-signature"></span>unionRectangles<span class="signature">(first, second, result<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Rectangle}</span></h4>
<div class="description">
<p>Computes the union of two rectangles. This function is not 180-meridian safe.</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>first</code></td>
<td class="type">
<span class="param-type">Rectangle</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The first rectangle to union.</p></td>
</tr>
<tr>
<td class="name"><code>second</code></td>
<td class="type">
<span class="param-type">Rectangle</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The second rectangle to union.</p></td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type">Rectangle</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>The existing Rectangle to which to copy the result instead of creating and returning a new instance.</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_unionRectangles.js.html">Map/unionRectangles.js</a>, <a href="Map_unionRectangles.js.html#line15">line 15</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The union of the two rectangles.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Rectangle</span>
</dd>
</dl>
<h4 class="name" id="updateApplicationOnHashChange"><span class="type-signature"></span>updateApplicationOnHashChange<span class="signature">(terria, window, urlShortener<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Updates the <a href="Terria.html">Terria</a> when the window's 'hashchange' event is raised. This allows new init files and
"start=" URLs to be loaded just by changing the hash portion of the URL in the browser's address bar.</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>terria</code></td>
<td class="type">
<span class="param-type"><a href="Terria.html">Terria</a></span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The Terria instance to update.</p></td>
</tr>
<tr>
<td class="name"><code>window</code></td>
<td class="type">
<span class="param-type">Window</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The browser's window DOM object.</p></td>
</tr>
<tr>
<td class="name"><code>urlShortener</code></td>
<td class="type">
<span class="param-type">UrlShortener</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>The URL shortener to use to expand short URLs. If this property is undefined, short URLs will not be expanded.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ViewModels_updateApplicationOnHashChange.js.html">ViewModels/updateApplicationOnHashChange.js</a>, <a href="ViewModels_updateApplicationOnHashChange.js.html#line14">line 14</a>
</li></ul></dd>
</dl>
<h4 class="name" id="updateFromJson"><span class="type-signature"></span>updateFromJson<span class="signature">(target, json, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
<div class="description">
<p>Updates an object from a JSON representation of the object. Only properties that actually exist on the object are read from the JSON,
and the object has the opportunity to inject specialized deserialization logic by providing an <code>updaters</code> property.</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>target</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The object to update from the JSON.</p></td>
</tr>
<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>The JSON description. The JSON should be in the form of an object literal, not a string.</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>Optional parameters to custom updaters.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Core_updateFromJson.js.html">Core/updateFromJson.js</a>, <a href="Core_updateFromJson.js.html#line15">line 15</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A promise that resolves when the update completes.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="updateRectangleFromRegion"><span class="type-signature"></span>updateRectangleFromRegion<span class="signature">(catalogItem, regionProvider, region)</span><span class="type-signature"> → {Promise}</span></h4>
<div class="description">
<p>Updates the <a href="CatalogItem.html#rectangle">CatalogItem#rectangle</a> property of a <a href="CatalogItem.html">CatalogItem</a> to be the bounding rectangle
of a given region.</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>catalogItem</code></td>
<td class="type">
<span class="param-type"><a href="CatalogItem.html">CatalogItem</a></span>
</td>
<td class="description last"><p>The catalog item to update.</p></td>
</tr>
<tr>
<td class="name"><code>regionProvider</code></td>
<td class="type">
<span class="param-type"><a href="RegionProvider.html">RegionProvider</a></span>
</td>
<td class="description last"><p>The region provider.</p></td>
</tr>
<tr>
<td class="name"><code>region</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>The region from which to update the rectangle. The region must be known to the region provider.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_updateRectangleFromRegion.js.html">Models/updateRectangleFromRegion.js</a>, <a href="Models_updateRectangleFromRegion.js.html#line16">line 16</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A promise that resolves when the rectangle has been updated. This promise silently resolves
if an error occurs while trying to update the rectangle.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h3 class="subsection-title">Type Definitions</h3>
<h4 class="name" id="CleanUpCallback"><span class="type-signature"></span>CleanUpCallback<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Callback for when clean up is happening, i.e., for done or cancel.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_UserDrawing.js.html">Models/UserDrawing.js</a>, <a href="Models_UserDrawing.js.html#line31">line 31</a>
</li></ul></dd>
</dl>
<h4 class="name" id="MakeDialogMessageCallback"><span class="type-signature"></span>MakeDialogMessageCallback<span class="signature">()</span><span class="type-signature"> → {String}</span></h4>
<div class="description">
<p>Callback for when the dialog is displayed, to provide a custom message</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_UserDrawing.js.html">Models/UserDrawing.js</a>, <a href="Models_UserDrawing.js.html#line36">line 36</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Message to add to dialog</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
<h4 class="name" id="PointClickedCallback"><span class="type-signature"></span>PointClickedCallback<span class="signature">(customDataSource)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Callback for when a point is clicked.</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>customDataSource</code></td>
<td class="type">
<span class="param-type"><a href="CustomDataSource.html">CustomDataSource</a></span>
</td>
<td class="description last"><p>Contains all point entities that user has selected so far</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_UserDrawing.js.html">Models/UserDrawing.js</a>, <a href="Models_UserDrawing.js.html#line19">line 19</a>
</li></ul></dd>
</dl>
<h4 class="name" id="PointMovedCallback"><span class="type-signature"></span>PointMovedCallback<span class="signature">(customDataSource)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Callback for when a point is moved.</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>customDataSource</code></td>
<td class="type">
<span class="param-type"><a href="CustomDataSource.html">CustomDataSource</a></span>
</td>
<td class="description last"><p>Contains all point entities that user has selected so far</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_UserDrawing.js.html">Models/UserDrawing.js</a>, <a href="Models_UserDrawing.js.html#line25">line 25</a>
</li></ul></dd>
</dl>
<h4 class="name" id="PointMovedCallback"><span class="type-signature"></span>PointMovedCallback<span class="signature">(customDataSource)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Callback for when a point is moved.</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>customDataSource</code></td>
<td class="type">
<span class="param-type"><a href="CustomDataSource.html">CustomDataSource</a></span>
</td>
<td class="description last"><p>Contains all point entities that user has selected so far</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_CesiumDragPoints.js.html">Map/CesiumDragPoints.js</a>, <a href="Map_CesiumDragPoints.js.html#line9">line 9</a>
</li></ul></dd>
</dl>
<h4 class="name" id="PointMovedCallback"><span class="type-signature"></span>PointMovedCallback<span class="signature">(customDataSource)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Callback for when a point is moved.</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>customDataSource</code></td>
<td class="type">
<span class="param-type"><a href="CustomDataSource.html">CustomDataSource</a></span>
</td>
<td class="description last"><p>Contains all point entities that user has selected so far</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_DragPoints.js.html">Map/DragPoints.js</a>, <a href="Map_DragPoints.js.html#line9">line 9</a>
</li></ul></dd>
</dl>
<h4 class="name" id="PointMovedCallback"><span class="type-signature"></span>PointMovedCallback<span class="signature">(customDataSource)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Callback for when a point is moved.</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>customDataSource</code></td>
<td class="type">
<span class="param-type"><a href="CustomDataSource.html">CustomDataSource</a></span>
</td>
<td class="description last"><p>Contains all point entities that user has selected so far</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_LeafletDragPoints.js.html">Map/LeafletDragPoints.js</a>, <a href="Map_LeafletDragPoints.js.html#line7">line 7</a>
</li></ul></dd>
</dl>
<h4 class="name" id="PostDisplayHookCallback"><span class="type-signature"></span>PostDisplayHookCallback<span class="signature">(viewState)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Callback after screen is displayed.</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>viewState</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>ViewState.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ReactViewModels_HelpScreen.js.html">ReactViewModels/HelpScreen.js</a>, <a href="ReactViewModels_HelpScreen.js.html#line13">line 13</a>
</li></ul></dd>
</dl>
<h4 class="name" id="PreDisplayHookCallback"><span class="type-signature"></span>PreDisplayHookCallback<span class="signature">(viewState)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Callback before screen is displayed.</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>viewState</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>ViewState.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ReactViewModels_HelpScreen.js.html">ReactViewModels/HelpScreen.js</a>, <a href="ReactViewModels_HelpScreen.js.html#line7">line 7</a>
</li></ul></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:20 GMT+1000 (AUS Eastern Standard Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>