GroundOverlay 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.
A map overlay that binds an image to a bounding box area on the map.
Constructor
GroundOverlay(options: GroundOverlayOptions)
Properties
| Name | Type | Description |
|---|---|---|
| metadata | object | Optional property to store any additional metadata for this ground overlay. |
Methods
| Name | Return Type | Description |
|---|---|---|
getBackgroundColor() |
string or Color | Gets the background color of the ground overlay. |
getBounds() |
LocationRect | Gets the bounding box that the ground overlay is bounded to. |
getImageUrl() |
string | Gets the url to the gorund overlay image. |
getOpacity() |
number | Gets the opacity of the ground overlay. |
getMap() |
Map | Gets the map that this overlay is attached to. |
getRotation() |
number | Gets the rotation of the ground overlay. |
getVisible() |
boolean | Gets a boolean indicating if the ground overlay is visible or not. |
| setOptions(options: GroundOverlayOptions) | Sets the options used to render the ground overlay. | |
setVisible(visible: boolean) |
Sets the visibility of the Ground Overlay. |