terriajs
Version:
Geospatial data visualization platform.
4,249 lines (987 loc) • 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>
</