TileLayer 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.
Represents a tile layer that can be overlaid on top of the map.
Constructor
TileLayer(options: TileLayerOptions)
Properties
| Name | Type | Description |
|---|---|---|
metadata |
object | Optional property to store any additional metadata for this layer. |
Methods
The TileLayer class has the following methods.
| Name | Return Type | Description |
|---|---|---|
getOpacity() |
number | Returns the opacity of the tile layer, defined as a double between 0 (not visible) and 1. |
getTileSource() |
TileSource | Returns the tile source of the tile layer. |
getVisible() |
boolean | Gets a boolean that indicates if the tile layer is visible or not. |
getZIndex() |
number | Gets the zIndex of the tile layer. |
setOpacity(opacity: number) |
Sets the opacity of the tile layer. Value must be a number between 0 and 1. | |
| setOptions(opt: TileLayerOptions) | Sets options for the tile layer. Note that the TileSource can only be set when the tile layer is created and cannot be updated. | |
setVisible(show: boolean) |
Sets the visibility of the tile layer. | |
setZIndex(idx: number) |
Sets the zIndex of the tile layer. |