Share via

KmlScreenOverlay Class

  • 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.

Overlays HTML elements within the map container that are above the map.

Constructor

KmlScreenOverlay(htmlElement?: string or HTMLElement, options?: KmlScreenOverlayOptions)

Properties

Name Type Description
metadata object Optional property to store any additional metadata for this overlay.

Methods

Name Return Type Description
clear() Removes all the data in the layer.
getBelowNavigationBar() boolean Gets a boolean indicating if the screen overlay is displayed above or below the navigation bar.
getHtmlElement() HTMLElement Returns the data source used by the layer.
getMap() Map Returns the map that this overlay is attached to.
getVisible() boolean Gets a boolean indicating if the screen overlay is visible or not.
setHtmlElement(htmlElement: string *or* HTMLElement) Updates the html element of this screen overlay.
setOptions(options: KmlScreenOverlayOptions) Sets the options to customize the screen overlay.
setVisible(value: boolean) Sets whether the layer is visible or not.