wuhongjian
/
qd-changjing
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
qd-changjing/public/static/Build/Documentation/ImageryLayerCollection.html

2749 lines
81 KiB
HTML
Raw Normal View History

first commit
2022-07-05 16:56:29 +08:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>ImageryLayerCollection - Cesium Documentation</title>
<!--[if lt IE 9]>
<script src="javascript/html5.js"></script>
<![endif]-->
<link href="styles/jsdoc-default.css" rel="stylesheet">
<link href="styles/prism.css" rel="stylesheet">
</head>
<body>
<div id="main">
<h1 class="page-title">
<a href="index.html"><img src="Images/CesiumLogo.png" class="cesiumLogo"></a>
ImageryLayerCollection
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="ImageryLayerCollection">
<a href="#ImageryLayerCollection" class="doc-link"></a>
new Cesium.ImageryLayerCollection<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayerCollection.js#L20">Scene/ImageryLayerCollection.js 20</a>
</div>
</h4>
</div>
<div class="description">
An ordered collection of imagery layers.
</div>
<dl class="details">
<h5>Demo:</h5>
<ul class="see-list">
<li><a href="https://sandcastle.cesium.com/index.html?src=Imagery%2520Adjustment.html">Cesium Sandcastle Imagery Adjustment Demo</a></li>
<li><a href="https://sandcastle.cesium.com/index.html?src=Imagery%2520Layers%2520Manipulation.html">Cesium Sandcastle Imagery Manipulation Demo</a></li>
</ul>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="layerAdded">
<a href="#layerAdded" class="doc-link"></a>
layerAdded<span class="type-signature"> : <a href="Event.html">Event</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayerCollection.js#L29">Scene/ImageryLayerCollection.js 29</a>
</div>
</h4>
</div>
<div class="description">
An event that is raised when a layer is added to the collection. Event handlers are passed the layer that
was added and the index at which it was added.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">Event()</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="layerMoved">
<a href="#layerMoved" class="doc-link"></a>
layerMoved<span class="type-signature"> : <a href="Event.html">Event</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayerCollection.js#L45">Scene/ImageryLayerCollection.js 45</a>
</div>
</h4>
</div>
<div class="description">
An event that is raised when a layer changes position in the collection. Event handlers are passed the layer that
was moved, its new index after the move, and its old index prior to the move.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">Event()</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="layerRemoved">
<a href="#layerRemoved" class="doc-link"></a>
layerRemoved<span class="type-signature"> : <a href="Event.html">Event</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayerCollection.js#L37">Scene/ImageryLayerCollection.js 37</a>
</div>
</h4>
</div>
<div class="description">
An event that is raised when a layer is removed from the collection. Event handlers are passed the layer that
was removed and the index from which it was removed.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">Event()</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="layerShownOrHidden">
<a href="#layerShownOrHidden" class="doc-link"></a>
layerShownOrHidden<span class="type-signature"> : <a href="Event.html">Event</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayerCollection.js#L56">Scene/ImageryLayerCollection.js 56</a>
</div>
</h4>
</div>
<div class="description">
An event that is raised when a layer is shown or hidden by setting the
<a href="ImageryLayer.html#show"><code>ImageryLayer#show</code></a> property. Event handlers are passed a reference to this layer,
the index of the layer in the collection, and a flag that is true if the layer is now
shown or false if it is now hidden.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">Event()</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="length">
<a href="#length" class="doc-link"></a>
length<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayerCollection.js#L65">Scene/ImageryLayerCollection.js 65</a>
</div>
</h4>
</div>
<div class="description">
Gets the number of layers in this collection.
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id="add">
<a href="#add" class="doc-link"></a>
add<span class="signature">(layer, <span class="optional">index</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayerCollection.js#L81">Scene/ImageryLayerCollection.js 81</a>
</div>
</h4>
</div>
<div class="description">
Adds a layer to the collection.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>layer</code></td>
<td class="type">
<span class="param-type"><a href="ImageryLayer.html">ImageryLayer</a></span>
</td>
<td class="description last">
the layer to add.</td>
</tr>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
the index to add the layer at. If omitted, the layer will
be added on top of all existing layers.</td>
</tr>
</tbody>
</table>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: index, if supplied, must be greater than or equal to zero and less than or equal to the number of the layers.
</div>
</li>
</ul>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="addImageryProvider">
<a href="#addImageryProvider" class="doc-link"></a>
addImageryProvider<span class="signature">(imageryProvider, <span class="optional">index</span>)</span> &rarr; <span class="type-signature returnType"><a href="ImageryLayer.html">ImageryLayer</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayerCollection.js#L118">Scene/ImageryLayerCollection.js 118</a>
</div>
</h4>
</div>
<div class="description">
Creates a new layer using the given ImageryProvider and adds it to the collection.
</div>
<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"><a href="ImageryProvider.html">ImageryProvider</a></span>
</td>
<td class="description last">
the imagery provider to create a new layer for.</td>
</tr>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
the index to add the layer at. If omitted, the layer will
added on top of all existing layers.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The newly created layer.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="contains">
<a href="#contains" class="doc-link"></a>
contains<span class="signature">(layer)</span> &rarr; <span class="type-signature returnType">Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayerCollection.js#L190">Scene/ImageryLayerCollection.js 190</a>
</div>
</h4>
</div>
<div class="description">
Checks to see if the collection contains a given layer.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>layer</code></td>
<td class="type">
<span class="param-type"><a href="ImageryLayer.html">ImageryLayer</a></span>
</td>
<td class="description last">
the layer to check for.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
true if the collection contains the layer, false otherwise.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="destroy">
<a href="#destroy" class="doc-link"></a>
destroy<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayerCollection.js#L581">Scene/ImageryLayerCollection.js 581</a>
</div>
</h4>
</div>
<div class="description">
Destroys the WebGL resources held by all layers in this collection. Explicitly destroying this
object allows for deterministic release of WebGL resources, instead of relying on the garbage
collector.
<br /><br />
Once this object is destroyed, it should not be used; calling any function other than
<code>isDestroyed</code> will result in a <a href="DeveloperError.html"><code>DeveloperError</code></a> exception. Therefore,
assign the return value (<code>undefined</code>) to the object as done in the example.
</div>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: This object was destroyed, i.e., destroy() was called.
</div>
</li>
</ul>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">layerCollection = layerCollection &amp;&amp; layerCollection.destroy();</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="ImageryLayerCollection.html#isDestroyed">ImageryLayerCollection#isDestroyed</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="get">
<a href="#get" class="doc-link"></a>
get<span class="signature">(index)</span> &rarr; <span class="type-signature returnType"><a href="ImageryLayer.html">ImageryLayer</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayerCollection.js#L212">Scene/ImageryLayerCollection.js 212</a>
</div>
</h4>
</div>
<div class="description">
Gets a layer by index from the collection.
</div>
<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">
the index to retrieve.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The imagery layer at the given index.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="indexOf">
<a href="#indexOf" class="doc-link"></a>
indexOf<span class="signature">(layer)</span> &rarr; <span class="type-signature returnType">Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayerCollection.js#L201">Scene/ImageryLayerCollection.js 201</a>
</div>
</h4>
</div>
<div class="description">
Determines the index of a given layer in the collection.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>layer</code></td>
<td class="type">
<span class="param-type"><a href="ImageryLayer.html">ImageryLayer</a></span>
</td>
<td class="description last">
The layer to find the index of.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The index of the layer in the collection, or -1 if the layer does not exist in the collection.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="isDestroyed">
<a href="#isDestroyed" class="doc-link"></a>
isDestroyed<span class="signature">()</span> &rarr; <span class="type-signature returnType">Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayerCollection.js#L560">Scene/ImageryLayerCollection.js 560</a>
</div>
</h4>
</div>
<div class="description">
Returns true if this object was destroyed; otherwise, false.
<br /><br />
If this object was destroyed, it should not be used; calling any function other than
<code>isDestroyed</code> will result in a <a href="DeveloperError.html"><code>DeveloperError</code></a> exception.
</div>
<h5>Returns:</h5>
<div class="param-desc">
true if this object was destroyed; otherwise, false.
</div>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="ImageryLayerCollection.html#destroy">ImageryLayerCollection#destroy</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="lower">
<a href="#lower" class="doc-link"></a>
lower<span class="signature">(layer)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayerCollection.js#L279">Scene/ImageryLayerCollection.js 279</a>
</div>
</h4>
</div>
<div class="description">
Lowers a layer down one position in the collection.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>layer</code></td>
<td class="type">
<span class="param-type"><a href="ImageryLayer.html">ImageryLayer</a></span>
</td>
<td class="description last">
the layer to move.</td>
</tr>
</tbody>
</table>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: layer is not in this collection.
</div>
</li>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: This object was destroyed, i.e., destroy() was called.
</div>
</li>
</ul>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="lowerToBottom">
<a href="#lowerToBottom" class="doc-link"></a>
lowerToBottom<span class="signature">(layer)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayerCollection.js#L313">Scene/ImageryLayerCollection.js 313</a>
</div>
</h4>
</div>
<div class="description">
Lowers a layer to the bottom of the collection.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>layer</code></td>
<td class="type">
<span class="param-type"><a href="ImageryLayer.html">ImageryLayer</a></span>
</td>
<td class="description last">
the layer to move.</td>
</tr>
</tbody>
</table>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: layer is not in this collection.
</div>
</li>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: This object was destroyed, i.e., destroy() was called.
</div>
</li>
</ul>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="pickImageryLayerFeatures">
<a href="#pickImageryLayerFeatures" class="doc-link"></a>
pickImageryLayerFeatures<span class="signature">(ray, scene)</span> &rarr; <span class="type-signature returnType">Promise.&lt;Array.&lt;<a href="ImageryLayerFeatureInfo.html">ImageryLayerFeatureInfo</a>>>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayerCollection.js#L462">Scene/ImageryLayerCollection.js 462</a>
</div>
</h4>
</div>
<div class="description">
Asynchronously determines the imagery layer features that are intersected by a pick ray. The intersected imagery
layer features are found by invoking <a href="ImageryProvider.html#pickFeatures"><code>ImageryProvider#pickFeatures</code></a> for each imagery layer tile intersected
by the pick ray. To compute a pick ray from a location on the screen, use <code>Camera.getPickRay</code>.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>ray</code></td>
<td class="type">
<span class="param-type"><a href="Ray.html">Ray</a></span>
</td>
<td class="description last">
The ray to test for intersection.</td>
</tr>
<tr>
<td class="name"><code>scene</code></td>
<td class="type">
<span class="param-type"><a href="Scene.html">Scene</a></span>
</td>
<td class="description last">
The scene.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
A promise that resolves to an array of features intersected by the pick ray.
If it can be quickly determined that no features are intersected (for example,
because no active imagery providers support <a href="ImageryProvider.html#pickFeatures"><code>ImageryProvider#pickFeatures</code></a>
or because the pick ray does not intersect the surface), this function will
return undefined.
</div>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">const pickRay = viewer.camera.getPickRay(windowPosition);
const featuresPromise = viewer.imageryLayers.pickImageryLayerFeatures(pickRay, viewer.scene);
if (!Cesium.defined(featuresPromise)) {
console.log('No features picked.');
} else {
Cesium.when(featuresPromise, function(features) {
// This function is called asynchronously when the list if picked features is available.
console.log('Number of features: ' + features.length);
if (features.length > 0) {
console.log('First feature name: ' + features[0].name);
}
});
}</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id="pickImageryLayers">
<a href="#pickImageryLayers" class="doc-link"></a>
pickImageryLayers<span class="signature">(ray, scene)</span> &rarr; <span class="type-signature returnType">Array.&lt;<a href="ImageryLayer.html">ImageryLayer</a>>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayerCollection.js#L410">Scene/ImageryLayerCollection.js 410</a>
</div>
</h4>
</div>
<div class="description">
Determines the imagery layers that are intersected by a pick ray. To compute a pick ray from a
location on the screen, use <code>Camera.getPickRay</code>.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>ray</code></td>
<td class="type">
<span class="param-type"><a href="Ray.html">Ray</a></span>
</td>
<td class="description last">
The ray to test for intersection.</td>
</tr>
<tr>
<td class="name"><code>scene</code></td>
<td class="type">
<span class="param-type"><a href="Scene.html">Scene</a></span>
</td>
<td class="description last">
The scene.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
An array that includes all of
the layers that are intersected by a given pick ray. Undefined if
no layers are selected.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="raise">
<a href="#raise" class="doc-link"></a>
raise<span class="signature">(layer)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayerCollection.js#L266">Scene/ImageryLayerCollection.js 266</a>
</div>
</h4>
</div>
<div class="description">
Raises a layer up one position in the collection.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>layer</code></td>
<td class="type">
<span class="param-type"><a href="ImageryLayer.html">ImageryLayer</a></span>
</td>
<td class="description last">
the layer to move.</td>
</tr>
</tbody>
</table>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: layer is not in this collection.
</div>
</li>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: This object was destroyed, i.e., destroy() was called.
</div>
</li>
</ul>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="raiseToTop">
<a href="#raiseToTop" class="doc-link"></a>
raiseToTop<span class="signature">(layer)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayerCollection.js#L292">Scene/ImageryLayerCollection.js 292</a>
</div>
</h4>
</div>
<div class="description">
Raises a layer to the top of the collection.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>layer</code></td>
<td class="type">
<span class="param-type"><a href="ImageryLayer.html">ImageryLayer</a></span>
</td>
<td class="description last">
the layer to move.</td>
</tr>
</tbody>
</table>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: layer is not in this collection.
</div>
</li>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: This object was destroyed, i.e., destroy() was called.
</div>
</li>
</ul>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="remove">
<a href="#remove" class="doc-link"></a>
remove<span class="signature">(layer, <span class="optional">destroy</span>)</span> &rarr; <span class="type-signature returnType">Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayerCollection.js#L141">Scene/ImageryLayerCollection.js 141</a>
</div>
</h4>
</div>
<div class="description">
Removes a layer from this collection, if present.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>layer</code></td>
<td class="type">
<span class="param-type"><a href="ImageryLayer.html">ImageryLayer</a></span>
</td>
<td class="default">
</td>
<td class="description last">
The layer to remove.</td>
</tr>
<tr>
<td class="name"><code>destroy</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">true</code>
</td>
<td class="description last">
<span class="optional">optional</span>
whether to destroy the layers in addition to removing them.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
true if the layer was in the collection and was removed,
false if the layer was not in the collection.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="removeAll">
<a href="#removeAll" class="doc-link"></a>
removeAll<span class="signature">(<span class="optional">destroy</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayerCollection.js#L167">Scene/ImageryLayerCollection.js 167</a>
</div>
</h4>
</div>
<div class="description">
Removes all layers from this collection.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>destroy</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">true</code>
</td>
<td class="description last">
<span class="optional">optional</span>
whether to destroy the layers in addition to removing them.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</article>
</section>
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a>
</footer>
</div>
<div class="nav">
<div class="menu">
<input type="text" class="classFilter" id="ClassFilter" placeholder="Search">
<ul id="ClassList"><li data-name="Animation"><a href="Animation.html">Animation</a></li><li data-name="AnimationViewModel"><a href="AnimationViewModel.html">AnimationViewModel</a></li><li data-name="Appearance"><a href="Appearance.html">Appearance</a></li><li data-name="ArcGisMapServerImageryProvider"><a href="ArcGisMapServerImageryProvider.html">ArcGisMapServerImageryProvider</a></li><li data-name="ArcGISTiledElevationTerrainProvider"><a href="ArcGISTiledElevationTerrainProvider.html">ArcGISTiledElevationTerrainProvider</a></li><li data-name="ArcType"><a href="global.html#ArcType">ArcType</a></li><li data-name="AssociativeArray"><a href="AssociativeArray.html">AssociativeArray</a></li><li data-name="Axis"><a href="global.html#Axis">Axis</a></li><li data-name="AxisAlignedBoundingBox"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></li><li data-name="backFaceCulling"><a href="global.html#backFaceCulling">backFaceCulling</a></li><li data-name="barycentricCoordinates"><a href="global.html#barycentricCoordinates">barycentricCoordinates</a></li><li data-name="BaseLayerPicker"><a href="BaseLayerPicker.html">BaseLayerPicker</a></li><li data-name="BaseLayerPickerViewModel"><a href="BaseLayerPickerViewModel.html">BaseLayerPickerViewModel</a></li><li data-name="Billboard"><a href="Billboard.html">Billboard</a></li><li data-name="BillboardCollection"><a href="BillboardCollection.html">BillboardCollection</a></li><li data-name="BillboardGraphics"><a href="BillboardGraphics.html">BillboardGraphics</a></li><li data-name="BillboardVisualizer"><a href="BillboardVisualizer.html">BillboardVisualizer</a></li><li data-name="binarySearch"><a href="global.html#binarySearch">binarySearch</a></li><li data-name="binarySearchComparator"><a href="global.html#binarySearchComparator">binarySearchComparator</a></li><li data-name="BingMapsGeocoderService"><a href="BingMapsGeocoderService.html">BingMapsGeocoderService</a></li><li data-name="BingMapsImageryProvider"><a href="BingMapsImageryProvider.html">BingMapsImageryProvider</a></li><li data-name="BingMapsStyle"><a href="global.html#BingMapsStyle">BingMapsStyle</a></li><li data-name="BlendEquation"><a href="global.html#BlendEquation">BlendEquation</a></li><li data-name="BlendFunction"><a href="global.html#BlendFunction">BlendFunction</a></li><li data-name="BlendingState"><a href="BlendingState.html">BlendingState</a></li><li data-name="BlendOption"><a href="global.html#BlendOption">BlendOption</a></li><li data-name="BoundingRectangle"><a href="BoundingRectangle.html">BoundingRectangle</a></li><li data-name="BoundingSphere"><a href="BoundingSphere.html">BoundingSphere</a></li><li data-name="boundingSphere"><a href="global.html#boundingSphere">boundingSphere</a></li><li data-name="BoxEmitter"><a href="BoxEmitter.html">BoxEmitter</a></li><li data-name="BoxGeometry"><a href="BoxGeometry.html">BoxGeometry</a></li><li data-name="BoxGeometryUpdater"><a href="BoxGeometryUpdater.html">BoxGeometryUpdater</a></li><li data-name="BoxGraphics"><a href="BoxGraphics.html">BoxGraphics</a></li><li data-name="BoxOutlineGeometry"><a href="BoxOutlineGeometry.html">BoxOutlineGeometry</a></li><li data-name="buildModuleUrl"><a href="global.html#buildModuleUrl">buildModuleUrl</a></li><li data-name="CallbackProperty"><a href="CallbackProperty.html">CallbackProperty</a></li><li data-name="Camera"><a href="Camera.html">Camera</a></li><li data-name="CameraEventAggregator"><a href="CameraEventAggregator.html">CameraEventAggregator</a></li><li data-name="CameraEventType"><a href="global.html#CameraEventType">CameraEventType</a></li><li data-name="cancelAnimationFrame"><a href="global.html#cancelAnimationFrame">cancelAnimationFrame</a></li><li data-name="Cartesian2"><a href="Cartesian2.html">Cartesian2</a></li><li data-name="Cartesian3"><a href="Cartesian3.html">Cartesian3</a></li><li data-name="Cartesian4"><a href="Cartesian4.html">Cartesian4</a></li><li data-name="Cartographic"><a href="Cartographic.html">Cartographic</a></li><li data-name="CartographicGeocoderService"><a href="CartographicGeocoderServic
</div>
</div>
<script>
if (window.frameElement) {
document.body.className = 'embedded';
var ele = document.createElement('a');
ele.className = 'popout';
ele.target = '_blank';
ele.href = window.location.href;
ele.title = 'Pop out';
document.getElementById('main').appendChild(ele);
}
// Set targets on external links. Sandcastle and GitHub shouldn't be embedded in any iframe.
Array.prototype.forEach.call(document.getElementsByTagName('a'), function(a) {
if (/^https?:/i.test(a.getAttribute('href'))) {
a.target='_blank';
}
});
</script>
<script src="javascript/prism.js"></script>
<script src="javascript/cesiumDoc.js"></script>
</body>
</html>