terriajs
Version:
Geospatial data visualization platform.
3,688 lines (937 loc) • 62.3 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: Cesium</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: Cesium</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>Cesium<span class="signature">(terria, viewer)</span><span class="type-signature"></span></h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="Cesium"><span class="type-signature"></span>new Cesium<span class="signature">(terria, viewer)</span><span class="type-signature"></span></h4>
<div class="description">
<p>The Cesium 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>viewer</code></td>
<td class="type">
<span class="param-type">Viewer</span>
</td>
<td class="description last"><p>The Cesium viewer 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_Cesium.js.html">Models/Cesium.js</a>, <a href="Models_Cesium.js.html#line49">line 49</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_Cesium.js.html">Models/Cesium.js</a>, <a href="Models_Cesium.js.html#line80">line 80</a>
</li></ul></dd>
</dl>
<h4 class="name" id="scene"><span class="type-signature"></span>scene<span class="type-signature"> :Scene</span></h4>
<div class="description">
<p>Gets or sets the Cesium Scene instance.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Scene</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_Cesium.js.html">Models/Cesium.js</a>, <a href="Models_Cesium.js.html#line62">line 62</a>
</li></ul></dd>
</dl>
<h4 class="name" id="stoppedRendering"><span class="type-signature"></span>stoppedRendering<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets or sets whether the viewer has stopped rendering since startup or last set to 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_Cesium.js.html">Models/Cesium.js</a>, <a href="Models_Cesium.js.html#line68">line 68</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>
<h4 class="name" id="verboseRendering"><span class="type-signature"></span>verboseRendering<span class="type-signature"> :Boolean</span></h4>
<div class="description">
<p>Gets or sets whether to output info to the console when starting and stopping rendering loop.</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_Cesium.js.html">Models/Cesium.js</a>, <a href="Models_Cesium.js.html#line74">line 74</a>
</li></ul></dd>
</dl>
<h4 class="name" id="viewer"><span class="type-signature"></span>viewer<span class="type-signature"> :Viewer</span></h4>
<div class="description">
<p>Gets or sets the Cesium Viewer instance.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Viewer</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_Cesium.js.html">Models/Cesium.js</a>, <a href="Models_Cesium.js.html#line56">line 56</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 globe.</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_Cesium.js.html">Models/Cesium.js</a>, <a href="Models_Cesium.js.html#line512">line 512</a>
</li></ul></dd>
</dl>
<h4 class="name" id="addImageryProvider"><span class="type-signature"></span>addImageryProvider<span class="signature">(options, layerIndex<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {ImageryLayer}</span></h4>
<div class="description">
<p>Returns a new layer using a provided ImageryProvider, and adds it to the scene.
Note the optional parameters are a superset of the Leaflet version of this function, with one deletion (onProjectionError).</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>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Options</p>
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</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="description last"><p>The imagery provider to create a new layer for.</p></td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td class="name"><code>layerIndex</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>The index to add the layer at. If omitted, the layer will added on top of all existing layers.</p></td>
</tr>
<tr>
<td class="name"><code>options.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>options.opacity</code></td>
<td class="type">
<span class="param-type">Number</span>
|
<span class="param-type">function</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.
This can either be a simple number or a function with the signature
<code>function(frameState, layer, x, y, level)</code>. The function is passed the
current frame state, this layer, and the x, y, and level coordinates of the
imagery tile for which the alpha is required, and it is expected to return
the alpha value to use for the tile.</p></td>
</tr>
<tr>
<td class="name"><code>options.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>options.treat403AsError</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>options.treat403AsError</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>options.ignoreUnknownTileErrors</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>options.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>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_Cesium.js.html">Models/Cesium.js</a>, <a href="Models_Cesium.js.html#line875">line 875</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_Cesium.js.html">Models/Cesium.js</a>, <a href="Models_Cesium.js.html#line450">line 450</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_Cesium.js.html">Models/Cesium.js</a>, <a href="Models_Cesium.js.html#line504">line 504</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_Cesium.js.html">Models/Cesium.js</a>, <a href="Models_Cesium.js.html#line532">line 532</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_Cesium.js.html">Models/Cesium.js</a>, <a href="Models_Cesium.js.html#line374">line 374</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_Cesium.js.html">Models/Cesium.js</a>, <a href="Models_Cesium.js.html#line311">line 311</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_Cesium.js.html">Models/Cesium.js</a>, <a href="Models_Cesium.js.html#line613">line 613</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_Cesium.js.html">Models/Cesium.js</a>, <a href="Models_Cesium.js.html#line651">line 651</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_Cesium.js.html">Models/Cesium.js</a>, <a href="Models_Cesium.js.html#line490">line 490</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_Cesium.js.html">Models/Cesium.js</a>, <a href="Models_Cesium.js.html#line680">line 680</a>
</li></ul></dd>
</dl>
<h4 class="name" id="pickFromScreenPosition"><span class="type-signature"></span>pickFromScreenPosition<span class="signature">(screenPosition)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Picks features based on coordinates relative to the Cesium window. Will draw a ray from the camera through the point
specified and set terria.pickedFeatures based on this.</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>screenPosition</code></td>
<td class="type">
<span class="param-type">Cartesian3</span>
</td>
<td class="description last"><p>The position on the screen.</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_Cesium.js.html">Models/Cesium.js</a>, <a href="Models_Cesium.js.html#line713">line 713</a>
</li></ul></dd>
</dl>
<h4 class="name" id="pickVectorFeatures"><span class="type-signature"></span>pickVectorFeatures<span class="signature">(screenPosition)</span><span class="type-signature"> → {Array.<<a href="Feature.html">Feature</a>>}</span></h4>
<div class="description">
<p>Picks all <em>vector</em> features (e.g. GeoJSON) shown at a certain position on the screen, ignoring raster features
(e.g. WFS). Because all vector features are already in memory, this is synchronous.</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>screenPosition</code></td>
<td class="type">
<span class="param-type">Cartesian2</span>
</td>
<td class="description last"><p>position on the screen to look for features</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_Cesium.js.html">Models/Cesium.js</a>, <a href="Models_Cesium.js.html#line740">line 740</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The features found.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<<a href="Feature.html">Feature</a>></span>
</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_Cesium.js.html">Models/Cesium.js</a>, <a href="Models_Cesium.js.html#line569">line 569</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.</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_Cesium.js.html">Models/Cesium.js</a>, <a href="Models_Cesium.js.html#line522">line 522</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-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_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="updateLayerOrderToKeepOnTop"><span class="type-signature"></span>updateLayerOrderToKeepOnTop<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Updates the order of layers, moving layers where CatalogItem#keepOnTop is true to the top.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Models_Cesium.js.html">Models/Cesium.js</a>, <a href="Models_Cesium.js.html#line540">line 540</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-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_Cesium.js.html">Models/Cesium.js</a>, <a href="Models_Cesium.js.html#line384">line 384</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="SensorObservationServiceCatalogI