KmlScreenOverlay Class
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. |