GroundOverlayOptions 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 options that specify how to render a ground overlay on the map.
| Name | Type | Description |
|---|---|---|
backgroundColor |
string or Color | A background color that fills the bounding box area beneath the ground overlay. Default: transparent |
beneathLabels |
boolean | Specifies if the ground overlay should be rendered above or below the label layer of the map. When above, mouse events for elements under the overlay will be blocked. Default: true This can only be set when creating the ground overlay and will not work with the setOptions function. |
bounds |
LocationRect | Required. The bounding box to anchor the ground overlay to. This is required when creating a ground overlay. |
imageUrl |
string | Required. The URL to the image to anchor to the map as a ground overlay. Tip: SVG’s can be used as ground overlays. This is required when creating a ground overlay. |
opacity |
number | The opacity of the ground overlay image. Decimal values between 0 and 1 are valid. Default: 1 |
rotation |
number | An angle in degrees to rotate the overlay in a clockwise direction where 0 = north, 90 = east, 180 = south, 270 = west. Default: 0 |
visible |
boolean | A boolean value indicating if the ground overlay is visible or not. Default: true |