terriajs
Version:
Geospatial data visualization platform.
3,507 lines (967 loc) • 143 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: DataSourceCatalogItem</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: DataSourceCatalogItem</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature">(abstract) </span></span>DataSourceCatalogItem<span class="signature">(terria)</span><span class="type-signature"></span></h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="DataSourceCatalogItem"><span class="type-signature">(abstract) </span>new DataSourceCatalogItem<span class="signature">(terria)</span><span class="type-signature"></span></h4>
<div class="description">
<p>A <a href="CatalogItem.html">CatalogItem</a> that is added to the map as a Cesium DataSource</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_DataSourceCatalogItem.js.html">Models/DataSourceCatalogItem.js</a>, <a href="Models_DataSourceCatalogItem.js.html#line21">line 21</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li><a href="CatalogItem.html">CatalogItem</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="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="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="dataSource"><span class="type-signature"></span>dataSource<span class="type-signature"> :DataSource</span></h4>
<div class="description">
<p>Gets the data source associated with this catalog item.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">DataSource</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_DataSourceCatalogItem.js.html">Models/DataSourceCatalogItem.js</a>, <a href="Models_DataSourceCatalogItem.js.html#line33">line 33</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="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="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="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="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="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><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"></s