CustomOverlayOptions Object

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 when initializing a CustomOverlay.

Properties

Name	Type	Description
beneathLabels	boolean	Specifies if the custom overlay should be rendered above or below the label layer of the map. When above, elements in the overlay can be clickable. Default: true
drawOrder	number	In case of multiple overlay, draw order defines the order of overlay in relation to labels/Poi's. drawOrder can be between -100 to -1 to display the overlay below the Labels/Pois or 1 to 100 to display the overlay above it. If this option is set, then beneathLabels is ignored. Default: -1