ImageryLayerCollection

Members

layerAdded :Event

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.

Default Value: Event()

Source: Scene/ImageryLayerCollection.js, line 44

layerMoved :Event

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.

Default Value: Event()

Source: Scene/ImageryLayerCollection.js, line 60

layerRemoved :Event

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.

Default Value: Event()

Source: Scene/ImageryLayerCollection.js, line 52

layerShownOrHidden :Event

An event that is raised when a layer is shown or hidden by setting the ImageryLayer#show 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.

Default Value: Event()

Source: Scene/ImageryLayerCollection.js, line 71

length :Number

Gets the number of layers in this collection.

Source: Scene/ImageryLayerCollection.js, line 80

Methods

add(layer, index)

Adds a layer to the collection.

Name	Type	Description
layer	ImageryLayer	the layer to add.
index	Number	optional the index to add the layer at. If omitted, the layer will added on top of all existing layers.

Throws:

• DeveloperError : index, if supplied, must be greater than or equal to zero and less than or equal to the number of the layers.

Source: Scene/ImageryLayerCollection.js, line 96

addImageryProvider(imageryProvider, index) → ImageryLayer

Creates a new layer using the given ImageryProvider and adds it to the collection.

Name	Type	Description
imageryProvider	ImageryProvider	the imagery provider to create a new layer for.
index	Number	optional the index to add the layer at. If omitted, the layer will added on top of all existing layers.

Returns:

The newly created layer.

Source: Scene/ImageryLayerCollection.js, line 131

contains(layer) → Boolean

Checks to see if the collection contains a given layer.

Name	Type	Description
layer	ImageryLayer	the layer to check for.

Returns:

true if the collection contains the layer, false otherwise.

Source: Scene/ImageryLayerCollection.js, line 200

destroy() → undefined

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.

Once this object is destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception. Therefore, assign the return value (undefined) to the object as done in the example.

Returns:

Throws:

• DeveloperError : This object was destroyed, i.e., destroy() was called.

Example:

layerCollection = layerCollection && layerCollection.destroy();

See:

• ImageryLayerCollection#isDestroyed

Source: Scene/ImageryLayerCollection.js, line 474

get(index)

Gets a layer by index from the collection.

Name	Type	Description
index	Number	the index to retrieve.

Throws:

• DeveloperError : This object was destroyed, i.e., destroy() was called.

Source: Scene/ImageryLayerCollection.js, line 222

indexOf(layer) → Number

Determines the index of a given layer in the collection.

Name	Type	Description
layer	ImageryLayer	The layer to find the index of.

Returns:

The index of the layer in the collection, or -1 if the layer does not exist in the collection.

Source: Scene/ImageryLayerCollection.js, line 211

isDestroyed() → Boolean

Returns true if this object was destroyed; otherwise, false.

If this object was destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception.

Returns:

true if this object was destroyed; otherwise, false.

See:

• ImageryLayerCollection#destroy

Source: Scene/ImageryLayerCollection.js, line 452

lower(layer)

Lowers a layer down one position in the collection.

Name	Type	Description
layer	ImageryLayer	the layer to move.

Throws:

• DeveloperError : layer is not in this collection.
• DeveloperError : This object was destroyed, i.e., destroy() was called.

Source: Scene/ImageryLayerCollection.js, line 289

lowerToBottom(layer)

Lowers a layer to the bottom of the collection.

Name	Type	Description
layer	ImageryLayer	the layer to move.

Throws:

• DeveloperError : layer is not in this collection.
• DeveloperError : This object was destroyed, i.e., destroy() was called.

Source: Scene/ImageryLayerCollection.js, line 323

pickImageryLayerFeatures(ray, scene) → Promise|Array.<ImageryLayerFeatureInfo>

Asynchronously determines the imagery layer features that are intersected by a pick ray. The intersected imagery layer features are found by invoking ImageryProvider#pickFeatures for each imagery layer tile intersected by the pick ray. To compute a pick ray from a location on the screen, use Camera.getPickRay.

Name	Type	Description
ray	Ray	The ray to test for intersection.
scene	Scene	The scene.

Returns:

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 ImageryProvider#pickFeatures or because the pick ray does not intersect the surface), this function will return undefined.

Example:

var pickRay = viewer.camera.getPickRay(windowPosition);
var 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);
            }
        });
    });
}

Source: Scene/ImageryLayerCollection.js, line 365

raise(layer)

Raises a layer up one position in the collection.

Name	Type	Description
layer	ImageryLayer	the layer to move.

Throws:

• DeveloperError : layer is not in this collection.
• DeveloperError : This object was destroyed, i.e., destroy() was called.

Source: Scene/ImageryLayerCollection.js, line 276

raiseToTop(layer)

Raises a layer to the top of the collection.

Name	Type	Description
layer	ImageryLayer	the layer to move.

Throws:

• DeveloperError : layer is not in this collection.
• DeveloperError : This object was destroyed, i.e., destroy() was called.

Source: Scene/ImageryLayerCollection.js, line 302

remove(layer, destroy) → Boolean

Removes a layer from this collection, if present.

Name	Type	Default	Description
layer	ImageryLayer		The layer to remove.
destroy	Boolean	true	optional whether to destroy the layers in addition to removing them.

Returns:

true if the layer was in the collection and was removed, false if the layer was not in the collection.

Source: Scene/ImageryLayerCollection.js, line 151

removeAll(destroy)

Removes all layers from this collection.

Name	Type	Default	Description
destroy	Boolean	true	optional whether to destroy the layers in addition to removing them.

Source: Scene/ImageryLayerCollection.js, line 177