ImageryLayerCollection

有序的圖像層集合。

new ImageryLayerCollection()

Members

layerAdded : Event

將層添加到集合時引發的事件。事件處理程序將傳遞給添加的層和添加該層的索引。

Default Value: Event()

layerMoved : Event

層更改集合中的位置時引發的事件。事件處理程序將傳遞給已移動的層、移動后的新索引以及移動前的舊索引。

Default Value: Event()

layerRemoved : Event

從集合中移除層時引發的事件。事件處理程序將傳遞給已刪除的層和從中刪除該層的索引。

Default Value: Event()

layerShownOrHidden : Event

通過設置ImageryLayer#show屬性顯示或隱藏層時引發的事件。事件處理程序將傳遞一個對此層的引用、集合中層的索引，以及一個標志，如果層現在顯示，則為真；如果層現在隱藏，則為假。

Default Value: Event()

length : Number

獲取此集合中的層數。

Methods

add(layer, index)

向集合中添加層。

Parameters:

layer (ImageryLayer) 要添加的層。

index (Number) 添加層的索引。如果省略，該層將添加到所有現有層的頂部。

Throws

DeveloperError : 索引（如果提供）必須大于或等于零且小于或等于層數。

addImageryProvider(imageryProvider, index) → {ImageryLayer}

使用給定的ImageryProvider創建新層并將其添加到集合中。

Parameters:

imageryProvider (ImageryProvider) 要為其創建新層的圖像提供商。

index (Number) 添加層的索引。如果省略，該層將添加到所有現有層的頂部。

contains(layer) → {Boolean}

檢查集合是否包含給定層。

Parameters:

layer (ImageryLayer) 要檢查的層。

destroy()

銷毀此集合中所有層持有的WebGL資源。顯式銷毀此對象允許確定地釋放WebGL資源，而不是依賴垃圾收集器。

此對象銷毀后，不應使用它；調用除isDestroyed以外的任何函數都將導致DeveloperError異常。因此，將返回值（undefined）賦給對象，如示例中所述。

Example

layerCollection = layerCollection && layerCollection.destroy();

Throws

DeveloperError : 此對象已被銷毀，即調用destroy（）。

See:

ImageryLayerCollection#isDestroyed

get(index) → {ImageryLayer}

從集合中按索引獲取層。

Parameters:

index (Number) 要檢索的索引。

indexOf(layer) → {Number}

確定集合中給定層的索引。

Parameters:

layer (ImageryLayer) 要查找的索引的層。

isDestroyed() → {Boolean}

如果此對象被破壞，則返回true；否則返回false。

如果此對象被破壞，則不應使用它；調用除isDestroyed以外的任何函數將導致DeveloperError異常。

See:

ImageryLayerCollection#destroy

lower(layer)

在集合中將層降低一個位置。

Parameters:

layer (ImageryLayer) 要移動的層。

Throws

DeveloperError : 層不在此集合中。
DeveloperError : 此對象已被銷毀，即調用destroy（）。

lowerToBottom(layer)

將層降低到集合的底部。

Parameters:

layer (ImageryLayer) 要移動的層。

Throws

DeveloperError : 層不在此集合中。
DeveloperError : 此對象已被銷毀，即調用destroy（）。

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

異步確定與拾取光線相交的圖像層特征。通過調用ImageryProvider#pickFeatures為每個圖像層（與拾取光線相交）的瓦片，可以找到相交的圖像層特征。要從屏幕上的某個位置計算拾取光線，請使用Camera.getPickRay。

Parameters:

ray (Ray) 要測試交叉點的光線。

scene (Scene) 現場。

Example

var pickRay = viewer.camera.getPickRay(windowPosition);
var featuresPromise = viewer.imageryLayers.pickImageryLayerFeatures(pickRay, viewer.scene);
if (!bmgl.defined(featuresPromise)) {
    console.log('No features picked.');
} else {
    bmgl.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);
        }
    });
}

raise(layer)

在集合中向上提升一個層。

Parameters:

layer (ImageryLayer) 要移動的層。

Throws

DeveloperError : 層不在此集合中。
DeveloperError : 此對象已被銷毀，即調用destroy（）。

raiseToTop(layer)

將層提升到集合的頂部。

Parameters:

layer (ImageryLayer) 要移動的層。

Throws

DeveloperError : 層不在此集合中。
DeveloperError : 此對象已被銷毀，即調用destroy（）。

remove(layer, destroy) → {Boolean}

刪除此集合中的層（如果存在）。

Parameters:

layer (ImageryLayer) 要刪除的層。

destroy (Boolean) (default true) 是否在移除層的同時銷毀層。

removeAll(destroy)

刪除此集合中的所有層。

Parameters:

destroy (Boolean) (default true) 是否在移除層的同時銷毀層。