terriajs
Version:
Geospatial data visualization platform.
10,713 lines • 169 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: IonImageryCatalogItem</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: IonImageryCatalogItem</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>IonImageryCatalogItem<span class="signature">(terria)</span><span class="type-signature"></span></h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="IonImageryCatalogItem"><span class="type-signature"></span>new IonImageryCatalogItem<span class="signature">(terria)</span><span class="type-signature"></span></h4>
<div class="description">
<p>A <a href="ImageryLayerCatalogItem____.html">ImageryLayerCatalogItem</a> representing an imagery layer from Cesium Ion.</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>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_IonImageryCatalogItem.js.html">Models/IonImageryCatalogItem.js</a>, <a href="Models_IonImageryCatalogItem.js.html#line19">line 19</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li><a href="ImageryLayerCatalogItem____.html">ImageryLayerCatalogItem</a></li>
</ul>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="_memoizedInfoItemsSourceLookup"><span class="type-signature"></span>_memoizedInfoItemsSourceLookup<span class="type-signature"></span></h4>
<div class="description">
<p>Lookup table for _sourceInfoItemNames, access through CatalogMember#_infoItemsWithSourceInfoLookup</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogMember.html#_memoizedInfoItemsSourceLookup">CatalogMember#_memoizedInfoItemsSourceLookup</a>
</li></ul></dd>
<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#line196">line 196</a>
</li></ul></dd>
</dl>
<h4 class="name" id="An"><span class="type-signature"></span>An<span class="type-signature"> :Array.<Date></span></h4>
<div class="description">
<p>Gets javascript dates describing the discrete datetimes (or intervals) available for this item.
By declaring this as a knockout defined property, it is cached.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<Date></span>
</li>
</ul>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="ImageryLayerCatalogItem.html#An">ImageryLayerCatalogItem#An</a>
</li></ul></dd>
<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#line169">line 169</a>
</li></ul></dd>
</dl>
<h4 class="name" id="attribution"><span class="type-signature"></span>attribution<span class="type-signature"> :Credit</span></h4>
<div class="description">
<p>Gets or sets an attribution displayed on the map when this catalog item is enabled.
This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Credit</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#attribution">CatalogItem#attribution</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line85">line 85</a>
</li></ul></dd>
</dl>
<h4 class="name" id="cacheDuration"><span class="type-signature"></span>cacheDuration<span class="type-signature"> :String</span></h4>
<div class="description">
<p>Gets or sets the cache duration to use for proxied URLs for this catalog member. If undefined, proxied URLs are effectively cachable
forever. The duration is expressed as a Varnish-like duration string, such as '1d' (one day) or '10000s' (ten thousand seconds).</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogMember.html#cacheDuration">CatalogMember#cacheDuration</a>
</li></ul></dd>
<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#line104">line 104</a>
</li></ul></dd>
</dl>
<h4 class="name" id="canZoomTo"><span class="type-signature"></span>canZoomTo<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Returns true if this item currently has a rectangle to zoom to. Depends on observable properties, and so updates once loaded.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#canZoomTo">CatalogItem#canZoomTo</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line503">line 503</a>
</li></ul></dd>
</dl>
<h4 class="name" id="clampedDiscreteTime"><span class="type-signature"></span>clampedDiscreteTime<span class="type-signature"> :Date</span></h4>
<div class="description">
<p>Gets the CatalogItems current time as the discrete time that the CatalogItem has information for.
Returns the nearest time in-range if the clock is beyond the range of the intervals specified by the layer.
Returns undefined if it is not possible to query the time (i.e. the item doesn't have a clock, availableDates or
intervals).</p>
<p>See also discreteTime if you want the discrete time that is undefined if the current time is beyond the range of
the intervals specified by the item.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Date</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#clampedDiscreteTime">CatalogItem#clampedDiscreteTime</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line368">line 368</a>
</li></ul></dd>
</dl>
<h4 class="name" id="clipToRectangle"><span class="type-signature"></span>clipToRectangle<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets or sets a value indicating whether this dataset should be clipped to the <a href="CatalogItem.html#rectangle">CatalogItem#rectangle</a>.
If true, no part of the dataset will be displayed outside the rectangle. This property is true by default,
leading to better performance and avoiding tile request errors that might occur when requesting tiles outside the
server-specified rectangle. However, it may also cause features to be cut off in some cases, such as if a server
reports an extent that does not take into account that the representation of features sometimes require a larger
spatial extent than the features themselves. For example, if a point feature on the edge of the extent is drawn
as a circle with a radius of 5 pixels, half of that circle will be cut off.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ImageryLayerCatalogItem.html#clipToRectangle">ImageryLayerCatalogItem#clipToRectangle</a>
</li></ul></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>false</li>
</ul></dd>
<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#line111">line 111</a>
</li></ul></dd>
</dl>
<h4 class="name" id="clock"><span class="type-signature"></span>clock<span class="type-signature"> :DataSourceClock</span></h4>
<div class="description">
<p>Gets or sets the clock parameters for this data item. If this property is undefined, this data item
does not have any time-varying data. This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">DataSourceClock</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#clock">CatalogItem#clock</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line129">line 129</a>
</li></ul></dd>
</dl>
<h4 class="name" id="currentTime"><span class="type-signature"></span>currentTime<span class="type-signature"> :JulianDate</span></h4>
<div class="description">
<p>Gets / sets the CatalogItems current time.</p>
<p>This property is an observable version of clock.currentTime, they will always have the same value.</p>
<p>When setting the currentTime through this property the correct clock (terria.clock or this.clock) is updated
depending on whether .useOwnClock is true or false so that the catalog items state will reflect the new time
correctly.</p>
<p>The get component of this property is effectively an interface adapter for clock.definitionChanged which changes
the structure from an Event when the current time changes to a knockout property which can be observed.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">JulianDate</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#currentTime">CatalogItem#currentTime</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line319">line 319</a>
</li></ul></dd>
</dl>
<h4 class="name" id="customProperties"><span class="type-signature"></span>customProperties<span class="type-signature"> :Object</span></h4>
<div class="description">
<p>Gets or sets the dictionary of custom item properties. This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogMember.html#customProperties">CatalogMember#customProperties</a>
</li></ul></dd>
<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#line117">line 117</a>
</li></ul></dd>
</dl>
<h4 class="name" id="dataCustodian"><span class="type-signature"></span>dataCustodian<span class="type-signature"> :String</span></h4>
<div class="description">
<p>Gets or sets a description of the custodian of this data item.
This property is an HTML string that must be sanitized before display to the user.
This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#dataCustodian">CatalogItem#dataCustodian</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line78">line 78</a>
</li></ul></dd>
</dl>
<h4 class="name" id="dataUrl"><span class="type-signature"></span>dataUrl<span class="type-signature"> :String</span></h4>
<div class="description">
<p>Gets or sets the URL from which this data item's raw data can be retrieved, or undefined if raw data for
this data item is not available. This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#dataUrl">CatalogItem#dataUrl</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line274">line 274</a>
</li></ul></dd>
</dl>
<h4 class="name" id="dataUrlType"><span class="type-signature"></span>dataUrlType<span class="type-signature"> :String</span></h4>
<div class="description">
<p>Gets or sets the type of the <a href="CatalogItem.html#dataUrl">CatalogItem#dataUrl</a>, or undefined if raw data for this data
source is not available. This property is observable.
Valid values are:</p>
<ul>
<li><code>direct</code> - A direct link to the data.</li>
<li><code>wfs</code> - A Web Feature Service (WFS) base URL. If <a href="CatalogItem.html#dataUrl">CatalogItem#dataUrl</a> is not<pre class="prettyprint source"><code> specified, the base URL will be this data item's URL.</code></pre></li>
<li><code>wfs-complete</code> - A complete, ready-to-use link to download features from a WFS server.</li>
<li><code>none</code> - There is no data link.</li>
</ul>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#dataUrlType">CatalogItem#dataUrlType</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line294">line 294</a>
</li></ul></dd>
</dl>
<h4 class="name" id="dateFormat"><span class="type-signature"></span>dateFormat<span class="type-signature"> :Object</span></h4>
<div class="description">
<p>Options for formatting current time and timeline tic labels. Options are:
currentTime // Current time in time slider will be shown in this format. For example "mmmm yyyy" for Jan 2016.
timelineTic // Timeline tics will have this label. For example "yyyy" will cause each tic to be labelled with the year.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#dateFormat">CatalogItem#dateFormat</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line198">line 198</a>
</li></ul></dd>
</dl>
<h4 class="name" id="description"><span class="type-signature"></span>description<span class="type-signature"> :String</span></h4>
<div class="description">
<p>Gets or sets the description of the item. This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogMember.html#description">CatalogMember#description</a>
</li></ul></dd>
<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#line44">line 44</a>
</li></ul></dd>
</dl>
<h4 class="name" id="discreteTime"><span class="type-signature"></span>discreteTime<span class="type-signature"> :Date</span></h4>
<div class="description">
<p>Gets the CatalogItems current time as the discrete time that the CatalogItem has information for.
Returns undefined if the clock is beyond the range of the intervals specified by the layer.
Returns undefined if it is not possible to query the time (i.e. the item doesn't have a clock, availableDates or
intervals).</p>
<p>See also clampedDiscreteTime if you want the discrete time that is clamped to the first / last value if the current
time is beyond the range of the intervals specified by the item.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Date</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#discreteTime">CatalogItem#discreteTime</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line350">line 350</a>
</li></ul></dd>
</dl>
<h4 class="name" id="displayChoicesBeforeLegend"><span class="type-signature"></span>displayChoicesBeforeLegend<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets or sets a flag which determines whether the legend comes before (false) or after (true) the display variable choice.
Default false.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#displayChoicesBeforeLegend">CatalogItem#displayChoicesBeforeLegend</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line122">line 122</a>
</li></ul></dd>
</dl>
<h4 class="name" id="featureInfoTemplate"><span class="type-signature"></span>featureInfoTemplate<span class="type-signature"> :String|Object</span></h4>
<div class="description">
<p>Gets or sets a template to display message in a info box.
May be a string or an object with template, name and/or partials properties.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
|
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#featureInfoTemplate">CatalogItem#featureInfoTemplate</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line168">line 168</a>
</li></ul></dd>
</dl>
<h4 class="name" id="forceProxy"><span class="type-signature"></span>forceProxy<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets or sets whether or not this member should be forced to use a proxy.
This property is not observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogMember.html#forceProxy">CatalogMember#forceProxy</a>
</li></ul></dd>
<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#line111">line 111</a>
</li></ul></dd>
</dl>
<h4 class="name" id="hasDescription"><span class="type-signature"></span>hasDescription<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Tests whether a description is available, either in the 'description' property
or as a member of the 'info' array.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogMember.html#hasDescription">CatalogMember#hasDescription</a>
</li></ul></dd>
<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#line326">line 326</a>
</li></ul></dd>
</dl>
<h4 class="name" id="hasLegend"><span class="type-signature"></span>hasLegend<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets a value indicating whether this data item has a legend.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#hasLegend">CatalogItem#hasLegend</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line492">line 492</a>
</li></ul></dd>
</dl>
<h4 class="name" id="hideSource"><span class="type-signature"></span>hideSource<span class="type-signature"> :boolean</span></h4>
<div class="description">
<p>Indicates that the source of this data should be hidden from the UI (obviously this isn't super-secure as you
can just look at the network requests).</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogMember.html#hideSource">CatalogMember#hideSource</a>
</li></ul></dd>
<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#line174">line 174</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>An optional unique id for this member, that is stable across renames and moves.
Use uniqueId to get the canonical unique id for this CatalogMember, which is present even if there is no id.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogMember.html#id">CatalogMember#id</a>
</li></ul></dd>
<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#line124">line 124</a>
</li></ul></dd>
</dl>
<h4 class="name" id="ignoreUnknownTileErrors"><span class="type-signature"></span>ignoreUnknownTileErrors<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets or sets a value indicating whether non-specific (no HTTP status code) tile errors should be ignored. This is a
last resort, for dealing with odd cases such as data sources that return non-images (eg XML) with a 200 status code.
No error messages will be shown to the user.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ImageryLayerCatalogItem.html#ignoreUnknownTileErrors">ImageryLayerCatalogItem#ignoreUnknownTileErrors</a>
</li></ul></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>false</li>
</ul></dd>
<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#line83">line 83</a>
</li></ul></dd>
</dl>
<h4 class="name" id="imageryLayer"><span class="type-signature"></span>imageryLayer<span class="type-signature"> :Object</span></h4>
<div class="description">
<p>Gets the Cesium or Leaflet imagery layer object associated with this data source.
This property is undefined if the data source is not enabled.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ImageryLayerCatalogItem.html#imageryLayer">ImageryLayerCatalogItem#imageryLayer</a>
</li></ul></dd>
<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#line218">line 218</a>
</li></ul></dd>
</dl>
<h4 class="name" id="info"><span class="type-signature"></span>info<span class="type-signature"> :Array.<Object></span></h4>
<div class="description">
<p>Gets or sets the array of section titles and contents for display in the layer info panel.
In future this may replace 'description' above - this list should not contain
sections named 'description' or 'Description' if the 'description' property
is also set as both will be displayed.
The object is of the form {name:string, content:string}.
Content will be rendered as Markdown with HTML.
This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<Object></span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogMember.html#info">CatalogMember#info</a>
</li></ul></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>[]</li>
</ul></dd>
<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#line57">line 57</a>
</li></ul></dd>
</dl>
<h4 class="name" id="infoSectionOrder"><span class="type-signature"></span>infoSectionOrder<span class="type-signature"> :Array.<String></span></h4>
<div class="description">
<p>Gets or sets the array of section titles definining the display order of info sections. If this property
is not defined, DataPreviewSections's DEFAULT_SECTION_ORDER is used. This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<String></span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogMember.html#infoSectionOrder">CatalogMember#infoSectionOrder</a>
</li></ul></dd>
<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#line64">line 64</a>
</li></ul></dd>
</dl>
<h4 class="name" id="initialMessage"><span class="type-signature"></span>initialMessage<span class="type-signature"> :Object</span></h4>
<div class="description">
<p>A message object that is presented to the user when an item or group is initially clicked
The object is of the form {title:string, content:string, key: string, confirmation: boolean, confirmText: string, width: number, height: number}.
This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogMember.html#initialMessage">CatalogMember#initialMessage</a>
</li></ul></dd>
<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#line97">line 97</a>
</li></ul></dd>
</dl>
<h4 class="name" id="initialTimeSource"><span class="type-signature"></span>initialTimeSource<span class="type-signature"> :String</span></h4>
<div class="description">
<p>Options for the value of the animation timeline at start. Valid options in config file are:
initialTimeSource: "present" // closest to today's date
initialTimeSource: "start" // start of time range of animation
initialTimeSource: "end" // end of time range of animation
initialTimeSource: An ISO8601 date e.g. "2015-08-08" // specified date or nearest if date is outside range</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ImageryLayerCatalogItem.html#initialTimeSource">ImageryLayerCatalogItem#initialTimeSource</a>
</li></ul></dd>
<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#line130">line 130</a>
</li></ul></dd>
</dl>
<h4 class="name" id="intervals"><span class="type-signature"></span>intervals<span class="type-signature"> :Array.<ImageryLayerInterval></span></h4>
<div class="description">
<p>Gets or sets the TimeIntervalCollection defining the intervals of distinct imagery. If this catalog item
is not time-dynamic, property is undefined. This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<ImageryLayerInterval></span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ImageryLayerCatalogItem.html#intervals">ImageryLayerCatalogItem#intervals</a>
</li></ul></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>undefined</li>
</ul></dd>
<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#line91">line 91</a>
</li></ul></dd>
</dl>
<h4 class="name" id="ionAccessToken"><span class="type-signature"></span>ionAccessToken<span class="type-signature"> :String</span></h4>
<div class="description">
<p>Gets or sets the Cesium Ion access token to use to access the imagery. If not specified, the token specified
using the <code>cesiumIonAccessToken</code> property in <code>config.json</code> is used.</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_IonImageryCatalogItem.js.html">Models/IonImageryCatalogItem.js</a>, <a href="Models_IonImageryCatalogItem.js.html#line33">line 33</a>
</li></ul></dd>
</dl>
<h4 class="name" id="ionAssetId"><span class="type-signature"></span>ionAssetId<span class="type-signature"> :Number</span></h4>
<div class="description">
<p>Gets or sets the ID of the Cesium Ion asset to access.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_IonImageryCatalogItem.js.html">Models/IonImageryCatalogItem.js</a>, <a href="Models_IonImageryCatalogItem.js.html#line26">line 26</a>
</li></ul></dd>
</dl>
<h4 class="name" id="ionServer"><span class="type-signature"></span>ionServer<span class="type-signature"> :String</span></h4>
<div class="description">
<p>Gets or sets the Cesium Ion access token to use to access the imagery. If not specified, the default Ion
server, <code>https://api.cesium.com/</code>, is used.</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_IonImageryCatalogItem.js.html">Models/IonImageryCatalogItem.js</a>, <a href="Models_IonImageryCatalogItem.js.html#line40">line 40</a>
</li></ul></dd>
</dl>
<h4 class="name" id="isEnabled"><span class="type-signature"></span>isEnabled<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets or sets a value indicating whether this data item is enabled. An enabled data item appears in the
"Now Viewing" pane, but is not necessarily shown on the map. This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#isEnabled">CatalogItem#isEnabled</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line101">line 101</a>
</li></ul></dd>
</dl>
<h4 class="name" id="isGroup"><span class="type-signature"></span>isGroup<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets a value that tells the UI whether this is a group.
Groups, when clicked, expand to show their constituent items.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogMember.html#isGroup">CatalogMember#isGroup</a>
</li></ul></dd>
<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#line262">line 262</a>
</li></ul></dd>
</dl>
<h4 class="name" id="isHidden"><span class="type-signature"></span>isHidden<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets or sets a value indicating whether this item is hidden from the catalog. This
property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogMember.html#isHidden">CatalogMember#isHidden</a>
</li></ul></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>false</li>
</ul></dd>
<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#line89">line 89</a>
</li></ul></dd>
</dl>
<h4 class="name" id="isLegendVisible"><span class="type-signature"></span>isLegendVisible<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets or sets a value indicating whether the legend for this data item is currently visible.
This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#isLegendVisible">CatalogItem#isLegendVisible</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line115">line 115</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 this data source is currently loading. This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#isLoading">CatalogItem#isLoading</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line135">line 135</a>
</li></ul></dd>
</dl>
<h4 class="name" id="isMappable"><span class="type-signature"></span>isMappable<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets or sets a value indicating whether this data source is mappable.
This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#isMappable">CatalogItem#isMappable</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line149">line 149</a>
</li></ul></dd>
</dl>
<h4 class="name" id="isPromoted"><span class="type-signature"></span>isPromoted<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets or sets a value indicating whether this item is kept above other non-promoted items.
This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogMember.html#isPromoted">CatalogMember#isPromoted</a>
</li></ul></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>false</li>
</ul></dd>
<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#line81">line 81</a>
</li></ul></dd>
</dl>
<h4 class="name" id="isRequiredForRendering"><span class="type-signature"></span>isRequiredForRendering<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets or sets a value indicating whether tiles of this catalog item are required to be loaded before terrain
tiles to which they're attached can be rendered. This should usually be set to true for base layers and
false for all others.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ImageryLayerCatalogItem.html#isRequiredForRendering">ImageryLayerCatalogItem#isRequiredForRendering</a>
</li></ul></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>false</li>
</ul></dd>
<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#line120">line 120</a>
</li></ul></dd>
</dl>
<h4 class="name" id="isShown"><span class="type-signature"></span>isShown<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets or sets a value indicating whether this data item is currently shown on the map. In order to be shown,
the item must also be enabled. This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#isShown">CatalogItem#isShown</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line108">line 108</a>
</li></ul></dd>
</dl>
<h4 class="name" id="isUserSupplied"><span class="type-signature"></span>isUserSupplied<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets or sets a value indicating whether this member was supplied by the user rather than loaded from one of the
<a href="Terria.html#initSources">Terria#initSources</a>. User-supplied members must be serialized completely when, for example,
serializing enabled members for sharing. This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogMember.html#isUserSupplied">CatalogMember#isUserSupplied</a>
</li></ul></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>true</li>
</ul></dd>
<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#line73">line 73</a>
</li></ul></dd>
</dl>
<h4 class="name" id="isWaitingForDisclaimer"><span class="type-signature"></span>isWaitingForDisclaimer<span class="type-signature"> :boolean</span></h4>
<div class="description">
<p>Whether this catalog member is waiting for a disclaimer to be accepted before showing itself.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogMember.html#isWaitingForDisclaimer">CatalogMember#isWaitingForDisclaimer</a>
</li></ul></dd>
<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#line166">line 166</a>
</li></ul></dd>
</dl>
<h4 class="name" id="keepOnTop"><span class="type-signature"></span>keepOnTop<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Keeps the layer on top of all other imagery layers. This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ImageryLayerCatalogItem.html#keepOnTop">ImageryLayerCatalogItem#keepOnTop</a>
</li></ul></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>false</li>
</ul></dd>
<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#line98">line 98</a>
</li></ul></dd>
</dl>
<h4 class="name" id="layerTitles"><span class="type-signature"></span>layerTitles<span class="type-signature"> :Array.<String></span></h4>
<div class="description">
<p>Gets the title of each of the layers in <a href="WebMapServiceCatalogItem.html#layers">WebMapServiceCatalogItem#layers</a>. If the layer
titles are not yet known (because GetCapabilities has not been loaded yet, for example), this
property will return undefined.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<String></span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ImageryLayerCatalogItem.html#layerTitles">ImageryLayerCatalogItem#layerTitles</a>
</li></ul></dd>
<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#line449">line 449</a>
</li></ul></dd>
</dl>
<h4 class="name" id="legendUrl"><span class="type-signature"></span>legendUrl<span class="type-signature"> :<a href="LegendUrl.html">LegendUrl</a></span></h4>
<div class="description">
<p>Gets or sets the URL of the legend to show when this catalog item is enabled. If there is more than one
legend URL, this property returns the first one.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="LegendUrl.html">LegendUrl</a></span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#legendUrl">CatalogItem#legendUrl</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line245">line 245</a>
</li></ul></dd>
</dl>
<h4 class="name" id="legendUrls"><span class="type-signature"></span>legendUrls<span class="type-signature"> :<a href="LegendUrl.html">LegendUrl</a></span></h4>
<div class="description">
<p>Gets or sets the URLs of the legends to show when this catalog item is enabled.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="LegendUrl.html">LegendUrl</a></span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#legendUrls">CatalogItem#legendUrls</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line224">line 224</a>
</li></ul></dd>
</dl>
<h4 class="name" id="maximumShownFeatureInfos"><span class="type-signature"></span>maximumShownFeatureInfos<span class="type-signature"> :Number</span></h4>
<div class="description">
<p>The maximum number of features whose information can be shown at one time in the Feature Info Panel, from this item.
Defaults to terria.configParameters.defaultMaximumShownFeatureInfos</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Number</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#maximumShownFeatureInfos">CatalogItem#maximumShownFeatureInfos</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line175">line 175</a>
</li></ul></dd>
</dl>
<h4 class="name" id="metadata"><span class="type-signature"></span>metadata<span class="type-signature"> :<a href="Metadata.html">Metadata</a></span></h4>
<div class="description">
<p>Gets the metadata associated with this data item and the server that provided it, if applicable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="Metadata.html">Metadata</a></span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#metadata">CatalogItem#metadata</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogFunction.js.html">Models/CatalogFunction.js</a>, <a href="Models_CatalogFunction.js.html#line83">line 83</a>
</li></ul></dd>
</dl>
<h4 class="name" id="metadataUrl"><span class="type-signature"></span>metadataUrl<span class="type-signature"> :String</span></h4>
<div class="description">
<p>Gets or sets the URL from which this data item's metadata description can be retrieved, or undefined if
metadata is not available for this data item. The format of the metadata depends on the type of data item.
For example, Web Map Service (WMS) data items provide their metadata via their GetCapabilities document.
This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#metadataUrl">CatalogItem#metadataUrl</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line94">line 94</a>
</li></ul></dd>
</dl>
<h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :String</span></h4>
<div class="description">
<p>Gets or sets the name of the item. This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogMember.html#name">CatalogMember#name</a>
</li></ul></dd>
<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#line38">line 38</a>
</li></ul></dd>
</dl>
<h4 class="name" id="nameInCatalog"><span class="type-signature"></span>nameInCatalog<span class="type-signature"> :String</span></h4>
<div class="description">
<p>Gets or sets the name of this catalog member in the catalog. By default this is just <code>name</code>, but can be overridden.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogMember.html#nameInCatalog">CatalogMember#nameInCatalog</a>
</li></ul></dd>
<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#line216">line 216</a>
</li></ul></dd>
</dl>
<h4 class="name" id="nowViewingMessage"><span class="type-signature"></span>nowViewingMessage<span class="type-signature"> :String</span></h4>
<div class="description">
<p>Gets or sets a message to show when this item is enabled for the first time in order to call attention to the Now Viewing panel.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#nowViewingMessage">CatalogItem#nowViewingMessage</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line161">line 161</a>
</li></ul></dd>
</dl>
<h4 class="name" id="opacity"><span class="type-signature"></span>opacity<span class="type-signature"> :Number</span></h4>
<div class="description">
<p>Gets or sets the opacity (alpha) of the data item, where 0.0 is fully transparent and 1.0 is
fully opaque. This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Number</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ImageryLayerCatalogItem.html#opacity">ImageryLayerCatalogItem#opacity</a>
</li></ul></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>0.6</li>
</ul></dd>
<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#line56">line 56</a>
</li></ul></dd>
</dl>
<h4 class="name" id="parent"><span class="type-signature"></span>parent<span class="type-signature"> :<a href="CatalogGroup.html">CatalogGroup</a></span></h4>
<div class="description">
<p>The parent <a href="CatalogGroup.html">CatalogGroup</a> of this member.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="CatalogGroup.html">CatalogGroup</a></span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogMember.html#parent">CatalogMember#parent</a>
</li></ul></dd>
<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#line139">line 139</a>
</li></ul></dd>
</dl>
<h4 class="name" id="propertiesForSharing"><span class="type-signature"></span>propertiesForSharing<span class="type-signature"> :Array.<String></span></h4>
<div class="description">
<p>Gets the set of names of the properties to be serialized for this object for a share link.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<String></span>
</li>
</ul>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="ImageryLayerCatalogItem____.html#propertiesForSharing">ImageryLayerCatalogItem#propertiesForSharing</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_AbsIttCatalogItem.js.html">Models/AbsIttCatalogItem.js</a>, <a href="Models_AbsIttCatalogItem.js.html#line283">line 283</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 or sets the geographic rectangle (extent or bounding box) containing this data item. This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Rectangle</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#rectangle">CatalogItem#rectangle</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line64">line 64</a>
</li></ul></dd>
</dl>
<h4 class="name" id="serializers"><span class="type-signature"></span>serializers<span class="type-signature"> :Object</span></h4>
<div class="description">
<p>Gets the set of functions used to serialize individual properties in <a href="CatalogMember.html#serializeToJson">CatalogMember#serializeToJson</a>.
When a property name on the model matches the name of a property in the serializers object literal,
the value will be called as a function and passed a reference to the model, a reference to the destination
JSON object literal, and the name of the property.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ImageryLayerCatalogItem____.html#serializers">ImageryLayerCatalogItem#serializers</a>
</li></ul></dd>
<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#line280">line 280</a>
</li></ul></dd>
</dl>
<h4 class="name" id="shareKeys"><span class="type-signature"></span>shareKeys<span class="type-signature"> :Array.<String></span></h4>
<div class="description">
<p>An array of all possible keys that can be used to match to this catalog member when specified in a share link -
used for maintaining backwards compatibility when adding or changing <a href="CatalogMember.html#id">CatalogMember#id</a>.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<String></span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogMember.html#shareKeys">CatalogMember#shareKeys</a>
</li></ul></dd>
<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#line132">line 132</a>
</li></ul></dd>
</dl>
<h4 class="name" id="shortReport"><span class="type-signature"></span>shortReport<span class="type-signature"> :String</span></h4>
<div class="description">
<p>A short report to show on the now viewing tab. This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogMember.html#shortReport">CatalogMember#shortReport</a>
</li></ul></dd>
<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#line145">line 145</a>
</li></ul></dd>
</dl>
<h4 class="name" id="shortReportSections"><span class="type-signature"></span>shortReportSections<span class="type-signature"> :Array.<ShortReportSection></span></h4>
<div class="description">
<p>The list of collapsible sections of the short report. Each element of the array is an object literal
with a <code>name</code> and <code>content</code> property.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<ShortReportSection></span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogMember.html#shortReportSections">CatalogMember#shortReportSections</a>
</li></ul></dd>
<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#line152">line 152</a>
</li></ul></dd>
</dl>
<h4 class="name" id="showsInfo"><span class="type-signature"></span>showsInfo<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets or sets a value indicating whether this data source should show an info icon. This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#showsInfo">CatalogItem#showsInfo</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line155">line 155</a>
</li></ul></dd>
</dl>
<h4 class="name" id="splitDirection"><span class="type-signature"></span>splitDirection<span class="type-signature"> :ImagerySplitDirection</span></h4>
<div class="description">
<p>Gets or sets which side of the splitter (if present) to display this imagery layer on. Defaults to both sides.
This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">ImagerySplitDirection</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ImageryLayerCatalogItem____.html#splitDirection">ImageryLayerCatalogItem#splitDirection</a>
</li></ul></dd>
<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#line137">line 137</a>
</li></ul></dd>
</dl>
<h4 class="name" id="supportsOpacity"><span class="type-signature"></span>supportsOpacity<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets a value indicating whether the opacity of this data source can be changed.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="ImageryLayerCatalogItem____.html#supportsOpacity">ImageryLayerCatalogItem#supportsOpacity</a>
</li></ul></dd>
<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#line241">line 241</a>
</li></ul></dd>
</dl>
<h4 class="name" id="supportsReordering"><span class="type-signature"></span>supportsReordering<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets a value indicating whether this data source, when enabled, can be reordered with respect to other data sources.
Data sources that cannot be reordered are typically displayed above reorderable data sources.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ImageryLayerCatalogItem____.html#supportsReordering">ImageryLayerCatalogItem#supportsReordering</a>
</li></ul></dd>
<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#line230">line 230</a>
</li></ul></dd>
</dl>
<h4 class="name" id="supportsSplitting"><span class="type-signature"></span>supportsSplitting<span class="type-signature"></span></h4>
<div class="description">
<p>Gets a value indicating whether this layer can be split so that it is
only shown on the left or right side of the screen.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ImageryLayerCatalogItem____.html#supportsSplitting">ImageryLayerCatalogItem#supportsSplitting</a>
</li></ul></dd>
<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#line252">line 252</a>
</li></ul></dd>
</dl>
<h4 class="name" id="supportsToggleShown"><span class="type-signature"></span>supportsToggleShown<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets a value indicating whether the visibility of this data item can be toggled.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#supportsToggleShown">CatalogItem#supportsToggleShown</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line459">line 459</a>
</li></ul></dd>
</dl>
<h4 class="name" id="terria"><span class="type-signature"></span>terria<span class="type-signature"> :<a href="Terria.html">Terria</a></span></h4>
<div class="description">
<p>Gets the Terria instance.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="Terria.html">Terria</a></span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogMember.html#terria">CatalogMember#terria</a>
</li></ul></dd>
<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#line273">line 273</a>
</li></ul></dd>
</dl>
<h4 class="name" id="treat403AsError"><span class="type-signature"></span>treat403AsError<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets or sets a value indicating whether a 403 response code when requesting a tile should be
treated as an error. If false, 403s are assumed to just be missing tiles and need not be
reported to the user.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ImageryLayerCatalogItem____.html#treat403AsError">ImageryLayerCatalogItem#treat403AsError</a>
</li></ul></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>false</li>
</ul></dd>
<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#line74">line 74</a>
</li></ul></dd>
</dl>
<h4 class="name" id="treat404AsError"><span class="type-signature"></span>treat404AsError<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets or sets a value indicating whether a 404 response code when requesting a tile should be
treated as an error. If false, 404s are assumed to just be missing tiles and need not be
reported to the user.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ImageryLayerCatalogItem____.html#treat404AsError">ImageryLayerCatalogItem#treat404AsError</a>
</li></ul></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>false</li>
</ul></dd>
<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#line65">line 65</a>
</li></ul></dd>
</dl>
<h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :String</span></h4>
<div class="description">
<p>Gets the type of data item represented by this instance.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogMember.html#type">CatalogMember#type</a>
</li></ul></dd>
<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#line239">line 239</a>
</li></ul></dd>
</dl>
<h4 class="name" id="typeName"><span class="type-signature"></span>typeName<span class="type-signature"> :String</span></h4>
<div class="description">
<p>Gets a human-readable name for this type of data source, such as 'Web Map Service (WMS)'.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogMember.html#typeName">CatalogMember#typeName</a>
</li></ul></dd>
<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#line250">line 250</a>
</li></ul></dd>
</dl>
<h4 class="name" id="uniqueId"><span class="type-signature"></span>uniqueId<span class="type-signature"> :String</span></h4>
<div class="description">
<p>The canonical unique id for this CatalogMember. Will be the id property if one is present, otherwise it will fall
back to the uniqueId of this item's parent + this item's name. This means that if no id is set anywhere up the
tree, the uniqueId will be a complete path of this member's location.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogMember.html#uniqueId">CatalogMember#uniqueId</a>
</li></ul></dd>
<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#line343">line 343</a>
</li></ul></dd>
</dl>
<h4 class="name" id="updaters"><span class="type-signature"></span>updaters<span class="type-signature"> :Object</span></h4>
<div class="description">
<p>Gets the set of functions used to update individual properties in <a href="CatalogMember.html#updateFromJson">CatalogMember#updateFromJson</a>.
When a property name in the returned object literal matches the name of a property on this instance, the value
will be called as a function and passed a reference to this instance, a reference to the source JSON object
literal, and the name of the property.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ImageryLayerCatalogItem____.html#updaters">ImageryLayerCatalogItem#updaters</a>
</li></ul></dd>
<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#line266">line 266</a>
</li></ul></dd>
</dl>
<h4 class="name" id="url"><span class="type-signature"></span>url<span class="type-signature"> :String</span></h4>
<div class="description">
<p>Gets or sets the URL of this data. This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">String</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#url">CatalogItem#url</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line70">line 70</a>
</li></ul></dd>
</dl>
<h4 class="name" id="useOwnClock"><span class="type-signature"></span>useOwnClock<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets or sets a flag indicating whether imagery should be displayed using this item's own clock (currentTime, multiplier),
or, if false, the terria clock (whose current time is shown in the timeline UI). Default false.
This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#useOwnClock">CatalogItem#useOwnClock</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line206">line 206</a>
</li></ul></dd>
</dl>
<h4 class="name" id="zoomOnEnable"><span class="type-signature"></span>zoomOnEnable<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets or sets a value indicating whether the map will automatically zoom to this catalog item when it is enabled.</p>
<p>Note that within a single init source:</p>
<ul>
<li>Catalog items with both <code>isEnabled</code> and <code>zoomOnEnable</code> set to true will override the top-level <code>initialCamera</code> property.</li>
<li>If multiple catalog items have both <code>isEnabled</code> and <code>zoomOnEnable</code> set to true, it is undefined which one will affect the camera.</li>
</ul>
<p>In the case of multiple init sources, however, the camera will reflect whatever happens in the <em>last</em> init source, whether
it is a result of a <code>zoomOnEnable</code> or an <code>initialCamera</code>,</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#zoomOnEnable">CatalogItem#zoomOnEnable</a>
</li></ul></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>false</li>
</ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line190">line 190</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="_createImageryProvider"><span class="type-signature">(abstract, protected) </span>_createImageryProvider<span class="signature">(time<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {ImageryProvider}</span></h4>
<div class="description">
<p>When implemented in a derived class, creates the ImageryProvider for this catalog item.</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>time</code></td>
<td class="type">
<span class="param-type">ImageryLayerTime</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>The time for which to create an imagery provider. In layers that are not time-dynamic,
this parameter is ignored.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="ImageryLayerCatalogItem.html#_createImageryProvider">ImageryLayerCatalogItem#_createImageryProvider</a>
</li></ul></dd>
<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#line403">line 403</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The created imagery provider.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">ImageryProvider</span>
</dd>
</dl>
<h4 class="name" id="_disable"><span class="type-signature">(protected) </span>_disable<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Disables this data item on the globe or map. This method:</p>
<ul>
<li>Should not be called directly. Instead, set the <a href="CatalogItem.html#isEnabled">CatalogItem#isEnabled</a> property to false.</li>
<li>Will not be called if <a href="CatalogItem.html#_enable">CatalogItem#_enable</a> was not called (for example, because the previous call was deferred
while the data item loaded, and the user disabled the data item before the load completed).</li>
<li>Will only be called after <a href="CatalogItem.html#_hide">CatalogItem#_hide</a> when a shown data item is disabled.</li>
<li>Calls <a href="CatalogItem.html#_disableInCesium">CatalogItem#_disableInCesium</a> or <a href="CatalogItem.html#_disableInLeaflet">CatalogItem#_disableInLeaflet</a> in the base-class implementation,
depending on which viewer is active. Derived classes that have identical disable logic for both viewers may override
this method instead of the viewer-specific ones.</li>
</ul>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#_disable">CatalogItem#_disable</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line998">line 998</a>
</li></ul></dd>
</dl>
<h4 class="name" id="_disableInCesium"><span class="type-signature">(abstract, protected) </span>_disableInCesium<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>When implemented in a derived class, disables this data item on the Cesium globe. You should not call this
directly, but instead set the <a href="CatalogItem.html#isEnabled">CatalogItem#isEnabled</a> property to false. See
<a href="CatalogItem.html#_disable">CatalogItem#_disable</a> for more information.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#_disableInCesium">CatalogItem#_disableInCesium</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line1088">line 1088</a>
</li></ul></dd>
</dl>
<h4 class="name" id="_disableInLeaflet"><span class="type-signature">(abstract, protected) </span>_disableInLeaflet<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>When implemented in a derived class, disables this data item on the Leaflet map. You should not call this
directly, but instead set the <a href="CatalogItem.html#isEnabled">CatalogItem#isEnabled</a> property to false. See
<a href="CatalogItem.html#_disable">CatalogItem#_disable</a> for more information.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#_disableInLeaflet">CatalogItem#_disableInLeaflet</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line1132">line 1132</a>
</li></ul></dd>
</dl>
<h4 class="name" id="_enable"><span class="type-signature">(protected) </span>_enable<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Enables this data item on the globe or map. This method:</p>
<ul>
<li>Should not be called directly. Instead, set the <a href="CatalogItem.html#isEnabled">CatalogItem#isEnabled</a> property to true.</li>
<li>Will not necessarily be called immediately when <a href="CatalogItem.html#isEnabled">CatalogItem#isEnabled</a> is set to true; it will be deferred until
<a href="CatalogItem.html#isLoading">CatalogItem#isLoading</a> is false.</li>
<li>Should NOT also show the data item on the globe/map (see <a href="CatalogItem.html#_show">CatalogItem#_show</a>), so in some cases it may not do
anything at all.</li>
<li>Calls <a href="CatalogItem.html#_enableInCesium">CatalogItem#_enableInCesium</a> or <a href="CatalogItem.html#_enableInLeaflet">CatalogItem#_enableInLeaflet</a> in the base-class implementation,
depending on which viewer is active. Derived classes that have identical enable logic for both viewers may override
this method instead of the viewer-specific ones.</li>
</ul>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#_enable">CatalogItem#_enable</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line969">line 969</a>
</li></ul></dd>
</dl>
<h4 class="name" id="_enableInCesium"><span class="type-signature">(abstract, protected) </span>_enableInCesium<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>When implemented in a derived class, enables this data item on the Cesium globe. You should not call this
directly, but instead set the <a href="CatalogItem.html#isEnabled">CatalogItem#isEnabled</a> property to true. See
<a href="CatalogItem.html#_enable">CatalogItem#_enable</a> for more information.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#_enableInCesium">CatalogItem#_enableInCesium</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line1077">line 1077</a>
</li></ul></dd>
</dl>
<h4 class="name" id="_enableInLeaflet"><span class="type-signature">(abstract, protected) </span>_enableInLeaflet<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>When implemented in a derived class, enables this data item on the Leaflet map. You should not call this
directly, but instead set the <a href="CatalogItem.html#isEnabled">CatalogItem#isEnabled</a> property to true. See
<a href="CatalogItem.html#_enable">CatalogItem#_enable</a> for more information.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#_enableInLeaflet">CatalogItem#_enableInLeaflet</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line1121">line 1121</a>
</li></ul></dd>
</dl>
<h4 class="name" id="_getValuesThatInfluenceLoad"><span class="type-signature">(protected) </span>_getValuesThatInfluenceLoad<span class="signature">()</span><span class="type-signature"> → {Array}</span></h4>
<div class="description">
<p>When implemented in a derived class, gets an array containing the current value of all properties that
influence this item's load process. See <a href="CatalogItem.html#load">CatalogItem#load</a> for more information on when and
how this is used. The base class implementation returns an empty array.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#_getValuesThatInfluenceLoad">CatalogItem#_getValuesThatInfluenceLoad</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line807">line 807</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The array of values that influence the load process.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array</span>
</dd>
</dl>
<h4 class="name" id="_hide"><span class="type-signature">(protected) </span>_hide<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Hides this data item on the globe or map. This method:</p>
<ul>
<li>Should not be called directly. Instead, set the <a href="CatalogItem.html#isShown">CatalogItem#isShown</a> property to false.</li>
<li>Will not be called if <a href="CatalogItem.html#_show">CatalogItem#_show</a> was not called (for example, because the previous call was deferred
while the data item loaded, and the user hid the data item before the load completed).</li>
<li>Calls <a href="CatalogItem.html#_hideInCesium">CatalogItem#_hideInCesium</a> or <a href="CatalogItem.html#_hideInLeaflet">CatalogItem#_hideInLeaflet</a> in the base-class implementation,
depending on which viewer is active. Derived classes that have identical hide logic for both viewers may override
this method instead of the viewer-specific ones.</li>
</ul>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#_hide">CatalogItem#_hide</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line1053">line 1053</a>
</li></ul></dd>
</dl>
<h4 class="name" id="_hideInCesium"><span class="type-signature">(abstract, protected) </span>_hideInCesium<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>When implemented in a derived class, hides this data item on the Cesium globe. You should not call this
directly, but instead set the <a href="CatalogItem.html#isShown">CatalogItem#isShown</a> property to false. See
<a href="CatalogItem.html#_hide">CatalogItem#_hide</a> for more information.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#_hideInCesium">CatalogItem#_hideInCesium</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line1110">line 1110</a>
</li></ul></dd>
</dl>
<h4 class="name" id="_hideInLeaflet"><span class="type-signature">(abstract, protected) </span>_hideInLeaflet<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>When implemented in a derived class, hides this data item on the Leaflet map. You should not call this
directly, but instead set the <a href="CatalogItem.html#isShown">CatalogItem#isShown</a> property to false. See
<a href="CatalogItem.html#_hide">CatalogItem#_hide</a> for more information.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#_hideInLeaflet">CatalogItem#_hideInLeaflet</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line1154">line 1154</a>
</li></ul></dd>
</dl>
<h4 class="name" id="_load"><span class="type-signature">(protected) </span>_load<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4>
<div class="description">
<p>When implemented in a derived class, this method loads the item. The base class implementation does nothing.
This method should not be called directly; call <a href="CatalogItem.html#load">CatalogItem#load</a> instead.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#_load">CatalogItem#_load</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line794">line 794</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A promise that resolves when the load is complete.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="_show"><span class="type-signature">(protected) </span>_show<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Shows this data item on the globe or map. This method:</p>
<ul>
<li>Should not be called directly. Instead, set the <a href="CatalogItem.html#isShown">CatalogItem#isShown</a> property to true.</li>
<li>Will only be called after <a href="CatalogItem.html#_enable">CatalogItem#_enable</a>; you can count on that method having been called first.</li>
<li>Will not necessarily be called immediately when <a href="CatalogItem.html#isShown">CatalogItem#isShown</a> is set to true; it will be deferred until
<a href="CatalogItem.html#isLoading">CatalogItem#isLoading</a> is false.</li>
<li>Calls <a href="CatalogItem.html#_showInCesium">CatalogItem#_showInCesium</a> or <a href="CatalogItem.html#_showInLeaflet">CatalogItem#_showInLeaflet</a> in the base-class implementation,
depending on which viewer is active. Derived classes that have identical show logic for both viewers
may override this method instead of the viewer-specific ones.</li>
</ul>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#_show">CatalogItem#_show</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line1026">line 1026</a>
</li></ul></dd>
</dl>
<h4 class="name" id="_showInCesium"><span class="type-signature">(abstract, protected) </span>_showInCesium<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>When implemented in a derived class, shows this data item on the Cesium globe. You should not call this
directly, but instead set the <a href="CatalogItem.html#isShown">CatalogItem#isShown</a> property to true. See
<a href="CatalogItem.html#_show">CatalogItem#_show</a> for more information.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#_showInCesium">CatalogItem#_showInCesium</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line1099">line 1099</a>
</li></ul></dd>
</dl>
<h4 class="name" id="_showInLeaflet"><span class="type-signature">(abstract, protected) </span>_showInLeaflet<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>When implemented in a derived class, shows this data item on the Leaflet map. You should not call this
directly, but instead set the <a href="CatalogItem.html#isShown">CatalogItem#isShown</a> property to true. See
<a href="CatalogItem.html#_show">CatalogItem#_show</a> for more information.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#_showInLeaflet">CatalogItem#_showInLeaflet</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line1143">line 1143</a>
</li></ul></dd>
</dl>
<h4 class="name" id="connectsWithRoot"><span class="type-signature"></span>connectsWithRoot<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Goes up the hierarchy and determines if this CatalogMember is connected with the root in terria.catalog, or whether it's
part of a disconnected sub-tree.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogMember.html#connectsWithRoot">CatalogMember#connectsWithRoot</a>
</li></ul></dd>
<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#line541">line 541</a>
</li></ul></dd>
</dl>
<h4 class="name" id="createImageryProvider"><span class="type-signature"></span>createImageryProvider<span class="signature">(time<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {ImageryProvider}</span></h4>
<div class="description">
<p>Creates the ImageryProvider for this catalog item.</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>time</code></td>
<td class="type">
<span class="param-type">ImageryLayerTime</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>The time for which to create an imagery provider. In layers that are not time-dynamic,
this parameter is ignored.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ImageryLayerCatalogItem.html#createImageryProvider">ImageryLayerCatalogItem#createImageryProvider</a>
</li></ul></dd>
<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#line390">line 390</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The created imagery provider.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">ImageryProvider</span>
</dd>
</dl>
<h4 class="name" id="enableWithParents"><span class="type-signature"></span>enableWithParents<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>"Enables" this catalog member in a way that makes sense for its implementation (e.g. isEnabled for items, isOpen for
groups, and all its parents and ancestors in the tree.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogMember.html#enableWithParents">CatalogMember#enableWithParents</a>
</li></ul></dd>
<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#line553">line 553</a>
</li></ul></dd>
</dl>
<h4 class="name" id="findInfoSection"><span class="type-signature"></span>findInfoSection<span class="signature">(sectionName)</span><span class="type-signature"> → {Object}</span></h4>
<div class="description">
<p>Finds an <a href="CatalogMember.html#info">CatalogMember#info</a> section by name.</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>sectionName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The name of the section to find.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogMember.html#findInfoSection">CatalogMember#findInfoSection</a>
</li></ul></dd>
<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#line528">line 528</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The section, or undefined if no section with that name exists.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
<h4 class="name" id="handleTileError"><span class="type-signature"></span>handleTileError<span class="signature">(detailsRequestPromise, imageryProvider, x, y, level)</span><span class="type-signature"> → {Promise}</span></h4>
<div class="description">
<p>Handles an error in loading a tile. If this function returns a promise that resolves successfully,
the tile request will be retried. If the returned promise rejects, it must reject with an instance
of <code>RequestErrorEvent</code> with the details of the failure, and the default handling of tile
failures will be used. The default handling takes into account the <code>treat404AsError</code>, <code>treat403AsError</code>,
and <code>ignoreUnknownTileErrors</code> properties. The default implementation simply returns <code>detailsRequestPromise</code>.</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>detailsRequestPromise</code></td>
<td class="type">
<span class="param-type">Promise</span>
</td>
<td class="description last"><p>A promise which is the result of a simple call to <code>loadWithXhr</code> for the URL
that failed. If it resolves, it will resolve to the successfully-download content of the tile URL,
as text. If it rejects, it will reject with a <code>RequestErrorEvent</code>.</p></td>
</tr>
<tr>
<td class="name"><code>imageryProvider</code></td>
<td class="type">
<span class="param-type">ImageryProvider</span>
</td>
<td class="description last"><p>The imagery provider that generated the failed request.</p></td>
</tr>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The x coordinate of the failed tile.</p></td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The y coordinate of the failed tile.</p></td>
</tr>
<tr>
<td class="name"><code>level</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The level of the failed tile.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#handleTileError">CatalogItem#handleTileError</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line1182">line 1182</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A promise, as described above.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="isNextTimeAvaliable"><span class="type-signature"></span>isNextTimeAvaliable<span class="signature">()</span><span class="type-signature"> → {Boolean}</span></h4>
<div class="description">
<p>Whether it is possible to move to a time interval after the current time.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#isNextTimeAvaliable">CatalogItem#isNextTimeAvaliable</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line933">line 933</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>True if it is possible.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id="isPreviousTimeAvaliable"><span class="type-signature"></span>isPreviousTimeAvaliable<span class="signature">()</span><span class="type-signature"> → {Boolean}</span></h4>
<div class="description">
<p>Whether it is possible to move to a time interval before the current time.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#isPreviousTimeAvaliable">CatalogItem#isPreviousTimeAvaliable</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line941">line 941</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>True if it is possible.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id="load"><span class="type-signature"></span>load<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4>
<div class="description">
<p>Loads this catalog item, if it's not already loaded. It is safe to
call this method multiple times. The <a href="CatalogItem.html#isLoading">CatalogItem#isLoading</a> flag will be set while the load is in progress.
Derived classes should implement <a href="CatalogItem.html#_load">CatalogItem#_load</a> to perform the actual loading for the item.
Derived classes may optionally implement <a href="CatalogItem.html#_getValuesThatInfluenceLoad">CatalogItem#_getValuesThatInfluenceLoad</a> to provide an array containing
the current value of all properties that influence this item's load process. Each time that <a href="CatalogItem.html#load">CatalogItem#load</a>
is invoked, these values are checked against the list of values returned last time, and <a href="CatalogItem.html#_load">CatalogItem#_load</a> is
invoked again if they are different. If <a href="CatalogItem.html#_getValuesThatInfluenceLoad">CatalogItem#_getValuesThatInfluenceLoad</a> is undefined or returns an
empty array, <a href="CatalogItem.html#_load">CatalogItem#_load</a> will only be invoked once, no matter how many times
<a href="CatalogItem.html#load">CatalogItem#load</a> is invoked.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#load">CatalogItem#load</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line762">line 762</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A promise that resolves when the load is complete, or undefined if the item is already loaded.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="loadAndEnable"><span class="type-signature"></span>loadAndEnable<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4>
<div class="description">
<p>Enables this catalog item, and returns a promise that resolves when the load process, if any, completes.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#loadAndEnable">CatalogItem#loadAndEnable</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line783">line 783</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The promise.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="moveToNextTime"><span class="type-signature"></span>moveToNextTime<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Move the current time to the next time interval.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#moveToNextTime">CatalogItem#moveToNextTime</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line918">line 918</a>
</li></ul></dd>
</dl>
<h4 class="name" id="moveToPreviousTime"><span class="type-signature"></span>moveToPreviousTime<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Move the current time to the previous time interval.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#moveToPreviousTime">CatalogItem#moveToPreviousTime</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line925">line 925</a>
</li></ul></dd>
</dl>
<h4 class="name" id="refresh"><span class="type-signature"></span>refresh<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Refreshes this layer on the map. This is useful when, for example, parameters that went into
<a href="ImageryLayerCatalogItem.html#_createImageryProvider">ImageryLayerCatalogItem#_createImageryProvider</a> change.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ImageryLayerCatalogItem____.html#refresh">ImageryLayerCatalogItem#refresh</a>
</li></ul></dd>
<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#line527">line 527</a>
</li></ul></dd>
</dl>
<h4 class="name" id="serializeToJson"><span class="type-signature"></span>serializeToJson<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Object}</span></h4>
<div class="description">
<p>Serializes the data item 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>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
<optional><br>
</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>propertyFilter</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Filter function that will be executed to determine whether a property
should be serialized.</p></td>
</tr>
<tr>
<td class="name"><code>itemFilter</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Filter function that will be executed for each item in a group to determine
whether that item should be serialized.</p></td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogMember.html#serializeToJson">CatalogMember#serializeToJson</a>
</li></ul></dd>
<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#line491">line 491</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The serialized JSON object-literal.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
<h4 class="name" id="toggleEnabled"><span class="type-signature"></span>toggleEnabled<span class="signature">()</span><span class="type-signature"> → {Boolean}</span></h4>
<div class="description">
<p>Toggles the <a href="CatalogItem.html#isEnabled">CatalogItem#isEnabled</a> property of this item. If it is enabled, calling this method
will disable it. If it is disabled, calling this method will enable it.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#toggleEnabled">CatalogItem#toggleEnabled</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line820">line 820</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>true if the item is now enabled, false if it is now disabled.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id="toggleLegendVisible"><span class="type-signature"></span>toggleLegendVisible<span class="signature">()</span><span class="type-signature"> → {Boolean}</span></h4>
<div class="description">
<p>Toggles the <a href="CatalogItem.html#isLegendVisible">CatalogItem#isLegendVisible</a> property of this item. If it is visible, calling this
method will hide it. If it is hidden, calling this method will make it visible.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#toggleLegendVisible">CatalogItem#toggleLegendVisible</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line841">line 841</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>true if the legend is now visible, false if it is now hidden.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id="toggleShown"><span class="type-signature"></span>toggleShown<span class="signature">()</span><span class="type-signature"> → {Boolean}</span></h4>
<div class="description">
<p>Toggles the <a href="CatalogItem.html#isShown">CatalogItem#isShown</a> property of this item. If it is shown, calling this method
will hide it. If it is hidden, calling this method will show it.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#toggleShown">CatalogItem#toggleShown</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line831">line 831</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>true if the item is now shown, false if it is now hidden.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id="updateFromJson"><span class="type-signature"></span>updateFromJson<span class="signature">(json, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
<div class="description">
<p>Updates the catalog member from a JSON object-literal description of it.
Existing collections with the same name as a collection in the JSON description are
updated. If the description contains a collection with a name that does not yet exist,
it is created. Because parts of the update may happen asynchronously, this method
returns at Promise that will resolve when the update is completely done.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>json</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>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>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>onlyUpdateExistingItems</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>true to only update existing items and never create new ones, or false is new items
may be created by this update.</p></td>
</tr>
<tr>
<td class="name"><code>isUserSupplied</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>If specified, sets the <a href="CatalogMember.html#isUserSupplied">CatalogMember#isUserSupplied</a> property of updated catalog members
to the given value. If not specified, the property is left unchanged.</p></td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogMember.html#updateFromJson">CatalogMember#updateFromJson</a>
</li></ul></dd>
<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#line465">line 465</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A promise that resolves when the update is complete.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="useClock"><span class="type-signature"></span>useClock<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4>
<div class="description">
<p>Uses the <a href="CatalogItem.html#clock">CatalogItem#clock</a> settings from this data item. If this data item
has no clock settings, or has the useOwnClock property true, this method does nothing.
Because the clock update may happen asynchronously (for example, if the item's clock parameters are not yet known),
this method returns a Promise that resolves when the clock has been updated.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#useClock">CatalogItem#useClock</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line898">line 898</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A promise that resolves when the clock has been updated.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="zoomTo"><span class="type-signature"></span>zoomTo<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4>
<div class="description">
<p>Moves the camera so that the item's bounding rectangle is visible. If <a href="CatalogItem.html#rectangle">CatalogItem#rectangle</a> is
undefined or covers more than about half the world in the longitude direction, or if the data item is not enabled
or not shown, this method does nothing. Because the zoom may happen asynchronously (for example, if the item's
rectangle is not yet known), this method returns a Promise that resolves when the zoom animation starts.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#zoomTo">CatalogItem#zoomTo</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line855">line 855</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A promise that resolves when the zoom animation starts.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="zoomToAndUseClock"><span class="type-signature"></span>zoomToAndUseClock<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4>
<div class="description">
<p>Moves the camera so that the data item's bounding rectangle is visible, and updates the TerriaJS clock according to this
data item's clock settings. This method simply calls <a href="CatalogItem.html#zoomTo">CatalogItem#zoomTo</a> and
<a href="CatalogItem.html#useClock">CatalogItem#useClock</a>. Because the zoom and clock update may happen asynchronously (for example, if the item's
rectangle is not yet known), this method returns a Promise that resolves when the zoom animation starts and the clock
has been updated.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogItem.html#zoomToAndUseClock">CatalogItem#zoomToAndUseClock</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogItem.js.html">Models/CatalogItem.js</a>, <a href="Models_CatalogItem.js.html#line953">line 953</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A promise that resolves when the clock has been updated and the zoom animation has started.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AbsCode.html">AbsCode</a></li><li><a href="AbsConcept.html">AbsConcept</a></li><li><a href="AbsDataset.html">AbsDataset</a></li><li><a href="AbsIttCatalogGroup.html">AbsIttCatalogGroup</a></li><li><a href="AbsIttCatalogItem.html">AbsIttCatalogItem</a></li><li><a href="AddressGeocoder.html">AddressGeocoder</a></li><li><a href="ArcGisCatalogGroup.html">ArcGisCatalogGroup</a></li><li><a href="ArcGisFeatureServerCatalogGroup.html">ArcGisFeatureServerCatalogGroup</a></li><li><a href="ArcGisFeatureServerCatalogItem.html">ArcGisFeatureServerCatalogItem</a></li><li><a href="ArcGisMapServerCatalogGroup.html">ArcGisMapServerCatalogGroup</a></li><li><a href="ArcGisMapServerCatalogItem.html">ArcGisMapServerCatalogItem</a></li><li><a href="AugmentedVirtuality.html">AugmentedVirtuality</a></li><li><a href="BingMapsCatalogItem.html">BingMapsCatalogItem</a></li><li><a href="BooleanParameter.html">BooleanParameter</a></li><li><a href="BulkAddressGeocoderResult.html">BulkAddressGeocoderResult</a></li><li><a href="CameraView.html">CameraView</a></li><li><a href="Catalog.html">Catalog</a></li><li><a href="CatalogFunction.html">CatalogFunction</a></li><li><a href="CatalogGroup.html">CatalogGroup</a></li><li><a href="CatalogItem.html">CatalogItem</a></li><li><a href="CatalogMember.html">CatalogMember</a></li><li><a href="Cesium.html">Cesium</a></li><li><a href="Cesium3DTilesCatalogItem.html">Cesium3DTilesCatalogItem</a></li><li><a href="CesiumDragPoints.html">CesiumDragPoints</a></li><li><a href="CesiumTerrainCatalogItem.html">CesiumTerrainCatalogItem</a></li><li><a href="CkanCatalogGroup.html">CkanCatalogGroup</a></li><li><a href="CkanCatalogItem.html">CkanCatalogItem</a></li><li><a href="Clock.html">Clock</a></li><li><a href="CompositeCatalogItem.html">CompositeCatalogItem</a></li><li><a href="Concept.html">Concept</a></li><li><a href="CorsProxy.html">CorsProxy</a></li><li><a href="CsvCatalogItem.html">CsvCatalogItem</a></li><li><a href="CswCatalogGroup.html">CswCatalogGroup</a></li><li><a href="CustomComponentType.html">CustomComponentType</a></li><li><a href="CzmlCatalogItem.html">CzmlCatalogItem</a></li><li><a href="DataSourceCatalogItem.html">DataSourceCatalogItem</a></li><li><a href="DateTimeParameter.html">DateTimeParameter</a></li><li><a href="DisplayVariablesConcept.html">DisplayVariablesConcept</a></li><li><a href="EnumerationParameter.html">EnumerationParameter</a></li><li><a href="Feature.html">Feature</a></li><li><a href="FunctionParameter.html">FunctionParameter</a></li><li><a href="GeoJsonCatalogItem.html">GeoJsonCatalogItem</a></li><li><a href="GlobeOrMap.html">GlobeOrMap</a></li><li><a href="GnafAddressGeocoder.html">GnafAddressGeocoder</a></li><li><a href="GnafApi.html">GnafApi</a></li><li><a href="GnafSearchProviderViewModel.html">GnafSearchProviderViewModel</a></li><li><a href="GpxCatalogItem.html">GpxCatalogItem</a></li><li><a href="HelpScreen.html">HelpScreen</a></li><li><a href="HelpSequence.html">HelpSequence</a></li><li><a href="HelpSequences.html">HelpSequences</a></li><li><a href="HelpViewState.html">HelpViewState</a></li><li><a href="ImageryLayerCatalogItem____.html">ImageryLayerCatalogItem</a></li><li><a href="IonImageryCatalogItem.html">IonImageryCatalogItem</a></li><li><a href="KmlCatalogItem.html">KmlCatalogItem</a></li><li><a href="Leaflet.html">Leaflet</a></li><li><a href="LeafletDataSourceDisplay.html">LeafletDataSourceDisplay</a></li><li><a href="LeafletDragPoints.html">LeafletDragPoints</a></li><li><a href="LeafletGeomVisualizer.html">LeafletGeomVisualizer</a></li><li><a href="LegendHelper.html">LegendHelper</a></li><li><a href="LegendUrl.html">LegendUrl</a></li><li><a href="LineParameter.html">LineParameter</a></li><li><a href="MagdaCatalogItem.html">MagdaCatalogItem</a></li><li><a href="MapboxMapCatalogItem.html">MapboxMapCatalogItem</a></li><li><a href="MapInteractionMode.html">MapInteractionMode</a></li><li><a href="Metadata.html">Metadata</a></li><li><a href="MetadataItem.html">MetadataItem</a></li><li><a href="module.html#.exports">exports</a></li><li><a href="OgrCatalogItem.html">OgrCatalogItem</a></li><li><a href="OpenStreetMapCatalogItem.html">OpenStreetMapCatalogItem</a></li><li><a href="PlacesLikeMeCatalogfunction.html">PlacesLikeMeCatalogfunction</a></li><li><a href="PointParameter.html">PointParameter</a></li><li><a href="Polling.html">Polling</a></li><li><a href="PolygonParameter.html">PolygonParameter</a></li><li><a href="RectangleParameter.html">RectangleParameter</a></li><li><a href="RegionDataParameter.html">RegionDataParameter</a></li><li><a href="RegionMapping.html">RegionMapping</a></li><li><a href="RegionParameter.html">RegionParameter</a></li><li><a href="RegionProvider.html">RegionProvider</a></li><li><a href="RegionProviderList.html">RegionProviderList</a></li><li><a href="RegionTypeParameter.html">RegionTypeParameter</a></li><li><a href="ResultPendingCatalogItem.html">ResultPendingCatalogItem</a></li><li><a href="SdmxJsonCatalogItem.html">SdmxJsonCatalogItem</a></li><li><a href="SensorObservationServiceCatalogItem.html">SensorObservationServiceCatalogItem</a></li><li><a href="SocrataCatalogGroup.html">SocrataCatalogGroup</a></li><li><a href="SpatialDetailingCatalogFunction.html">SpatialDetailingCatalogFunction</a></li><li><a href="StringParameter.html">StringParameter</a></li><li><a href="SummaryConcept.html">SummaryConcept</a></li><li><a href="TableCatalogItem.html">TableCatalogItem</a></li><li><a href="TableColumn.html">TableColumn</a></li><li><a href="TableColumnStyle.html">TableColumnStyle</a></li><li><a href="TableDataSource.html">TableDataSource</a></li><li><a href="TableStructure.html">TableStructure</a></li><li><a href="TableStyle.html">TableStyle</a></li><li><a href="TerrainCatalogItem.html">TerrainCatalogItem</a></li><li><a href="Terria.html">Terria</a></li><li><a href="TerriaError.html">TerriaError</a></li><li><a href="TerriaJsonCatalogFunction.html">TerriaJsonCatalogFunction</a></li><li><a href="TimeSeriesStack.html">TimeSeriesStack</a></li><li><a href="UrlTemplateCatalogItem.html">UrlTemplateCatalogItem</a></li><li><a href="UrthecastCatalogGroup.html">UrthecastCatalogGroup</a></li><li><a href="UrthecastServerCatalogItem.html">UrthecastServerCatalogItem</a></li><li><a href="UserDrawing.html">UserDrawing</a></li><li><a href="VariableConcept.html">VariableConcept</a></li><li><a href="ViewerModes..html">ViewerModes.</a></li><li><a href="WebFeatureServiceCatalogGroup.html">WebFeatureServiceCatalogGroup</a></li><li><a href="WebFeatureServiceCatalogItem.html">WebFeatureServiceCatalogItem</a></li><li><a href="WebMapServiceCatalogGroup.html">WebMapServiceCatalogGroup</a></li><li><a href="WebMapServiceCatalogItem.html">WebMapServiceCatalogItem</a></li><li><a href="WebMapTileServiceCatalogGroup.html">WebMapTileServiceCatalogGroup</a></li><li><a href="WebMapTileServiceCatalogItem.html">WebMapTileServiceCatalogItem</a></li><li><a href="WebProcessingServiceCatalogFunction.html">WebProcessingServiceCatalogFunction</a></li><li><a href="WebProcessingServiceCatalogGroup.html">WebProcessingServiceCatalogGroup</a></li><li><a href="WebProcessingServiceCatalogItem.html">WebProcessingServiceCatalogItem</a></li><li><a href="WfsFeaturesCatalogGroup.html">WfsFeaturesCatalogGroup</a></li><li><a href="WhyAmISpecialCatalogFunction.html">WhyAmISpecialCatalogFunction</a></li></ul><h3>Global</h3><ul><li><a href="global.html#_bumpyTerrainProvider">_bumpyTerrainProvider</a></li><li><a href="global.html#_terrain">_terrain</a></li><li><a href="global.html#activeTimeColumnNameIdOrIndex">activeTimeColumnNameIdOrIndex</a></li><li><a href="global.html#addBoundingBox">addBoundingBox</a></li><li><a href="global.html#addMarker">addMarker</a></li><li><a href="global.html#addUserCatalogMember">addUserCatalogMember</a></li><li><a href="global.html#allFeaturesAvailablePromise">allFeaturesAvailablePromise</a></li><li><a href="global.html#allShareKeys">allShareKeys</a></li><li><a href="global.html#arrayProduct">arrayProduct</a></li><li><a href="global.html#barHeightMax">barHeightMax</a></li><li><a href="global.html#barHeightMin">barHeightMin</a></li><li><a href="global.html#barLeft">barLeft</a></li><li><a href="global.html#barTop">barTop</a></li><li><a href="global.html#buildEmptyAccumulator">buildEmptyAccumulator</a></li><li><a href="global.html#buildRequestData">buildRequestData</a></li><li><a href="global.html#buildShareLink">buildShareLink</a></li><li><a href="global.html#buildShortShareLink">buildShortShareLink</a></li><li><a href="global.html#calculateFinishDatesFromStartDates">calculateFinishDatesFromStartDates</a></li><li><a href="global.html#canShorten">canShorten</a></li><li><a href="global.html#categoryName">categoryName</a></li><li><a href="global.html#ChartData">ChartData</a></li><li><a href="global.html#color">color</a></li><li><a href="global.html#ColorMap">ColorMap</a></li><li><a href="global.html#combineData">combineData</a></li><li><a href="global.html#combineFilters">combineFilters</a></li><li><a href="global.html#combineRepeated">combineRepeated</a></li><li><a href="global.html#combineValueArrays">combineValueArrays</a></li><li><a href="global.html#computeRingWindingOrder">computeRingWindingOrder</a></li><li><a href="global.html#computeScreenSpacePosition">computeScreenSpacePosition</a></li><li><a href="global.html#config">config</a></li><li><a href="global.html#containsAny">containsAny</a></li><li><a href="global.html#convertLuceneHit">convertLuceneHit</a></li><li><a href="global.html#convertToDates">convertToDates</a></li><li><a href="global.html#correctEntityHeight">correctEntityHeight</a></li><li><a href="global.html#createCatalogItemFromFileOrUrl">createCatalogItemFromFileOrUrl</a></li><li><a href="global.html#createCatalogItemFromUrl">createCatalogItemFromUrl</a></li><li><a href="global.html#createCatalogMemberFromType">createCatalogMemberFromType</a></li><li><a href="global.html#createLeafletCredit">createLeafletCredit</a></li><li><a href="global.html#createParameterFromType">createParameterFromType</a></li><li><a href="global.html#createRegexDeserializer">createRegexDeserializer</a></li><li><a href="global.html#createRegexSerializer">createRegexSerializer</a></li><li><a href="global.html#cssClass">cssClass</a></li><li><a href="global.html#CustomComponents">CustomComponents</a></li><li><a href="global.html#deIndexWithDescendants">deIndexWithDescendants</a></li><li><a href="global.html#Description">Description</a></li><li><a href="global.html#direction">direction</a></li><li><a href="global.html#disposeSubscription">disposeSubscription</a></li><li><a href="global.html#EarthGravityModel1996">EarthGravityModel1996</a></li><li><a href="global.html#error">error</a></li><li><a href="global.html#extendLoad">extendLoad</a></li><li><a href="global.html#extent">extent</a></li><li><a href="global.html#featureClicked">featureClicked</a></li><li><a href="global.html#featureDataToGeoJson">featureDataToGeoJson</a></li><li><a href="global.html#featureMousedown">featureMousedown</a></li><li><a href="global.html#features">features</a></li><li><a href="global.html#findKeyForGroupElement">findKeyForGroupElement</a></li><li><a href="global.html#flattenCatalog">flattenCatalog</a></li><li><a href="global.html#formatDate">formatDate</a></li><li><a href="global.html#formatDateTime">formatDateTime</a></li><li><a href="global.html#formatNumberForLocale">formatNumberForLocale</a></li><li><a href="global.html#formatPropertyValue">formatPropertyValue</a></li><li><a href="global.html#formatTime">formatTime</a></li><li><a href="global.html#getAncestors">getAncestors</a></li><li><a href="global.html#getColumnOptions">getColumnOptions</a></li><li><a href="global.html#getColumnWithNameIdOrIndex">getColumnWithNameIdOrIndex</a></li><li><a href="global.html#getDataUriFormat">getDataUriFormat</a></li><li><a href="global.html#getGroupChildren">getGroupChildren</a></li><li><a href="global.html#getShareData">getShareData</a></li><li><a href="global.html#getTemporalFiltersContext">getTemporalFiltersContext</a></li><li><a href="global.html#getUniqueValues">getUniqueValues</a></li><li><a href="global.html#gmlToGeoJson">gmlToGeoJson</a></li><li><a href="global.html#gradientColorMap">gradientColorMap</a></li><li><a href="global.html#hasAddress">hasAddress</a></li><li><a href="global.html#hasChildren">hasChildren</a></li><li><a href="global.html#hasLatitudeAndLongitude">hasLatitudeAndLongitude</a></li><li><a href="global.html#hostInDomains">hostInDomains</a></li><li><a href="global.html#id">id</a></li><li><a href="global.html#infoWithoutSources">infoWithoutSources</a></li><li><a href="global.html#isBrowserCompatible">isBrowserCompatible</a></li><li><a href="global.html#isCommonMobilePlatform">isCommonMobilePlatform</a></li><li><a href="global.html#isLoading">isLoading</a></li><li><a href="global.html#isVisible">isVisible</a></li><li><a href="global.html#itemHeight">itemHeight</a></li><li><a href="global.html#itemHeightMin">itemHeightMin</a></li><li><a href="global.html#items">items</a></li><li><a href="global.html#itemSpacing">itemSpacing</a></li><li><a href="global.html#itemWidth">itemWidth</a></li><li><a href="global.html#Legend">Legend</a></li><li><a href="global.html#legendUrl">legendUrl</a></li><li><a href="global.html#map">map</a></li><li><a href="global.html#markdownToHtml">markdownToHtml</a></li><li><a href="global.html#markerVisible">markerVisible</a></li><li><a href="global.html#name">name</a></li><li><a href="global.html#NowViewing">NowViewing</a></li><li><a href="global.html#overrideProperty">overrideProperty</a></li><li><a href="global.html#pad">pad</a></li><li><a href="global.html#parseCustomHtmlToReact">parseCustomHtmlToReact</a></li><li><a href="global.html#parseCustomMarkdownToReact">parseCustomMarkdownToReact</a></li><li><a href="global.html#PickedFeatures">PickedFeatures</a></li><li><a href="global.html#pickPosition">pickPosition</a></li><li><a href="global.html#point">point</a></li><li><a href="global.html#points">points</a></li><li><a href="global.html#position">position</a></li><li><a href="global.html#prettifyCoordinates">prettifyCoordinates</a></li><li><a href="global.html#prettifyProjection">prettifyProjection</a></li><li><a href="global.html#printWindow">printWindow</a></li><li><a href="global.html#processAddress">processAddress</a></li><li><a href="global.html#Proj4Definitions">Proj4Definitions</a></li><li><a href="global.html#propertyGetTimeValues">propertyGetTimeValues</a></li><li><a href="global.html#readJson">readJson</a></li><li><a href="global.html#rectangle">rectangle</a></li><li><a href="global.html#rectangleToLatLngBounds">rectangleToLatLngBounds</a></li><li><a href="global.html#RegionDataValue">RegionDataValue</a></li><li><a href="global.html#regionDetails">regionDetails</a></li><li><a href="global.html#registerCustomComponentTypes">registerCustomComponentTypes</a></li><li><a href="global.html#rememberRejections">rememberRejections</a></li><li><a href="global.html#removeMarker">removeMarker</a></li><li><a href="global.html#replaceUnderscores">replaceUnderscores</a></li><li><a href="global.html#sanitiseAddressNumber">sanitiseAddressNumber</a></li><li><a href="global.html#selectBaseMap">selectBaseMap</a></li><li><a href="global.html#serializeToJson">serializeToJson</a></li><li><a href="global.html#ServerConfig">ServerConfig</a></li><li><a href="global.html#setClockCurrentTime">setClockCurrentTime</a></li><li><a href="global.html#shareKeyIndex">shareKeyIndex</a></li><li><a href="global.html#shouldBeUpdated">shouldBeUpdated</a></li><li><a href="global.html#showSelection">showSelection</a></li><li><a href="global.html#sortByFirst">sortByFirst</a></li><li><a href="global.html#sortedIndices">sortedIndices</a></li><li><a href="global.html#splitIntoBatches">splitIntoBatches</a></li><li><a href="global.html#supportsIntervals">supportsIntervals</a></li><li><a href="global.html#supportsWebGL">supportsWebGL</a></li><li><a href="global.html#TerriaViewer">TerriaViewer</a></li><li><a href="global.html#Title">Title</a></li><li><a href="global.html#toArrayOfRows">toArrayOfRows</a></li><li><a href="global.html#Tooltip">Tooltip</a></li><li><a href="global.html#triggerResize">triggerResize</a></li><li><a href="global.html#unionRectangleArray">unionRectangleArray</a></li><li><a href="global.html#unionRectangles">unionRectangles</a></li><li><a href="global.html#units">units</a></li><li><a href="global.html#up">up</a></li><li><a href="global.html#updateApplicationOnHashChange">updateApplicationOnHashChange</a></li><li><a href="global.html#updateFromJson">updateFromJson</a></li><li><a href="global.html#updateRectangleFromRegion">updateRectangleFromRegion</a></li><li><a href="global.html#variableNameLeft">variableNameLeft</a></li><li><a href="global.html#variableNameTop">variableNameTop</a></li><li><a href="global.html#ViewerMode">ViewerMode</a></li><li><a href="global.html#width">width</a></li><li><a href="global.html#yAxisMax">yAxisMax</a></li><li><a href="global.html#yAxisMin">yAxisMin</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Sep 21 2018 12:26:24 GMT+1000 (AUS Eastern Standard Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>