terriajs

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: Leaflet</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: Leaflet</h1> <section> <header> <h2><span class="attribs"><span class="type-signature"></span></span>Leaflet<span class="signature">(terria, map)</span><span class="type-signature"></span></h2> </header> <article> <div class="container-overview"> <h4 class="name" id="Leaflet"><span class="type-signature"></span>new Leaflet<span class="signature">(terria, map)</span><span class="type-signature"></span></h4> <div class="description"> <p>The Leaflet viewer component</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>map</code></td> <td class="type"> <span class="param-type">Map</span> </td> <td class="description last"><p>The leaflet map 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_Leaflet.js.html">Models/Leaflet.js</a>, <a href="Models_Leaflet.js.html#line79">line 79</a> </li></ul></dd> </dl> </div> <h3 class="subsection-title">Extends</h3> <ul> <li><a href="GlobeOrMap.html">GlobeOrMap</a></li> </ul> <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.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Boolean</span> </li> </ul> <dl class="details"> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="GlobeOrMap.html#canShowSplitter">GlobeOrMap#canShowSplitter</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_Leaflet.js.html">Models/Leaflet.js</a>, <a href="Models_Leaflet.js.html#line94">line 94</a> </li></ul></dd> </dl> <h4 class="name" id="map"><span class="type-signature"></span>map<span class="type-signature"> :Map</span></h4> <div class="description"> <p>Gets or sets the Leaflet Map instance.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Map</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_Leaflet.js.html">Models/Leaflet.js</a>, <a href="Models_Leaflet.js.html#line86">line 86</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="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="GlobeOrMap.html#terria">GlobeOrMap#terria</a> </li></ul></dd> <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="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="GlobeOrMap.html#_createFeatureFromImageryLayerFeature">GlobeOrMap#_createFeatureFromImageryLayerFeature</a> </li></ul></dd> <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 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-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="GlobeOrMap.html#addAttribution">GlobeOrMap#addAttribution</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_Leaflet.js.html">Models/Leaflet.js</a>, <a href="Models_Leaflet.js.html#line372">line 372</a> </li></ul></dd> </dl> <h4 class="name" id="addImageryProvider"><span class="type-signature"></span>addImageryProvider<span class="signature">(options)</span><span class="type-signature"> → {ImageryLayer}</span></h4> <div class="description"> <p>Returns a new layer using a provided ImageryProvider. Does not add it to anything - in Leaflet there is no equivalent to Cesium's ability to add a layer without showing it, so here this is done by show/hide. Note the optional parameters are a subset of the Cesium version of this function, with one addition (onProjectionError).</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>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"><p>Options</p> <h6>Properties</h6> <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>imageryProvider</code></td> <td class="type"> <span class="param-type">ImageryProvider</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The imagery provider to create a new layer for.</p></td> </tr> <tr> <td class="name"><code>rectangle</code></td> <td class="type"> <span class="param-type">Rectangle</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> imageryProvider.rectangle </td> <td class="description last"><p>The rectangle of the layer. This rectangle can limit the visible portion of the imagery provider.</p></td> </tr> <tr> <td class="name"><code>opacity</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 1.0 </td> <td class="description last"><p>The alpha blending value of this layer, from 0.0 to 1.0.</p></td> </tr> <tr> <td class="name"><code>clipToRectangle</code></td> <td class="type"> <span class="param-type">Boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>onLoadError</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>onProjectionError</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"></td> </tr> </tbody> </table> </td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_Leaflet.js.html">Models/Leaflet.js</a>, <a href="Models_Leaflet.js.html#line492">line 492</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The newly created layer.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">ImageryLayer</span> </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-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="GlobeOrMap.html#captureScreenshot">GlobeOrMap#captureScreenshot</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_Leaflet.js.html">Models/Leaflet.js</a>, <a href="Models_Leaflet.js.html#line275">line 275</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="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-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="GlobeOrMap.html#computePositionOnScreen">GlobeOrMap#computePositionOnScreen</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_Leaflet.js.html">Models/Leaflet.js</a>, <a href="Models_Leaflet.js.html#line355">line 355</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-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="GlobeOrMap.html#getAllAttribution">GlobeOrMap#getAllAttribution</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_Leaflet.js.html">Models/Leaflet.js</a>, <a href="Models_Leaflet.js.html#line392">line 392</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-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="GlobeOrMap.html#getContainer">GlobeOrMap#getContainer</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_Leaflet.js.html">Models/Leaflet.js</a>, <a href="Models_Leaflet.js.html#line232">line 232</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-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="GlobeOrMap.html#getCurrentExtent">GlobeOrMap#getCurrentExtent</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_Leaflet.js.html">Models/Leaflet.js</a>, <a href="Models_Leaflet.js.html#line223">line 223</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-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="GlobeOrMap.html#lower">GlobeOrMap#lower</a> </li></ul></dd> <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="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-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="GlobeOrMap.html#lowerToBottom">GlobeOrMap#lowerToBottom</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_Leaflet.js.html">Models/Leaflet.js</a>, <a href="Models_Leaflet.js.html#line450">line 450</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-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="GlobeOrMap.html#notifyRepaintRequired">GlobeOrMap#notifyRepaintRequired</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_Leaflet.js.html">Models/Leaflet.js</a>, <a href="Models_Leaflet.js.html#line343">line 343</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-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="GlobeOrMap.html#pickFromLocation">GlobeOrMap#pickFromLocation</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_Leaflet.js.html">Models/Leaflet.js</a>, <a href="Models_Leaflet.js.html#line472">line 472</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-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="GlobeOrMap.html#raise">GlobeOrMap#raise</a> </li></ul></dd> <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 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-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="GlobeOrMap.html#removeAttribution">GlobeOrMap#removeAttribution</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_Leaflet.js.html">Models/Leaflet.js</a>, <a href="Models_Leaflet.js.html#line382">line 382</a> </li></ul></dd> </dl> <h4 class="name" id="updateLayerOrder"><span class="type-signature"></span>updateLayerOrder<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> <p>Updates the order of layers on the Leaflet map to match the order in the Now Viewing pane.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_Leaflet.js.html">Models/Leaflet.js</a>, <a href="Models_Leaflet.js.html#line409">line 409</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>Because Leaflet doesn't actually do raise/lower, just reset the orders after every raise/lower</p> </div> <dl class="details"> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="GlobeOrMap.html#updateLayerOrderAfterReorder">GlobeOrMap#updateLayerOrderAfterReorder</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_Leaflet.js.html">Models/Leaflet.js</a>, <a href="Models_Leaflet.js.html#line433">line 433</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.</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. Leaflet ignores the actual value, but will use an animated transition when this value is greater than 0.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="GlobeOrMap.html#zoomTo">GlobeOrMap#zoomTo</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Models_Leaflet.js.html">Models/Leaflet.js</a>, <a href="Models_Leaflet.js.html#line243">line 243</a> </li></ul></dd> </dl> </article> </section> </div> <nav> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AbsCode.html">AbsCode</a></li><li><a href="AbsConcept.html">AbsConcept</a></li><li><a href="AbsDataset.html">AbsDataset</a></li><li><a href="AbsIttCatalogGroup.html">AbsIttCatalogGroup</a></li><li><a href="AbsIttCatalogItem.html">AbsIttCatalogItem</a></li><li><a href="AddressGeocoder.html">AddressGeocoder</a></li><li><a href="ArcGisCatalogGroup.html">ArcGisCatalogGroup</a></li><li><a href="ArcGisFeatureServerCatalogGroup.html">ArcGisFeatureServerCatalogGroup</a></li><li><a href="ArcGisFeatureServerCatalogItem.html">ArcGisFeatureServerCatalogItem</a></li><li><a href="ArcGisMapServerCatalogGroup.html">ArcGisMapServerCatalogGroup</a></li><li><a href="ArcGisMapServerCatalogItem.html">ArcGisMapServerCatalogItem</a></li><li><a href="AugmentedVirtuality.html">AugmentedVirtuality</a></li><li><a href="BingMapsCatalogItem.html">BingMapsCatalogItem</a></li><li><a href="BooleanParameter.html">BooleanParameter</a></li><li><a href="BulkAddressGeocoderResult.html">BulkAddressGeocoderResult</a></li><li><a href="CameraView.html">CameraView</a></li><li><a href="Catalog.html">Catalog</a></li><li><a href="CatalogFunction.html">CatalogFunction</a></li><li><a href="CatalogGroup.html">CatalogGroup</a></li><li><a href="CatalogItem.html">CatalogItem</a></li><li><a href="CatalogMember.html">CatalogMember</a></li><li><a href="Cesium.html">Cesium</a></li><li><a href="Cesium3DTilesCatalogItem.html">Cesium3DTilesCatalogItem</a></li><li><a href="CesiumDragPoints.html">CesiumDragPoints</a></li><li><a href="CesiumTerrainCatalogItem.html">CesiumTerrainCatalogItem</a></li><li><a href="CkanCatalogGroup.html">CkanCatalogGroup</a></li><li><a href="CkanCatalogItem.html">CkanCatalogItem</a></li><li><a href="Clock.html">Clock</a></li><li><a href="CompositeCatalogItem.html">CompositeCatalogItem</a></li><li><a href="Concept.html">Concept</a></li><li><a href="CorsProxy.html">CorsProxy</a></li><li><a href="CsvCatalogItem.html">CsvCatalogItem</a></li><li><a href="CswCatalogGroup.html">CswCatalogGroup</a></li><li><a href="CustomComponentType.html">CustomComponentType</a></li><li><a href="CzmlCatalogItem.html">CzmlCatalogItem</a></li><li><a href="DataSourceCatalogItem.html">DataSourceCatalogItem</a></li><li><a href="DateTimeParameter.html">DateTimeParameter</a></li><li><a href="DisplayVariablesConcept.html">DisplayVariablesConcept</a></li><li><a href="EnumerationParameter.html">EnumerationParameter</a></li><li><a href="Feature.html">Feature</a></li><li><a href="FunctionParameter.html">FunctionParameter</a></li><li><a href="GeoJsonCatalogItem.html">GeoJsonCatalogItem</a></li><li><a href="GlobeOrMap.html">GlobeOrMap</a></li><li><a href="GnafAddressGeocoder.html">GnafAddressGeocoder</a></li><li><a href="GnafApi.html">GnafApi</a></li><li><a href="GnafSearchProviderViewModel.html">GnafSearchProviderViewModel</a></li><li><a href="GpxCatalogItem.html">GpxCatalogItem</a></li><li><a href="HelpScreen.html">HelpScreen</a></li><li><a href="HelpSequence.html">HelpSequence</a></li><li><a href="HelpSequences.html">HelpSequences</a></li><li><a href="HelpViewState.html">HelpViewState</a></li><li><a href="ImageryLayerCatalogItem____.html">ImageryLayerCatalogItem</a></li><li><a href="IonImageryCatalogItem.html">IonImageryCatalogItem</a></li><li><a href="KmlCatalogItem.html">KmlCatalogItem</a></li><li><a href="Leaflet.html">Leaflet</a></li><li><a href="LeafletDataSourceDisplay.html">LeafletDataSourceDisplay</a></li><li><a href="LeafletDragPoints.html">LeafletDragPoints</a></li><li><a href="LeafletGeomVisualizer.html">LeafletGeomVisualizer</a></li><li><a href="LegendHelper.html">LegendHelper</a></li><li><a href="LegendUrl.html">LegendUrl</a></li><li><a href="LineParameter.html">LineParameter</a></li><li><a href="MagdaCatalogItem.html">MagdaCatalogItem</a></li><li><a href="MapboxMapCatalogItem.html">MapboxMapCatalogItem</a></li><li><a href="MapInteractionMode.html">MapInteractionMode</a></li><li><a href="Metadata.html">Metadata</a></li><li><a href="MetadataItem.html">MetadataItem</a></li><li><a href="module.html#.exports">exports</a></li><li><a href="OgrCatalogItem.html">OgrCatalogItem</a></li><li><a href="OpenStreetMapCatalogItem.html">OpenStreetMapCatalogItem</a></li><li><a href="PlacesLikeMeCatalogfunction.html">PlacesLikeMeCatalogfunction</a></li><li><a href="PointParameter.html">PointParameter</a></li><li><a href="Polling.html">Polling</a></li><li><a href="PolygonParameter.html">PolygonParameter</a></li><li><a href="RectangleParameter.html">RectangleParameter</a></li><li><a href="RegionDataParameter.html">RegionDataParameter</a></li><li><a href="RegionMapping.html">RegionMapping</a></li><li><a href="RegionParameter.html">RegionParameter</a></li><li><a href="RegionProvider.html">RegionProvider</a></li><li><a href="RegionProviderList.html">RegionProviderList</a></li><li><a href="RegionTypeParameter.html">RegionTypeParameter</a></li><li><a href="ResultPendingCatalogItem.html">ResultPendingCatalogItem</a></li><li><a href="SdmxJsonCatalogItem.html">SdmxJsonCatalogItem</a></li><li><a href="SensorObservationServiceCatalogItem.html">SensorObservationServiceCatalogItem</a></li><li><a href="SocrataCatalogGroup.html">SocrataCatalogGroup</a></li><li><a href="SpatialDetailingCatalogFunction.html">SpatialDetailingCatalogFunction</a></li><li><a href="StringParameter.html">StringParameter</a></li><li><a href="SummaryConcept.html">SummaryConcept</a></li><li><a href="TableCatalogItem.html">TableCatalogItem</a></li><li><a href="TableColumn.html">TableColumn</a></li><li><a href="TableColumnStyle.html">TableColumnStyle</a></li><li><a href="TableDataSource.html">TableDataSource</a></li><li><a href="TableStructure.html">TableStructure</a></li><li><a href="TableStyle.html">TableStyle</a></li><li><a href="TerrainCatalogItem.html">TerrainCatalogItem</a></li><li><a href="Terria.html">Terria</a></li><li><a href="TerriaError.html">TerriaError</a></li><li><a href="TerriaJsonCatalogFunction.html">TerriaJsonCatalogFunction</a></li><li><a href="TimeSeriesStack.html">TimeSeriesStack</a></li><li><a href="UrlTemplateCatalogItem.html">UrlTemplateCatalogItem</a></li><li><a href="UrthecastCatalogGroup.html">UrthecastCatalogGroup</a></li><li><a href="UrthecastServerCatalogItem.html">UrthecastServerCatalogItem</a></li><li><a href="UserDrawing.html">UserDrawing</a></li><li><a href="VariableConcept.html">VariableConcept</a></li><li><a href="ViewerModes..html">ViewerModes.</a></li><li><a href="WebFeatureServiceCatalogGroup.html">WebFeatureServiceCatalogGroup</a></li><li><a href="WebFeatureServiceCatalogItem.html">WebFeatureServiceCatalogItem</a></li><li><a href="WebMapServiceCatalogGroup.html">WebMapServiceCatalogGroup</a></li><li><a href="WebMapServiceCatalogItem.html">WebMapServiceCatalogItem</a></li><li><a href="WebMapTileServiceCatalogGroup.html">WebMapTileServiceCatalogGroup</a></li><li><a href="WebMapTileServiceCatalogItem.html">WebMapTileServiceCatalogItem</a></li><li><a href="WebProcessingServiceCatalogFunction.html">WebProcessingServiceCatalogFunction</a></li><li><a href="WebProcessingServiceCatalogGroup.html">WebProcessingServiceCatalogGroup</a></li><li><a href="WebProcessingServiceCatalogItem.html">WebProcessingServiceCatalogItem</a></li><li><a href="WfsFeaturesCatalogGroup.html">WfsFeaturesCatalogGroup</a></li><li><a href="WhyAmISpecialCatalogFunction.html">WhyAmISpecialCatalogFunction</a></li></ul><h3>Global</h3><ul><li><a href="global.html#_bumpyTerrainProvider">_bumpyTerrainProvider</a></li><li><a href="global.html#_terrain">_terrain</a></li><li><a href="global.html#activeTimeColumnNameIdOrIndex">activeTimeColumnNameIdOrIndex</a></li><li><a href="global.html#addBoundingBox">addBoundingBox</a></li><li><a href="global.html#addMarker">addMarker</a></li><li><a href="global.html#addUserCatalogMember">addUserCatalogMember</a></li><li><a href="global.html#allFeaturesAvailablePromise">allFeaturesAvailablePromise</a></li><li><a href="global.html#allShareKeys">allShareKeys</a></li><li><a href="global.html#arrayProduct">arrayProduct</a></li><li><a href="global.html#barHeightMax">barHeightMax</a></li><li><a href="global.html#barHeightMin">barHeightMin</a></li><li><a href="global.html#barLeft">barLeft</a></li><li><a href="global.html#barTop">barTop</a></li><li><a href="global.html#buildEmptyAccumulator">buildEmptyAccumulator</a></li><li><a href="global.html#buildRequestData">buildRequestData</a></li><li><a href="global.html#buildShareLink">buildShareLink</a></li><li><a href="global.html#buildShortShareLink">buildShortShareLink</a></li><li><a href="global.html#calculateFinishDatesFromStartDates">calculateFinishDatesFromStartDates</a></li><li><a href="global.html#canShorten">canShorten</a></li><li><a href="global.html#categoryName">categoryName</a></li><li><a href="global.html#ChartData">ChartData</a></li><li><a href="global.html#color">color</a></li><li><a href="global.html#ColorMap">ColorMap</a></li><li><a href="global.html#combineData">combineData</a></li><li><a href="global.html#combineFilters">combineFilters</a></li><li><a href="global.html#combineRepeated">combineRepeated</a></li><li><a href="global.html#combineValueArrays">combineValueArrays</a></li><li><a href="global.html#computeRingWindingOrder">computeRingWindingOrder</a></li><li><a href="global.html#computeScreenSpacePosition">computeScreenSpacePosition</a></li><li><a href="global.html#config">config</a></li><li><a href="global.html#containsAny">containsAny</a></li><li><a href="global.html#convertLuceneHit">convertLuceneHit</a></li><li><a href="global.html#convertToDates">convertToDates</a></li><li><a href="global.html#correctEntityHeight">correctEntityHeight</a></li><li><a href="global.html#createCatalogItemFromFileOrUrl">createCatalogItemFromFileOrUrl</a></li><li><a href="global.html#createCatalogItemFromUrl">createCatalogItemFromUrl</a></li><li><a href="global.html#createCatalogMemberFromType">createCatalogMemberFromType</a></li><li><a href="global.html#createLeafletCredit">createLeafletCredit</a></li><li><a href="global.html#createParameterFromType">createParameterFromType</a></li><li><a href="global.html#createRegexDeserializer">createRegexDeserializer</a></li><li><a href="global.html#createRegexSerializer">createRegexSerializer</a></li><li><a href="global.html#cssClass">cssClass</a></li><li><a href="global.html#CustomComponents">CustomComponents</a></li><li><a href="global.html#deIndexWithDescendants">deIndexWithDescendants</a></li><li><a href="global.html#Description">Description</a></li><li><a href="global.html#direction">direction</a></li><li><a href="global.html#disposeSubscription">disposeSubscription</a></li><li><a href="global.html#EarthGravityModel1996">EarthGravityModel1996</a></li><li><a href="global.html#error">error</a></li><li><a href="global.html#extendLoad">extendLoad</a></li><li><a href="global.html#extent">extent</a></li><li><a href="global.html#featureClicked">featureClicked</a></li><li><a href="global.html#featureDataToGeoJson">featureDataToGeoJson</a></li><li><a href="global.html#featureMousedown">featureMousedown</a></li><li><a href="global.html#features">features</a></li><li><a href="global.html#findKeyForGroupElement">findKeyForGroupElement</a></li><li><a href="global.html#flattenCatalog">flattenCatalog</a></li><li><a href="global.html#formatDate">formatDate</a></li><li><a href="global.html#formatDateTime">formatDateTime</a></li><li><a href="global.html#formatNumberForLocale">formatNumberForLocale</a></li><li><a href="global.html#formatPropertyValue">formatPropertyValue</a></li><li><a href="global.html#formatTime">formatTime</a></li><li><a href="global.html#getAncestors">getAncestors</a></li><li><a href="global.html#getColumnOptions">getColumnOptions</a></li><li><a href="global.html#getColumnWithNameIdOrIndex">getColumnWithNameIdOrIndex</a></li><li><a href="global.html#getDataUriFormat">getDataUriFormat</a></li><li><a href="global.html#getGroupChildren">getGroupChildren</a></li><li><a href="global.html#getShareData">getShareData</a></li><li><a href="global.html#getTemporalFiltersContext">getTemporalFiltersContext</a></li><li><a href="global.html#getUniqueValues">getUniqueValues</a></li><li><a href="global.html#gmlToGeoJson">gmlToGeoJson</a></li><li><a href="global.html#gradientColorMap">gradientColorMap</a></li><li><a href="global.html#hasAddress">hasAddress</a></li><li><a href="global.html#hasChildren">hasChildren</a></li><li><a href="global.html#hasLatitudeAndLongitude">hasLatitudeAndLongitude</a></li><li><a href="global.html#hostInDomains">hostInDomains</a></li><li><a href="global.html#id">id</a></li><li><a href="global.html#infoWithoutSources">infoWithoutSources</a></li><li><a href="global.html#isBrowserCompatible">isBrowserCompatible</a></li><li><a href="global.html#isCommonMobilePlatform">isCommonMobilePlatform</a></li><li><a href="global.html#isLoading">isLoading</a></li><li><a href="global.html#isVisible">isVisible</a></li><li><a href="global.html#itemHeight">itemHeight</a></li><li><a href="global.html#itemHeightMin">itemHeightMin</a></li><li><a href="global.html#items">items</a></li><li><a href="global.html#item