terriajs

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: WebFeatureServiceCatalogGroup</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: WebFeatureServiceCatalogGroup</h1> <section> <header> <h2><span class="attribs"><span class="type-signature"></span></span>WebFeatureServiceCatalogGroup<span class="signature">(terria)</span><span class="type-signature"></span></h2> </header> <article> <div class="container-overview"> <h4 class="name" id="WebFeatureServiceCatalogGroup"><span class="type-signature"></span>new WebFeatureServiceCatalogGroup<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 feature types from a Web Feature Service (WFS) 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_WebFeatureServiceCatalogGroup.js.html">Models/WebFeatureServiceCatalogGroup.js</a>, <a href="Models_WebFeatureServiceCatalogGroup.js.html#line31">line 31</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_WebFeatureServiceCatalogGroup.js.html">Models/WebFeatureServiceCatalogGroup.js</a>, <a href="Models_WebFeatureServiceCatalogGroup.js.html#line104">line 104</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="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 data layers. A layer that appears in this hash will not be shown to the user. In this hash, the keys should be the Title of the layers 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_WebFeatureServiceCatalogGroup.js.html">Models/WebFeatureServiceCatalogGroup.js</a>, <a href="Models_WebFeatureServiceCatalogGroup.js.html#line54">line 54</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="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 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_WebFeatureServiceCatalogGroup.js.html">Models/WebFeatureServiceCatalogGroup.js</a>, <a href="Models_WebFeatureServiceCatalogGroup.js.html#line46">line 46</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="forceProxy"><span class="type-signature"></span>forceProxy<span class="type-signature"> :Boolean</span></h4> <div class="description"> <p>Gets or sets whether or not this member should be forced to use a proxy. This property is not observable.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Boolean</span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="CatalogMember.html#forceProxy">CatalogMember#forceProxy</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_CatalogMember.js.html">Models/CatalogMember.js</a>, <a href="Models_CatalogMember.js.html#line111">line 111</a> </li></ul></dd> </dl> <h4 class="name" id="hasDescription"><span class="type-signature"></span>hasDescription<span class="type-signature"> :Boolean</span></h4> <div class="description"> <p>Tests whether a description is available, either in the 'description' property or as a member of the 'info' array.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Boolean</span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="CatalogMember.html#hasDescription">CatalogMember#hasDescription</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_CatalogMember.js.html">Models/CatalogMember.js</a>, <a href="Models_CatalogMember.js.html#line326">line 326</a> </li></ul></dd> </dl> <h4 class="name" id="hideSource"><span class="type-signature"></span>hideSource<span class="type-signature"> :boolean</span></h4> <div class="description"> <p>Indicates that the source of this data should be hidden from the UI (obviously this isn't super-secure as you can just look at the network requests).</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">boolean</span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="CatalogMember.html#hideSource">CatalogMember#hideSource</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_CatalogMember.js.html">Models/CatalogMember.js</a>, <a href="Models_CatalogMember.js.html#line174">line 174</a> </li></ul></dd> </dl> <h4 class="name" id="id"><span class="type-signature"></span>id<span class="type-signature"> :String</span></h4> <div class="description"> <p>An optional unique id for this member, that is stable across renames and moves. Use uniqueId to get the canonical unique id for this CatalogMember, which is present even if there is no id.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">String</span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="CatalogMember.html#id">CatalogMember#id</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_CatalogMember.js.html">Models/CatalogMember.js</a>, <a href="Models_CatalogMember.js.html#line124">line 124</a> </li></ul></dd> </dl> <h4 class="name" id="info"><span class="type-signature"></span>info<span class="type-signature"> :Array.<Object></span></h4> <div class="description"> <p>Gets or sets the array of section titles and contents for display in the layer info panel. In future this may replace 'description' above - this list should not contain sections named 'description' or 'Description' if the 'description' property is also set as both will be displayed. The object is of the form {name:string, content:string}. Content will be rendered as Markdown with HTML. This property is observable.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Array.<Object></span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="CatalogMember.html#info">CatalogMember#info</a> </li></ul></dd> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"> <li>[]</li> </ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_CatalogMember.js.html">Models/CatalogMember.js</a>, <a href="Models_CatalogMember.js.html#line57">line 57</a> </li></ul></dd> </dl> <h4 class="name" id="infoSectionOrder"><span class="type-signature"></span>infoSectionOrder<span class="type-signature"> :Array.<String></span></h4> <div class="description"> <p>Gets or sets the array of section titles definining the display order of info sections. If this property is not defined, DataPreviewSections's DEFAULT_SECTION_ORDER is used. This property is observable.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Array.<String></span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="CatalogMember.html#infoSectionOrder">CatalogMember#infoSectionOrder</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_CatalogMember.js.html">Models/CatalogMember.js</a>, <a href="Models_CatalogMember.js.html#line64">line 64</a> </li></ul></dd> </dl> <h4 class="name" id="initialMessage"><span class="type-signature"></span>initialMessage<span class="type-signature"> :Object</span></h4> <div class="description"> <p>A message object that is presented to the user when an item or group is initially clicked The object is of the form {title:string, content:string, key: string, confirmation: boolean, confirmText: string, width: number, height: number}. This property is observable.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Object</span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="CatalogMember.html#initialMessage">CatalogMember#initialMessage</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_CatalogMember.js.html">Models/CatalogMember.js</a>, <a href="Models_CatalogMember.js.html#line97">line 97</a> </li></ul></dd> </dl> <h4 class="name" id="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="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="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_WebFeatureServiceCatalogGroup.js.html">Models/WebFeatureServiceCatalogGroup.js</a>, <a href="Models_WebFeatureServiceCatalogGroup.js.html#line92">line 92</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_WebFeatureServiceCatalogGroup.js.html">Models/WebFeatureServiceCatalogGroup.js</a>, <a href="Models_WebFeatureServiceCatalogGroup.js.html#line67">line 67</a> </li></ul></dd> </dl> <h4 class="name" id="typeName"><span class="type-signature"></span>typeName<span class="type-signature"> :String</span></h4> <div class="description"> <p>Gets a human-readable name for this type of data source, such as 'Web Feature Service (WFS)'.</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#typeName">CatalogGroup#typeName</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_WebFeatureServiceCatalogGroup.js.html">Models/WebFeatureServiceCatalogGroup.js</a>, <a href="Models_WebFeatureServiceCatalogGroup.js.html#line78">line 78</a> </li></ul></dd> </dl> <h4 class="name" id="uniqueId"><span class="type-signature"></span>uniqueId<span class="type-signature"> :String</span></h4> <div class="description"> <p>The canonical unique id for this CatalogMember. Will be the id property if one is present, otherwise it will fall back to the uniqueId of this item's parent + this item's name. This means that if no id is set anywhere up the tree, the uniqueId will be a complete path of this member's location.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">String</span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="CatalogMember.html#uniqueId">CatalogMember#uniqueId</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_CatalogMember.js.html">Models/CatalogMember.js</a>, <a href="Models_CatalogMember.js.html#line343">line 343</a> </li></ul></dd> </dl> <h4 class="name" id="updaters"><span class="type-signature"></span>updaters<span class="type-signature"> :Object</span></h4> <div class="description"> <p>Gets the set of functions used to update individual properties in <a href="CatalogMember.html#updateFromJson">CatalogMember#updateFromJson</a>. When a property name in the returned object literal matches the name of a property on this instance, the value will be called as a function and passed a reference to this instance, a reference to the source JSON object literal, and the name of the property.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Object</span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="CatalogGroup.html#updaters">CatalogGroup#updaters</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#line168">line 168</a> </li></ul></dd> </dl> <h4 class="name" id="url"><span class="type-signature"></span>url<span class="type-signature"> :String</span></h4> <div class="description"> <p>Gets or sets the URL of the WFS server. 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_WebFeatureServiceCatalogGroup.js.html">Models/WebFeatureServiceCatalogGroup.js</a>, <a href="Models_WebFeatureServiceCatalogGroup.js.html#line38">line 38</a> </li></ul></dd> </dl> <h3 class="subsection-title">Methods</h3> <h4 class="name" id="_getValuesThatInfluenceLoad"><span class="type-signature">(protected) </span>_getValuesThatInfluenceLoad<span class="signature">()</span><span class="type-signature"> → {Array}</span></h4> <div class="description"> <p>When implemented in a derived class, gets an array containing the current value of all properties that influence this group's load process. See <a href="CatalogGroup.html#load">CatalogGroup#load</a> for more information on when and how this is used. The base class implementation returns an empty array.</p> </div> <dl class="details"> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="CatalogGroup.html#_getValuesThatInfluenceLoad">CatalogGroup#_getValuesThatInfluenceLoad</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#line422">line 422</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The array of values that influence the load process.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Array</span> </dd> </dl> <h4 class="name" id="_load"><span class="type-signature">(protected) </span>_load<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4> <div class="description"> <p>When implemented in a derived class, this method loads the group. The base class implementation does nothing. This method should not be called directly; call <a href="CatalogGroup.html#load">CatalogGroup#load</a> instead.</p> </div> <dl class="details"> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="CatalogGroup.html#_load">CatalogGroup#_load</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#line409">line 409</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>A promise that resolves when the load is complete.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise</span> </dd> </dl> <h4 class="name" id="add"><span class="type-signature"></span>add<span class="signature">(item)</span><span class="type-signature"></span></h4> <div class="description"> <p>Adds an item or group to this group.</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>item</code></td> <td class="type"> <span class="param-type"><a href="CatalogMember.html">CatalogMember</a></span> </td> <td class="description last"><p>The item to add.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="CatalogGroup.html#add">CatalogGroup#add</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#line431">line 431</a> </li></ul></dd> </dl> <h4 class="name" id="connectsWithRoot"><span class="type-signature"></span>connectsWithRoot<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> <p>Goes up the hierarchy and determines if this CatalogMember is connected with the root in terria.catalog, or whether it's part of a disconnected sub-tree.</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="CatalogMember.html#connectsWithRoot">CatalogMember#connectsWithRoot</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_CatalogMember.js.html">Models/CatalogMember.js</a>, <a href="Models_CatalogMember.js.html#line541">line 541</a> </li></ul></dd> </dl> <h4 class="name" id="enableWithParents"><span class="type-signature"></span>enableWithParents<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> <p>"Enables" this catalog member in a way that makes sense for its implementation (e.g. isEnabled for items, isOpen for groups, and all its parents and ancestors in the tree.</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="CatalogMember.html#enableWithParents">CatalogMember#enableWithParents</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_CatalogMember.js.html">Models/CatalogMember.js</a>, <a href="Models_CatalogMember.js.html#line553">line 553</a> </li></ul></dd> </dl> <h4 class="name" id="findFirstItemByName"><span class="type-signature"></span>findFirstItemByName<span class="signature">(name)</span><span class="type-signature"> → {<a href="CatalogMember.html">CatalogMember</a>}</span></h4> <div class="description"> <p>Finds the first item in this group that has the given name. The search is case-sensitive.</p> <p>Instead of using this function, consider using Catalog#shareKeyIndex to look the item up, as this works in constant time and allows lookups to continue working for items that have been renamed or moved as long as they have a stable shareKey set. This function is retained mainly for backwards-compatibility with existing share links that used names for matching.</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>name</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last"><p>The name of the item to find.</p></td> </tr> </tbody> </table> <dl class="details"> <dt