terriajs

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: CswCatalogGroup</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>  <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: CswCatalogGroup</h1> <section> <header> <h2><span class="attribs"><span class="type-signature"></span></span>CswCatalogGroup<span class="signature">(terria)</span><span class="type-signature"></span></h2> </header> <article> <div class="container-overview"> <h4 class="name" id="CswCatalogGroup"><span class="type-signature"></span>new CswCatalogGroup<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 datasets queried from an OGC Catalog Service (CSW) 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_CswCatalogGroup.js.html">Models/CswCatalogGroup.js</a>, <a href="Models_CswCatalogGroup.js.html#line38">line 38</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_CswCatalogGroup.js.html">Models/CswCatalogGroup.js</a>, <a href="Models_CswCatalogGroup.js.html#line242">line 242</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_CswCatalogGroup.js.html">Models/CswCatalogGroup.js</a>, <a href="Models_CswCatalogGroup.js.html#line217">line 217</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="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 the protocol attribute of a URI element of a record, 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_CswCatalogGroup.js.html">Models/CswCatalogGroup.js</a>, <a href="Models_CswCatalogGroup.js.html#line92">line 92</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="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="domainSpecification"><span class="type-signature"></span>domainSpecification<span class="type-signature"> :Object</span></h4> <div class="description"> <p>Gets or sets a description of a domain that will be pulled from the CSW service and used to define the metadataGroups. The domain is obtained by querying the CSW server for a particular property - the values of the property form the domain, the values are assumed to define a hierarchy eg. Wave Models | Wave Energy Flux - which is a two level hierarchy of groups that will be used to classify metadata records.</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_CswCatalogGroup.js.html">Models/CswCatalogGroup.js</a>, <a href="Models_CswCatalogGroup.js.html#line130">line 130</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 the protocol attribute of a URI element of a record, 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_CswCatalogGroup.js.html">Models/CswCatalogGroup.js</a>, <a href="Models_CswCatalogGroup.js.html#line105">line 105</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 the protocol attribute of a URI element of a record, 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_CswCatalogGroup.js.html">Models/CswCatalogGroup.js</a>, <a href="Models_CswCatalogGroup.js.html#line118">line 118</a> </li></ul></dd> </dl> <h4 class="name" id="getRecordsTemplate"><span class="type-signature"></span>getRecordsTemplate<span class="type-signature"> :String</span></h4> <div class="description"> <p>Gets or sets the template XML string to POST to the CSW server to query for catalog items. If this property is undefined, CswCatalogGroup.defaultGetRecordsTemplate is used. The XML string should have a <code>{startPosition}</code> placeholder to be replaced with the next start position in order to allow incremental paging of results. 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_CswCatalogGroup.js.html">Models/CswCatalogGroup.js</a>, <a href="Models_CswCatalogGroup.js.html#line54">line 54</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_CswCatalogGroup.js.html">Models/CswCatalogGroup.js</a>, <a href="Models_CswCatalogGroup.js.html#line86">line 86</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 Map 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_CswCatalogGroup.js.html">Models/CswCatalogGroup.js</a>, <a href="Models_CswCatalogGroup.js.html#line99">line 99</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_CswCatalogGroup.js.html">Models/CswCatalogGroup.js</a>, <a href="Models_CswCatalogGroup.js.html#line112">line 112</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_CswCatalogGroup.js.html">Models/CswCatalogGroup.js</a>, <a href="Models_CswCatalogGroup.js.html#line74">line 74</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_CswCatalogGroup.js.html">Models/CswCatalogGroup.js</a>, <a href="Models_CswCatalogGroup.js.html#line61">line 61</a> </li></ul></dd> </dl> <h4 class="name" id="includeWps"><span class="type-signature"></span>includeWps<span class="type-signature"> :Boolean</span></h4> <div class="description"> <p>True to allow OGC:WPS service 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_CswCatalogGroup.js.html">Models/CswCatalogGroup.js</a>, <a href="Models_CswCatalogGroup.js.html#line137">line 137</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 the item created from the CKAN resource. 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_CswCatalogGroup.js.html">Models/CswCatalogGroup.js</a>, <a href="Models_CswCatalogGroup.js.html#line150">line 150</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 the protocol attribute of a URI element of a record, 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_CswCatalogGroup.js.html">Models/CswCatalogGroup.js</a>, <a href="Models_CswCatalogGroup.js.html#line80">line 80</a> </li></ul></dd> </dl> <h4 class="name" id="metadataGroups"><span class="type-signature"></span>metadataGroups<span class="type-signature"> :RegExp</span></h4> <div class="description"> <p>Gets or sets a list of key value pairs that will be used to group resources returned from the catalog. The keys are used to match elements in the metadata and the values are used as names for the groups of resources to be created.</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_CswCatalogGroup.js.html">Models/CswCatalogGroup.js</a>, <a href="Models_CswCatalogGroup.js.html#line124">line 124</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-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="CatalogMember.html#parent">CatalogMember#parent</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_CatalogMember.js.html">Models/CatalogMember.js</a>, <a href="Models_CatalogMember.js.html#line139">line 139</a> </li></ul></dd> </dl> <h4 class="name" id="preserveOrder"><span class="type-signature"></span>preserveOrder<span class="type-signature"></span></h4> <div class="description"> <p>Gets or sets flag to prevent items in group being sorted. Subgroups will still sort unless their own preserveOrder flag is set. The value of this property only has an effect during {@CatalogGroup#load} and {@CatalogItem#updateFromJson}.</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="CatalogGroup.html#preserveOrder">CatalogGroup#preserveOrder</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#line55">line 55</a> </li></ul></dd> </dl> <h4 class="name" id="propertiesForSharing"><span class="type-signature"></span>propertiesForSharing<span class="type-signature"> :Array.<String></span></h4> <div class="description"> <p>Gets the set of names of the properties to be serialized for this object for a share link.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Array.<String></span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="CatalogGroup.html#propertiesForSharing">CatalogGroup#propertiesForSharing</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#line193">line 193</a> </li></ul></dd> </dl> <h4 class="name" id="serializers"><span class="type-signature"></span>serializers<span class="type-signature"> :Object</span></h4> <div class="description"> <p>Gets the set of functions used to serialize individual properties in <a href="CatalogMember.html#serializeToJson">CatalogMember#serializeToJson</a>. When a property name on the model matches the name of a property in the serializers object literal, the value will be called as a function and passed a reference to the model, a reference to the destination JSON object literal, and the name of the property.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Object</span> </li> </ul> <dl class="details"> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="CatalogGroup.html#serializers">CatalogGroup#serializers</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_CswCatalogGroup.js.html">Models/CswCatalogGroup.js</a>, <a href="Models_CswCatalogGroup.js.html#line205">line 205</a> </li></ul></dd> </dl> <h4 class="name" id="shareKeys"><span class="type-signature"></span>shareKeys<span class="type-signature"> :Array.<String></span></h4> <div class="description"> <p>An array of all possible keys that can be used to match to this catalog member when specified in a share link - used for maintaining backwards compatibility when adding or changing <a href="CatalogMember.html#id">CatalogMember#id</a>.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Array.<String></span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="CatalogMember.html#shareKeys">CatalogMember#shareKeys</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_CatalogMember.js.html">Models/CatalogMember.js</a>, <a href="Models_CatalogMember.js.html#line132">line 132</a> </li></ul></dd> </dl> <h4 class="name" id="shortReport"><span class="type-signature"></span>shortReport<span class="type-signature"> :String</span></h4> <div class="description"> <p>A short report to show on the now viewing tab. This property is observable.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">String</span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="CatalogMember.html#shortReport">CatalogMember#shortReport</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_CatalogMember.js.html">Models/CatalogMember.js</a>, <a href="Models_CatalogMember.js.html#line145">line 145</a> </li></ul></dd> </dl> <h4 class="name" id="shortReportSections"><span class="type-signature"></span>shortReportSections<span class="type-signature"> :Array.<ShortReportSection></span></h4> <div class="description"> <p>The list of collapsible sections of the short report. Each element of the array is an object literal with a <code>name</code> and <code>content</code> property.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Array.<ShortReportSection></span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="CatalogMember.html#shortReportSections">CatalogMember#shortReportSections</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_CatalogMember.js.html">Models/CatalogMember.js</a>, <a href="Models_CatalogMember.js.html#line152">line 152</a> </li></ul></dd> </dl> <h4 class="name" id="terria"><span class="type-signature"></span>terria<span class="type-signature"> :<a href="Terria.html">Terria</a></span></h4> <div class="description"> <p>Gets the Terria instance.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="Terria.html">Terria</a></span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="CatalogMember.html#terria">CatalogMember#terria</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_CatalogMember.js.html">Models/CatalogMember.js</a>, <a href="Models_CatalogMember.js.html#line273">line 273</a> </li></ul></dd> </dl> <h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :String</span></h4> <div class="description"> <p>Gets the type of data member represented by this instance.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">String</span> </li> </ul> <dl class="details"> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="CatalogGroup.html#type">CatalogGroup#type</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_CswCatalogGroup.js.html">Models/CswCatalogGroup.js</a>, <a href="Models_CswCatalogGroup.js.html#line166">line 166</a> </li></ul></dd> </dl> <h4 class="name" id="typeName"><span class="type-signature"></span>typeName<span class="type-signature"> :String</span></h4> <div class="description"> <p>Gets a human-readable name for this type of data source, such as 'Catalogue Service (CSW)'.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">String</span>