terriajs
Version:
Geospatial data visualization platform.
3,683 lines (966 loc) • 113 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: CkanCatalogGroup</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: CkanCatalogGroup</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>CkanCatalogGroup<span class="signature">(terria)</span><span class="type-signature"></span></h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="CkanCatalogGroup"><span class="type-signature"></span>new CkanCatalogGroup<span class="signature">(terria)</span><span class="type-signature"></span></h4>
<div class="description">
<p>A <a href="CatalogGroup.html">CatalogGroup</a> representing a collection of layers from a <a href="http://ckan.org">CKAN</a> 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_CkanCatalogGroup.js.html">Models/CkanCatalogGroup.js</a>, <a href="Models_CkanCatalogGroup.js.html#line34">line 34</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li><a href="CatalogGroup.html">CatalogGroup</a></li>
</ul>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id=".defaultSerializers"><span class="type-signature">(static) </span>defaultSerializers<span class="type-signature"> :Object</span></h4>
<div class="description">
<p>Gets or sets the set of default serializer functions to use in <a href="CatalogMember.html#serializeToJson">CatalogMember#serializeToJson</a>. Types derived from this type
should expose this instance - cloned and modified if necesary - through their <a href="CatalogMember.html#serializers">CatalogMember#serializers</a> property.</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_CkanCatalogGroup.js.html">Models/CkanCatalogGroup.js</a>, <a href="Models_CkanCatalogGroup.js.html#line349">line 349</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".defaultUpdaters"><span class="type-signature">(static) </span>defaultUpdaters<span class="type-signature"> :Object</span></h4>
<div class="description">
<p>Gets or sets the set of default updater functions to use in <a href="CatalogMember.html#updateFromJson">CatalogMember#updateFromJson</a>. Types derived from this type
should expose this instance - cloned and modified if necesary - through their <a href="CatalogMember.html#updaters">CatalogMember#updaters</a> property.</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_CkanCatalogGroup.js.html">Models/CkanCatalogGroup.js</a>, <a href="Models_CkanCatalogGroup.js.html#line331">line 331</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="allowEntireWfsServers"><span class="type-signature"></span>allowEntireWfsServers<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>True to allow entire WFS servers (that is, WFS resources without a clearly-defined layer) to be
added to the catalog; otherwise, false.</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_CkanCatalogGroup.js.html">Models/CkanCatalogGroup.js</a>, <a href="Models_CkanCatalogGroup.js.html#line137">line 137</a>
</li></ul></dd>
</dl>
<h4 class="name" id="allowEntireWmsServers"><span class="type-signature"></span>allowEntireWmsServers<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>True to allow entire WMS servers (that is, WMS resources without a clearly-defined layer) to be
added to the catalog; otherwise, false.</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_CkanCatalogGroup.js.html">Models/CkanCatalogGroup.js</a>, <a href="Models_CkanCatalogGroup.js.html#line129">line 129</a>
</li></ul></dd>
</dl>
<h4 class="name" id="blacklist"><span class="type-signature"></span>blacklist<span class="type-signature"> :Object</span></h4>
<div class="description">
<p>Gets or sets a hash of names of blacklisted groups and data sources. A group or data source that appears in this hash
will not be shown to the user. In this hash, the keys should be the names of the groups and data sources to blacklist,
and the values should be "true". 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_CkanCatalogGroup.js.html">Models/CkanCatalogGroup.js</a>, <a href="Models_CkanCatalogGroup.js.html#line75">line 75</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="csvResourceFormat"><span class="type-signature"></span>csvResourceFormat<span class="type-signature"> :RegExp</span></h4>
<div class="description">
<p>Gets or sets a regular expression that, when it matches a resource's format, indicates that the resource is a CSV resource.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">RegExp</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CkanCatalogGroup.js.html">Models/CkanCatalogGroup.js</a>, <a href="Models_CkanCatalogGroup.js.html#line188">line 188</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="czmlResourceFormat"><span class="type-signature"></span>czmlResourceFormat<span class="type-signature"> :RegExp</span></h4>
<div class="description">
<p>Gets or sets a regular expression that, when it matches a resource's format, indicates that the resource is a CZML resource.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">RegExp</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CkanCatalogGroup.js.html">Models/CkanCatalogGroup.js</a>, <a href="Models_CkanCatalogGroup.js.html#line241">line 241</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 the data sources in this group.
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="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CkanCatalogGroup.js.html">Models/CkanCatalogGroup.js</a>, <a href="Models_CkanCatalogGroup.js.html#line49">line 49</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="esriFeatureServerResourceFormat"><span class="type-signature"></span>esriFeatureServerResourceFormat<span class="type-signature"> :RegExp</span></h4>
<div class="description">
<p>Gets or sets a regular expression that, when it matches a resource's format, indicates that the resource is an Esri
MapServer or FeatureServer resource. A valid FeatureServer resource must also have <code>FeatureServer</code> in its URL.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">RegExp</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CkanCatalogGroup.js.html">Models/CkanCatalogGroup.js</a>, <a href="Models_CkanCatalogGroup.js.html#line215">line 215</a>
</li></ul></dd>
</dl>
<h4 class="name" id="esriMapServerResourceFormat"><span class="type-signature"></span>esriMapServerResourceFormat<span class="type-signature"> :RegExp</span></h4>
<div class="description">
<p>Gets or sets a regular expression that, when it matches a resource's format, indicates that the resource is an Esri MapServer resource.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">RegExp</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CkanCatalogGroup.js.html">Models/CkanCatalogGroup.js</a>, <a href="Models_CkanCatalogGroup.js.html#line208">line 208</a>
</li></ul></dd>
</dl>
<h4 class="name" id="filterByWmsGetCapabilities"><span class="type-signature"></span>filterByWmsGetCapabilities<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets or sets a value indicating whether the CKAN datasets should be filtered by querying GetCapabilities from each
referenced WMS server and excluding datasets not found therein. 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-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CkanCatalogGroup.js.html">Models/CkanCatalogGroup.js</a>, <a href="Models_CkanCatalogGroup.js.html#line82">line 82</a>
</li></ul></dd>
</dl>
<h4 class="name" id="filterQuery"><span class="type-signature"></span>filterQuery<span class="type-signature"> :Array.<String>|Array.<Object></span></h4>
<div class="description">
<p>Gets or sets the filter query to pass to CKAN when querying the available data sources and their groups. Each item in the
array causes an independent request to the CKAN, and the results are concatenated. The
search string is equivalent to what would be in the parameters segment of the url calling the CKAN search api.
See the <a href="http://wiki.apache.org/solr/CommonQueryParameters#fq">Solr documentation</a> for information about filter queries.
Each item can be either a URL-encoded string ("fq=res_format%3awms") or an object ({ fq: 'res_format:wms' }). The latter
format is easier to work with.
To get all the datasets with wms resources: [{ fq: 'res_format%3awms' }]
To get all wms/WMS datasets in the Surface Water group: [{q: 'groups=Surface Water', fq: 'res_format:WMS' }]
To get both wms and esri-mapService datasets: [{q: 'res_format:WMS'}, {q: 'res_format:"Esri REST"' }]
To get all datasets with no filter, you can use ['']
This property is required.
This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<String></span>
|
<span class="param-type">Array.<Object></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CkanCatalogGroup.js.html">Models/CkanCatalogGroup.js</a>, <a href="Models_CkanCatalogGroup.js.html#line67">line 67</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="geoJsonResourceFormat"><span class="type-signature"></span>geoJsonResourceFormat<span class="type-signature"> :RegExp</span></h4>
<div class="description">
<p>Gets or sets a regular expression that, when it matches a resource's format, indicates that the resource is a GeoJSON resource.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">RegExp</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CkanCatalogGroup.js.html">Models/CkanCatalogGroup.js</a>, <a href="Models_CkanCatalogGroup.js.html#line228">line 228</a>
</li></ul></dd>
</dl>
<h4 class="name" id="groupBy"><span class="type-signature"></span>groupBy<span class="type-signature"> :String</span></h4>
<div class="description">
<p>Gets or sets a value indicating how datasets should be grouped. Valid values are:</p>
<ul>
<li><code>none</code> - Datasets are put in a flat list; they are not grouped at all.</li>
<li><code>group</code> - Datasets are grouped according to their CKAN group. Datasets that are not in any groups are put at the top level.</li>
<li><code>organization</code> - Datasets are grouped by their CKAN organization. Datasets that are not associated with an organization are put at the top level.</li>
</ul>
</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_CkanCatalogGroup.js.html">Models/CkanCatalogGroup.js</a>, <a href="Models_CkanCatalogGroup.js.html#line107">line 107</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="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="includeCsv"><span class="type-signature"></span>includeCsv<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>True to allow CSV resources to be added to the catalog; otherwise, false.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Boolean</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CkanCatalogGroup.js.html">Models/CkanCatalogGroup.js</a>, <a href="Models_CkanCatalogGroup.js.html#line182">line 182</a>
</li></ul></dd>
</dl>
<h4 class="name" id="includeCzml"><span class="type-signature"></span>includeCzml<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>True to allow CZML resources to be added to the catalog; otherwise, false.</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_CkanCatalogGroup.js.html">Models/CkanCatalogGroup.js</a>, <a href="Models_CkanCatalogGroup.js.html#line235">line 235</a>
</li></ul></dd>
</dl>
<h4 class="name" id="includeEsriFeatureServer"><span class="type-signature"></span>includeEsriFeatureServer<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>True to allow ESRI FeatureServer resources to be added to the catalog; otherwise, false.</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_CkanCatalogGroup.js.html">Models/CkanCatalogGroup.js</a>, <a href="Models_CkanCatalogGroup.js.html#line202">line 202</a>
</li></ul></dd>
</dl>
<h4 class="name" id="includeEsriMapServer"><span class="type-signature"></span>includeEsriMapServer<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>True to allow ESRI MapServer resources to be added to the catalog; otherwise, false.</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_CkanCatalogGroup.js.html">Models/CkanCatalogGroup.js</a>, <a href="Models_CkanCatalogGroup.js.html#line195">line 195</a>
</li></ul></dd>
</dl>
<h4 class="name" id="includeGeoJson"><span class="type-signature"></span>includeGeoJson<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>True to allow GeoJSON resources to be added to the catalog; otherwise, false.</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_CkanCatalogGroup.js.html">Models/CkanCatalogGroup.js</a>, <a href="Models_CkanCatalogGroup.js.html#line222">line 222</a>
</li></ul></dd>
</dl>
<h4 class="name" id="includeKml"><span class="type-signature"></span>includeKml<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>True to allow KML resources to be added to the catalog; otherwise, false.</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_CkanCatalogGroup.js.html">Models/CkanCatalogGroup.js</a>, <a href="Models_CkanCatalogGroup.js.html#line170">line 170</a>
</li></ul></dd>
</dl>
<h4 class="name" id="includeWfs"><span class="type-signature"></span>includeWfs<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>True to allow WFS resources to be added to the catalog; otherwise, false.</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>true</li>
</ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CkanCatalogGroup.js.html">Models/CkanCatalogGroup.js</a>, <a href="Models_CkanCatalogGroup.js.html#line157">line 157</a>
</li></ul></dd>
</dl>
<h4 class="name" id="includeWms"><span class="type-signature"></span>includeWms<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>True to allow WMS resources to be added to the catalog; otherwise, false.</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>true</li>
</ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CkanCatalogGroup.js.html">Models/CkanCatalogGroup.js</a>, <a href="Models_CkanCatalogGroup.js.html#line144">line 144</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="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="CatalogGroup.html#isGroup">CatalogGroup#isGroup</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogGroup.js.html">Models/CatalogGroup.js</a>, <a href="Models_CatalogGroup.js.html#line154">line 154</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="isOpen"><span class="type-signature"></span>isOpen<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets or sets a value indicating whether the group is currently expanded and showing
its children. 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="CatalogGroup.html#isOpen">CatalogGroup#isOpen</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogGroup.js.html">Models/CatalogGroup.js</a>, <a href="Models_CatalogGroup.js.html#line43">line 43</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="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="itemProperties"><span class="type-signature"></span>itemProperties<span class="type-signature"> :Object</span></h4>
<div class="description">
<p>Gets or sets a hash of properties that will be set on each child item.
For example, { "treat404AsError": false }</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_CkanCatalogGroup.js.html">Models/CkanCatalogGroup.js</a>, <a href="Models_CkanCatalogGroup.js.html#line248">line 248</a>
</li></ul></dd>
</dl>
<h4 class="name" id="items"><span class="type-signature"></span>items<span class="type-signature"> :Array.<<a href="CatalogMember.html">CatalogMember</a>></span></h4>
<div class="description">
<p>Gets the collection of items in this group. This property is observable.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<<a href="CatalogMember.html">CatalogMember</a>></span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="CatalogGroup.html#items">CatalogGroup#items</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CatalogGroup.js.html">Models/CatalogGroup.js</a>, <a href="Models_CatalogGroup.js.html#line49">line 49</a>
</li></ul></dd>
</dl>
<h4 class="name" id="kmlResourceFormat"><span class="type-signature"></span>kmlResourceFormat<span class="type-signature"> :RegExp</span></h4>
<div class="description">
<p>Gets or sets a regular expression that, when it matches a resource's format, indicates that the resource is a KML resource.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">RegExp</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_CkanCatalogGroup.js.html">Models/CkanCatalogGroup.js</a>, <a href="Models_CkanCatalogGroup.js.html#line176">line 176</a>
</li></ul></dd>
</dl>
<h4 class="name" id="minimumMaxScaleDenominator"><span class="type-signature"></span>minimumMaxScaleDenominator<span class="type-signature"> :Number</span></h4>
<div class="description">
<p>Gets or sets the minimum MaxScaleDenominator that is allowed for a WMS dataset to be included in this CKAN group.
If this property is undefined or if <a href="CkanCatalogGroup.html#filterByWmsGetCapabilities">CkanCatalogGroup#filterByWmsGetCapabilities</a> is false, no
filtering based on MaxScaleDenominator is performed. This property is observable.</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_CkanCatalogGroup.js.html">Models/CkanCatalogGroup.js</a>, <a href="Models_CkanCatalogGroup.js.html#line90">line 90</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="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-f