terriajs

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: GlobeOrMap</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: GlobeOrMap</h1> <section> <header> <h2><span class="attribs"><span class="type-signature"></span></span>GlobeOrMap<span class="signature">(terria, disclaimerClass)</span><span class="type-signature"></span></h2> </header> <article> <div class="container-overview"> <h4 class="name" id="GlobeOrMap"><span class="type-signature"></span>new GlobeOrMap<span class="signature">(terria, disclaimerClass)</span><span class="type-signature"></span></h4> <div class="description"> <p>The base class for map/globe viewers.</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> <tr> <td class="name"><code>disclaimerClass</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last"><p>Class of a disclaimer element that should be shifted upwards to make room for other ui elements.</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_GlobeOrMap.js.html">Models/GlobeOrMap.js</a>, <a href="Models_GlobeOrMap.js.html#line31">line 31</a> </li></ul></dd> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="Cesium.html">Cesium</a></li> <li><a href="Leaflet.html">Leaflet</a></li> </ul> </dd> </dl> </div> <h3 class="subsection-title">Members</h3> <h4 class="name" id="canShowSplitter"><span class="type-signature"></span>canShowSplitter<span class="type-signature"> :Boolean</span></h4> <div class="description"> <p>Gets or sets whether this viewer <em>can</em> show a splitter. Default 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_GlobeOrMap.js.html">Models/GlobeOrMap.js</a>, <a href="Models_GlobeOrMap.js.html#line42">line 42</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 or sets 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="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_GlobeOrMap.js.html">Models/GlobeOrMap.js</a>, <a href="Models_GlobeOrMap.js.html#line36">line 36</a> </li></ul></dd> </dl> <h3 class="subsection-title">Methods</h3> <h4 class="name" id="_createFeatureFromImageryLayerFeature"><span class="type-signature">(protected) </span>_createFeatureFromImageryLayerFeature<span class="signature">(imageryFeature)</span><span class="type-signature"> → {<a href="Feature.html">Feature</a>}</span></h4> <div class="description"> <p>Creates a {@see Feature} (based on an {@see Entity}) from a {@see ImageryLayerFeatureInfo}.</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>imageryFeature</code></td> <td class="type"> <span class="param-type"><a href="ImageryLayerFeatureInfo.html">ImageryLayerFeatureInfo</a></span> </td> <td class="description last"><p>The imagery layer feature for which to create an entity-based feature.</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_GlobeOrMap.js.html">Models/GlobeOrMap.js</a>, <a href="Models_GlobeOrMap.js.html#line57">line 57</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The created feature.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="Feature.html">Feature</a></span> </dd> </dl> <h4 class="name" id="addAttribution"><span class="type-signature"></span>addAttribution<span class="signature">(attribution)</span><span class="type-signature"></span></h4> <div class="description"> <p>Adds an attribution to the globe or map.</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>attribution</code></td> <td class="type"> <span class="param-type">Credit</span> </td> <td class="description last"><p>The attribution to add.</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_GlobeOrMap.js.html">Models/GlobeOrMap.js</a>, <a href="Models_GlobeOrMap.js.html#line158">line 158</a> </li></ul></dd> </dl> <h4 class="name" id="addAttribution"><span class="type-signature"></span>addAttribution<span class="signature">(attribution)</span><span class="type-signature"></span></h4> <div class="description"> <p>Adds an attribution to the globe or map.</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>attribution</code></td> <td class="type"> <span class="param-type">Credit</span> </td> <td class="description last"><p>The attribution to add.</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_NoViewer.js.html">Models/NoViewer.js</a>, <a href="Models_NoViewer.js.html#line85">line 85</a> </li></ul></dd> </dl> <h4 class="name" id="captureScreenshot"><span class="type-signature"></span>captureScreenshot<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4> <div class="description"> <p>Captures a screenshot of the map.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_NoViewer.js.html">Models/NoViewer.js</a>, <a href="Models_NoViewer.js.html#line61">line 61</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>A promise that resolves to a data URL when the screenshot is ready.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise</span> </dd> </dl> <h4 class="name" id="captureScreenshot"><span class="type-signature"></span>captureScreenshot<span class="signature">()</span><span class="type-signature"> → {Promise.<string>}</span></h4> <div class="description"> <p>Captures a screenshot of the map.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_GlobeOrMap.js.html">Models/GlobeOrMap.js</a>, <a href="Models_GlobeOrMap.js.html#line133">line 133</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>A promise that resolves to a data URL when the screenshot is ready.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<string></span> </dd> </dl> <h4 class="name" id="computePositionOnScreen"><span class="type-signature"></span>computePositionOnScreen<span class="signature">(position, result<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Cartesian2}</span></h4> <div class="description"> <p>Computes the screen position of a given world position.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>position</code></td> <td class="type"> <span class="param-type">Cartesian3</span> </td> <td class="attributes"> </td> <td class="description last"><p>The world position in Earth-centered Fixed coordinates.</p></td> </tr> <tr> <td class="name"><code>result</code></td> <td class="type"> <span class="param-type">Cartesian2</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The instance to which to copy the result.</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_NoViewer.js.html">Models/NoViewer.js</a>, <a href="Models_NoViewer.js.html#line77">line 77</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The screen position, or undefined if the position is not on the screen.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Cartesian2</span> </dd> </dl> <h4 class="name" id="computePositionOnScreen"><span class="type-signature"></span>computePositionOnScreen<span class="signature">(position, result<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Cartesian2}</span></h4> <div class="description"> <p>Computes the screen position of a given world position.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>position</code></td> <td class="type"> <span class="param-type">Cartesian3</span> </td> <td class="attributes"> </td> <td class="description last"><p>The world position in Earth-centered Fixed coordinates.</p></td> </tr> <tr> <td class="name"><code>result</code></td> <td class="type"> <span class="param-type">Cartesian2</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The instance to which to copy the result.</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_GlobeOrMap.js.html">Models/GlobeOrMap.js</a>, <a href="Models_GlobeOrMap.js.html#line150">line 150</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The screen position, or undefined if the position is not on the screen.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Cartesian2</span> </dd> </dl> <h4 class="name" id="getAllAttribution"><span class="type-signature"></span>getAllAttribution<span class="signature">()</span><span class="type-signature"> → {Array.<String>}</span></h4> <div class="description"> <p>Gets all attribution currently active on the globe or map.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_GlobeOrMap.js.html">Models/GlobeOrMap.js</a>, <a href="Models_GlobeOrMap.js.html#line174">line 174</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The list of current attributions, as HTML strings.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Array.<String></span> </dd> </dl> <h4 class="name" id="getContainer"><span class="type-signature"></span>getContainer<span class="signature">()</span><span class="type-signature"> → {Element}</span></h4> <div class="description"> <p>Gets the current container element.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_GlobeOrMap.js.html">Models/GlobeOrMap.js</a>, <a href="Models_GlobeOrMap.js.html#line114">line 114</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The current container element.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Element</span> </dd> </dl> <h4 class="name" id="getContainer"><span class="type-signature"></span>getContainer<span class="signature">()</span><span class="type-signature"> → {Element}</span></h4> <div class="description"> <p>Gets the current container element.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_NoViewer.js.html">Models/NoViewer.js</a>, <a href="Models_NoViewer.js.html#line43">line 43</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The current container element.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Element</span> </dd> </dl> <h4 class="name" id="getCurrentExtent"><span class="type-signature"></span>getCurrentExtent<span class="signature">()</span><span class="type-signature"> → {Rectangle}</span></h4> <div class="description"> <p>Gets the current extent of the camera. This may be approximate if the viewer does not have a strictly rectangular view.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_NoViewer.js.html">Models/NoViewer.js</a>, <a href="Models_NoViewer.js.html#line35">line 35</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The current visible extent.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Rectangle</span> </dd> </dl> <h4 class="name" id="getCurrentExtent"><span class="type-signature"></span>getCurrentExtent<span class="signature">()</span><span class="type-signature"> → {Rectangle}</span></h4> <div class="description"> <p>Gets the current extent of the camera. This may be approximate if the viewer does not have a strictly rectangular view.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_GlobeOrMap.js.html">Models/GlobeOrMap.js</a>, <a href="Models_GlobeOrMap.js.html#line106">line 106</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The current visible extent.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Rectangle</span> </dd> </dl> <h4 class="name" id="lower"><span class="type-signature"></span>lower<span class="signature">(index)</span><span class="type-signature"></span></h4> <div class="description"> <p>Lower an item's level in the viewer This does not check that index is valid</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>index</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>The index of the item to lower</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_GlobeOrMap.js.html">Models/GlobeOrMap.js</a>, <a href="Models_GlobeOrMap.js.html#line202">line 202</a> </li></ul></dd> </dl> <h4 class="name" id="lower"><span class="type-signature"></span>lower<span class="signature">(index)</span><span class="type-signature"></span></h4> <div class="description"> <p>Lower an item's level in the viewer This does not check that index is valid</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>index</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>The index of the item to lower</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_NoViewer.js.html">Models/NoViewer.js</a>, <a href="Models_NoViewer.js.html#line117">line 117</a> </li></ul></dd> </dl> <h4 class="name" id="lowerToBottom"><span class="type-signature"></span>lowerToBottom<span class="signature">(item)</span><span class="type-signature"></span></h4> <div class="description"> <p>Lowers this imagery layer to the bottom, underneath all other layers. If this item is not enabled or not shown, this method does nothing.</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="CatalogItem.html">CatalogItem</a></span> </td> <td class="description last"><p>The item to lower to the bottom (usually a basemap)</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_GlobeOrMap.js.html">Models/GlobeOrMap.js</a>, <a href="Models_GlobeOrMap.js.html#line211">line 211</a> </li></ul></dd> </dl> <h4 class="name" id="lowerToBottom"><span class="type-signature"></span>lowerToBottom<span class="signature">(item)</span><span class="type-signature"></span></h4> <div class="description"> <p>Lowers this imagery layer to the bottom, underneath all other layers. If this item is not enabled or not shown, this method does nothing.</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="CatalogItem.html">CatalogItem</a></span> </td> <td class="description last"><p>The item to lower to the bottom (usually a basemap)</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_NoViewer.js.html">Models/NoViewer.js</a>, <a href="Models_NoViewer.js.html#line125">line 125</a> </li></ul></dd> </dl> <h4 class="name" id="notifyRepaintRequired"><span class="type-signature"></span>notifyRepaintRequired<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> <p>Notifies the viewer that a repaint is required.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_NoViewer.js.html">Models/NoViewer.js</a>, <a href="Models_NoViewer.js.html#line68">line 68</a> </li></ul></dd> </dl> <h4 class="name" id="notifyRepaintRequired"><span class="type-signature"></span>notifyRepaintRequired<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> <p>Notifies the viewer that a repaint is required.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_GlobeOrMap.js.html">Models/GlobeOrMap.js</a>, <a href="Models_GlobeOrMap.js.html#line140">line 140</a> </li></ul></dd> </dl> <h4 class="name" id="pickFromLocation"><span class="type-signature"></span>pickFromLocation<span class="signature">(latlng, imageryLayerCoords, existingFeatures)</span><span class="type-signature"></span></h4> <div class="description"> <p>Picks features based off a latitude, longitude and (optionally) height.</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>latlng</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"><p>The position on the earth to pick.</p></td> </tr> <tr> <td class="name"><code>imageryLayerCoords</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"><p>A map of imagery provider urls to the coords used to get features for those imagery providers - i.e. x, y, level</p></td> </tr> <tr> <td class="name"><code>existingFeatures</code></td> <td class="type"> </td> <td class="description last"><p>An optional list of existing features to concatenate the ones found from asynchronous picking to.</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_GlobeOrMap.js.html">Models/GlobeOrMap.js</a>, <a href="Models_GlobeOrMap.js.html#line94">line 94</a> </li></ul></dd> </dl> <h4 class="name" id="raise"><span class="type-signature"></span>raise<span class="signature">(index)</span><span class="type-signature"></span></h4> <div class="description"> <p>Raise an item's level in the viewer This does not check that index is valid</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>index</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>The index of the item to raise</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_NoViewer.js.html">Models/NoViewer.js</a>, <a href="Models_NoViewer.js.html#line109">line 109</a> </li></ul></dd> </dl> <h4 class="name" id="raise"><span class="type-signature"></span>raise<span class="signature">(index)</span><span class="type-signature"></span></h4> <div class="description"> <p>Raise an item's level in the viewer This does not check that index is valid</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>index</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>The index of the item to raise</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_GlobeOrMap.js.html">Models/GlobeOrMap.js</a>, <a href="Models_GlobeOrMap.js.html#line193">line 193</a> </li></ul></dd> </dl> <h4 class="name" id="removeAttribution"><span class="type-signature"></span>removeAttribution<span class="signature">(attribution)</span><span class="type-signature"></span></h4> <div class="description"> <p>Removes an attribution from the globe or map.</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>attribution</code></td> <td class="type"> <span class="param-type">Credit</span> </td> <td class="description last"><p>The attribution to remove.</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_NoViewer.js.html">Models/NoViewer.js</a>, <a href="Models_NoViewer.js.html#line92">line 92</a> </li></ul></dd> </dl> <h4 class="name" id="removeAttribution"><span class="type-signature"></span>removeAttribution<span class="signature">(attribution)</span><span class="type-signature"></span></h4> <div class="description"> <p>Removes an attribution from the globe or map.</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>attribution</code></td> <td class="type"> <span class="param-type">Credit</span> </td> <td class="description last"><p>The attribution to remove.</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_GlobeOrMap.js.html">Models/GlobeOrMap.js</a>, <a href="Models_GlobeOrMap.js.html#line166">line 166</a> </li></ul></dd> </dl> <h4 class="name" id="updateLayerOrderAfterReorder"><span class="type-signature"></span>updateLayerOrderAfterReorder<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> <p>Perform any updates to the order of layers required by raise and lower, but after the items have been reordered. This allows for the possibility that raise and lower do nothing, and instead we call updateLayerOrder</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_NoViewer.js.html">Models/NoViewer.js</a>, <a href="Models_NoViewer.js.html#line101">line 101</a> </li></ul></dd> </dl> <h4 class="name" id="updateLayerOrderAfterReorder"><span class="type-signature"></span>updateLayerOrderAfterReorder<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> <p>Perform any updates to the order of layers required by raise and lower, but after the items have been reordered. This allows for the possibility that raise and lower do nothing, and instead we call updateLayerOrder</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_GlobeOrMap.js.html">Models/GlobeOrMap.js</a>, <a href="Models_GlobeOrMap.js.html#line184">line 184</a> </li></ul></dd> </dl> <h4 class="name" id="zoomTo"><span class="type-signature"></span>zoomTo<span class="signature">(viewOrExtent, flightDurationSeconds<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> <p>Zooms to a specified camera view or extent with a smooth flight animation.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>viewOrExtent</code></td> <td class="type"> <span class="param-type"><a href="CameraView.html">CameraView</a></span> | <span class="param-type">Rectangle</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The view or extent to which to zoom.</p></td> </tr> <tr> <td class="name"><code>flightDurationSeconds</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 3.0 </td> <td class="description last"><p>The length of the flight animation in seconds.</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_GlobeOrMap.js.html">Models/GlobeOrMap.js</a>, <a href="Models_GlobeOrMap.js.html#line125">line 125</a> </li></ul></dd> </dl> <h4 class="name" id="zoomTo"><span class="type-signature"></span>zoomTo<span class="signature">(viewOrExtent, flightDurationSeconds<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> <p>Zooms to a specified camera view or extent with a smooth flight animation.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>viewOrExtent</code></td> <td class="type"> <span class="param-type"><a href="CameraView.html">CameraView</a></span> | <span class="param-type">Rectangle</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The view or extent to which to zoom.</p></td> </tr> <tr> <td class="name"><code>flightDurationSeconds</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 3.0 </td> <td class="description last"><p>The length of the flight animation in seconds.</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_NoViewer.js.html">Models/NoViewer.js</a>, <a href="Models_NoViewer.js.html#line53">line 53</a> </li></ul></dd> </dl> </article> </section> <section> <header> <h2><span class="attribs"><span class="type-signature"></span></span>GlobeOrMap<span class="signature">()</span><span class="type-signature"></span></h2> </header> <article> <div class="container-overview"> <h4 class="name" id="GlobeOrMap"><span class="type-signature"></span>new GlobeOrMap<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> <p>The base class for map/globe viewers.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_NoViewer.js.html">Models/NoViewer.js</a>, <a href="Models_NoViewer.js.html#line18">line 18</a> </li></ul></dd> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="Cesium.html">Cesium</a></li> <li><a href="Leaflet.html">Leaflet</a></li> </ul> </dd> </dl> </div> <h3 class="subsection-title">Members</h3> <h4 class="name" id="canShowSplitter"><span class="type-signature"></span>canShowSplitter<span class="type-signature"> :Boolean</span></h4> <div class="description"> <p>Gets or sets whether this viewer <em>can</em> show a splitter. Default 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_GlobeOrMap.js.html">Models/GlobeOrMap.js</a>, <a href="Models_GlobeOrMap.js.html#line42">line 42</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 or sets 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="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_GlobeOrMap.js.html">Models/GlobeOrMap.js</a>, <a href="Models_GlobeOrMap.js.html#line36">line 36</a> </li></ul></dd> </dl> <h3 class="subsection-title">Methods</h3> <h4 class="name" id="_createFeatureFromImageryLayerFeature"><span class="type-signature">(protected) </span>_createFeatureFromImageryLayerFeature<span class="signature">(imageryFeature)</span><span class="type-signature"> → {<a href="Feature.html">Feature</a>}</span></h4> <div class="description"> <p>Creates a {@see Feature} (based on an {@see Entity}) from a {@see ImageryLayerFeatureInfo}.</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>imageryFeature</code></td> <td class="type"> <span class="param-type"><a href="ImageryLayerFeatureInfo.html">ImageryLayerFeatureInfo</a></span> </td> <td class="description last"><p>The imagery layer feature for which to create an entity-based feature.</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_GlobeOrMap.js.html">Models/GlobeOrMap.js</a>, <a href="Models_GlobeOrMap.js.html#line57">line 57</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The created feature.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="Feature.html">Feature</a></span> </dd> </dl> <h4 class="name" id="addAttribution"><span class="type-signature"></span>addAttribution<span class="signature">(attribution)</span><span class="type-signature"></span></h4> <div class="description"> <p>Adds an attribution to the globe or map.</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>attribution</code></td> <td class="type"> <span class="param-type">Credit</span> </td> <td class="description last"><p>The attribution to add.</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_GlobeOrMap.js.html">Models/GlobeOrMap.js</a>, <a href="Models_GlobeOrMap.js.html#line158">line 158</a> </li></ul></dd> </dl> <h4 class="name" id="addAttribution"><span class="type-signature"></span>addAttribution<span class="signature">(attribution)</span><span class="type-signature"></span></h4> <div class="description"> <p>Adds an attribution to the globe or map.</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>attribution</code></td> <td class="type"> <span class="param-type">Credit</span> </td> <td class="description last"><p>The attribution to add.</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_NoViewer.js.html">Models/NoViewer.js</a>, <a href="Models_NoViewer.js.html#line85">line 85</a> </li></ul></dd> </dl> <h4 class="name" id="captureScreenshot"><span class="type-signature"></span>captureScreenshot<span class="signature">()</span><span class="type-signature"> →