terriajs
Version:
Geospatial data visualization platform.
3,250 lines (896 loc) • 204 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: WebMapServiceCatalogItem</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: WebMapServiceCatalogItem</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>WebMapServiceCatalogItem<span class="signature">(terria)</span><span class="type-signature"></span></h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="WebMapServiceCatalogItem"><span class="type-signature"></span>new WebMapServiceCatalogItem<span class="signature">(terria)</span><span class="type-signature"></span></h4>
<div class="description">
<p>A <a href="ImageryLayerCatalogItem____.html">ImageryLayerCatalogItem</a> representing a layer from a Web Map Service (WMS) server.</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_WebMapServiceCatalogItem.js.html">Models/WebMapServiceCatalogItem.js</a>, <a href="Models_WebMapServiceCatalogItem.js.html#line49">line 49</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=".abstractsToIgnore"><span class="type-signature">(static) </span>abstractsToIgnore<span class="type-signature"> :Array</span></h4>
<div class="description">
<p>The collection of strings that indicate an Abstract property should be ignored. If these strings occur anywhere
in the Abstract, the Abstract will not be used. This makes it easy to filter out placeholder data like
Geoserver's "A compliant implementation of WMS..." stock abstract.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_WebMapServiceCatalogItem.js.html">Models/WebMapServiceCatalogItem.js</a>, <a href="Models_WebMapServiceCatalogItem.js.html#line539">line 539</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".defaultPropertiesForSharing"><span class="type-signature">(static) </span>defaultPropertiesForSharing<span class="type-signature"> :Array.<String></span></h4>
<div class="description">
<p>Gets or sets the default set of properties that are serialized when serializing a <a href="CatalogItem.html">CatalogItem</a>-derived 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-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#line525">line 525</a>
</li></ul></dd>
</dl>
<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="availableDimensions"><span class="type-signature"></span>availableDimensions<span class="type-signature"> :Object</span></h4>
<div class="description">
<p>Gets or sets the list of additional dimensions (e.g. elevation) and their possible values available from the
WMS server. If undefined, this property is automatically populated from the WMS GetCapabilities on load.
This property is an object that has a property named for each layer. The value of the property is an array
of dimensions available for this layer. A dimension has the fields shown in the example below. See the
WMS 1.3.0 specification, section C.2, for a description of the fields. All fields are optional except
<code>name</code> and <code>options</code>. This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_WebMapServiceCatalogItem.js.html">Models/WebMapServiceCatalogItem.js</a>, <a href="Models_WebMapServiceCatalogItem.js.html#line244">line 244</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>wmsItem.availableDimensions = {
mylayer: [
{
name: 'elevation',
units: 'CRS:88',
unitSymbol: 'm',
default: -0.03125,
multipleValues: false,
nearestValue: false,
options: [
-0.96875,
-0.90625,
-0.84375,
-0.78125,
-0.71875,
-0.65625,
-0.59375,
-0.53125,
-0.46875,
-0.40625,
-0.34375,
-0.28125,
-0.21875,
-0.15625,
-0.09375,
-0.03125
]
}
]
};</code></pre>
<h4 class="name" id="availableStyles"><span class="type-signature"></span>availableStyles<span class="type-signature"> :Object</span></h4>
<div class="description">
<p>Gets or sets the available styles for each selected layer in <a href="WebMapServiceCatalogItem.html#layers">WebMapServiceCatalogItem#layers</a>. If undefined,
this property is automatically populated from the WMS GetCapabilities on load. This property is an object that has a
property named for each layer. The value of the property is an array where each element in the array is a style supported
by the layer. The style has <code>name</code>, <code>title</code>, <code>abstract</code>, and <code>legendUrl</code> 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="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#line186">line 186</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>wmsItem.availableStyles = {
'FVCOM-NECOFS-GOM3/x': [
{
name: 'default-scalar/default',
title: 'default-scalar/default',
abstract: 'default-scalar style, using the default palette.',
legendUrl: new LegendUrl('http://www.smast.umassd.edu:8080/ncWMS2/wms?REQUEST=GetLegendGraphic&PALETTE=default&COLORBARONLY=true&WIDTH=110&HEIGHT=264', 'image/png')
}
]
};</code></pre>
<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="colorScaleMaximum"><span class="type-signature"></span>colorScaleMaximum<span class="type-signature"> :Number</span></h4>
<div class="description">
<p>Gets or sets the maximum of the color scale range. Because COLORSCALERANGE is a non-standard
property supported by ncWMS servers, this property is ignored unless <a href="WebMapServiceCatalogItem.html#supportsColorScaleRange">WebMapServiceCatalogItem#supportsColorScaleRange</a>
is true. <a href="WebMapServiceCatalogItem.html#colorScaleMinimum">WebMapServiceCatalogItem#colorScaleMinimum</a> must be set as well.</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_WebMapServiceCatalogItem.js.html">Models/WebMapServiceCatalogItem.js</a>, <a href="Models_WebMapServiceCatalogItem.js.html#line202">line 202</a>
</li></ul></dd>
</dl>
<h4 class="name" id="colorScaleMinimum"><span class="type-signature"></span>colorScaleMinimum<span class="type-signature"> :Number</span></h4>
<div class="description">
<p>Gets or sets the minumum of the color scale range. Because COLORSCALERANGE is a non-standard
property supported by ncWMS servers, this property is ignored unless <a href="WebMapServiceCatalogItem.html#supportsColorScaleRange">WebMapServiceCatalogItem#supportsColorScaleRange</a>
is true. <a href="WebMapServiceCatalogItem.html#colorScaleMaximum">WebMapServiceCatalogItem#colorScaleMaximum</a> must be set as well.</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_WebMapServiceCatalogItem.js.html">Models/WebMapServiceCatalogItem.js</a>, <a href="Models_WebMapServiceCatalogItem.js.html#line194">line 194</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="dimensions"><span class="type-signature"></span>dimensions<span class="type-signature"> :Object</span></h4>
<div class="description">
<p>Gets or sets the selected values for dimensions available for this WMS layer. The value of this property is
an object where each key is the name of a dimension and each value is the value to use for that dimension.
Note that WMS does not allow dimensions to be explicitly specified per layer. So the selected dimension values are
applied to all layers with a corresponding dimension.
This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_WebMapServiceCatalogItem.js.html">Models/WebMapServiceCatalogItem.js</a>, <a href="Models_WebMapServiceCatalogItem.js.html#line258">line 258</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>wmsItem.dimensions = {
elevation: -0.65625
};</code></pre>
<h4 class="name" id="disableUserChanges"><span class="type-signature"></span>disableUserChanges<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets or sets a value indicating whether the user's ability to change the display properties of this
catalog item is disabled. For example, if true, <a href="WebMapServiceCatalogItem.html#styles">WebMapServiceCatalogItem#styles</a> should not be
changeable through the user interface.
This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<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_WebMapServiceCatalogItem.js.html">Models/WebMapServiceCatalogItem.js</a>, <a href="Models_WebMapServiceCatalogItem.js.html#line165">line 165</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="displayDuration"><span class="type-signature"></span>displayDuration<span class="type-signature"> :Number</span></h4>
<div class="description">
<p>Gets or sets how many seconds time-series data with a start date but no end date should last, in seconds.</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_WebMapServiceCatalogItem.js.html">Models/WebMapServiceCatalogItem.js</a>, <a href="Models_WebMapServiceCatalogItem.js.html#line155">line 155</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="getFeatureInfoFormats"><span class="type-signature"></span>getFeatureInfoFormats<span class="type-signature"> :Array.<GetFeatureInfoFormat></span></h4>
<div class="description">
<p>Gets or sets the formats in which to try WMS GetFeatureInfo requests. If this property is undefined, the <code>WebMapServiceImageryProvider</code> defaults
are used. This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<GetFeatureInfoFormat></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_WebMapServiceCatalogItem.js.html">Models/WebMapServiceCatalogItem.js</a>, <a href="Models_WebMapServiceCatalogItem.js.html#line100">line 100</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