LayerCollection Class

Note

Bing Maps Web Control SDK retirement

Bing Maps Web Control SDK is deprecated and will be retired. Free (Basic) account customers can continue to use Bing Maps Web Control SDK until June 30th, 2025. Enterprise account customers can continue to use Bing Maps Web Control SDK until June 30th, 2028. To avoid service disruptions, all implementations using Bing Maps Web Control SDK will need to be updated to use Azure Maps Web SDK by the retirement date that applies to your Bing Maps for Enterprise account type. For detailed migration guidance, see Migrate from Bing Maps Web Control SDK and Migrate Bing Maps Enterprise applications to Azure Maps with GitHub Copilot.

Azure Maps is Microsoft's next-generation maps and geospatial services for developers. Azure Maps has many of the same features as Bing Maps for Enterprise, and more. To get started with Azure Maps, create a free Azure subscription and an Azure Maps account. For more information about azure Maps, see Azure Maps Documentation. For migration guidance, see Bing Maps Migration Overview.

The layers property of the map is a LayerCollection object and contains all the layers that have been added to the map.

Note: This class extends the Array class and can be iterated over just like an array. The class is only exposed in the map.layers property. No other instance of this class can be created.

Properties

Name Type Description
length number The number of layers in the collection.

Methods

Name Return Type Description
clear() Removes all layers from the map.
indexOf(layer: ILayer) number Returns the index of a layer in the collection.
insert(layer: ILayer) Adds a layer to the map.
insertAll(layers: ILayer[]) Adds an array of layers to the map.
remove(layer: ILayer) Removes a layer from the map.
removeAt(idx: number) Removes a layer from the map at the specified index in the collection.