Share via

TileLayerOptions Object

  • Article

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 following is a list of option properties that can be used with a TileLayer.

Name Type Description
downloadTimeout number The number of milliseconds allowed for the tile layer image download. If the timeout occurs before the image is fully downloaded, the map control considers the download a failure. The default value is 10000.
enableCors boolean Allow retrieving data from CORS supported server.
mercator TileSource The tile source for the tile layer. Can only be set when TileLayer is initially created.
opacity number The opacity of the tile layer, defined by a number between 0 (not visible) and 1.
useCredentialsForCORS boolean Specifies that CORS should be made with the "use-credentials" flag instead of "anonymous".
visible boolean A boolean indicating whether to show or hide the tile layer. The default value is true. A value of false indicates that the tile layer is hidden, although it is still an entity on the map.
zIndex number The z-index of the tile layer. See also: zIndexing in Bing Maps V8