Adds the given listener function to the given event name. Returns an
identifier for this listener that can be used with
google.maps.event.removeListener
.
Binds a View to a Model.
Implement this method to draw or update the overlay. Use the position from projection.fromLatLngToDivPixel() to correctly position the overlay relative to the MapPanes. This method is called after onAdd(), and is called on change of zoom or center. It is not recommended to do computationally expensive work in this method.
Gets a value.
Returns the panes in which this OverlayView can be rendered. The panes
are not initialized until onAdd
is called by the API.
Returns the MapCanvasProjection
object associated with this
OverlayView
. The projection is not initialized until
onAdd
is called by the API.
Notify all observers of a change on this property. This notifies both objects that are bound to the object's property as well as the object that it is bound to.
Implement this method to initialize the overlay DOM elements. This method is called once after setMap() is called with a valid map. At this point, panes and projection will have been initialized.
Implement this method to remove your elements from the DOM. This method is called once following a call to setMap(null).
Sets a value.
Adds the overlay to the map or panorama.
The map or panorama. If null
, the layer will be
removed.
Sets a collection of key-value pairs.
Removes a binding. Unbinding will set the unbound property to the current value. The object will not be notified, as the value has not changed.
Removes all bindings.
Stops click, tap, drag, and wheel events on the element from bubbling up to the map. Use this to prevent map dragging and zooming, as well as map "click" events.
Stops click or tap on the element from bubbling up to the map. Use this to prevent the map from triggering "click" events.
Generated using TypeDoc
You can implement this class if you want to display custom types of overlay objects on the map.
Inherit from this class by setting your overlay's prototype:
MyOverlay.prototype = new google.maps.OverlayView();
. TheOverlayView
constructor is guaranteed to be an empty function.You must implement three methods:
onAdd()
,draw()
, andonRemove()
.onAdd()
method, you should create DOM objects and append them as children of the panes.draw()
method, you should position these elements.onRemove()
method, you should remove the objects from the DOM.setMap()
with a validMap
object to trigger the call to theonAdd()
method andsetMap(null)
in order to trigger theonRemove()
method. ThesetMap()
method can be called at the time of construction or at any point afterward when the overlay should be re-shown after removing. Thedraw()
method will then be called whenever a map property changes that could change the position of the element, such as zoom, center, or map type.Access by calling
const {OverlayView} = await google.maps.importLibrary("maps")
orconst {OverlayView} = await google.maps.importLibrary("streetView")
. See https://developers.google.com/maps/documentation/javascript/libraries.