Info Window

InfoWindow class

google.maps.InfoWindow class

An overlay that looks like a bubble and is often connected to a marker.

This class extends MVCObject.

InfoWindow
InfoWindow([opts])
Parameters: 
Creates an info window with the given options. An InfoWindow can be placed on a map at a particular position or above a marker, depending on what is specified in the options. Unless auto-pan is disabled, an InfoWindow will pan the map to make itself visible when it is opened. After constructing an InfoWindow, you must call open to display it on the map. The user can click the close button on the InfoWindow to remove it from the map, or the developer can call close() for the same effect.
close
close()
Parameters:  None
Return Value:  None
Closes this InfoWindow by removing it from the DOM structure.
getContent
getContent()
Parameters:  None
Return Value:  string|Element|null|Text|undefined The content of this InfoWindow. The same as what was previously set as the content.
getPosition
getPosition()
Parameters:  None
Return Value:  LatLng|null|undefined The LatLng position of this InfoWindow.
getZIndex
getZIndex()
Parameters:  None
Return Value:  number The zIndex of this InfoWindow.
open
open([options, anchor])
Parameters: 
  • options:  InfoWindowOpenOptions|Map|StreetViewPanorama optional Either an InfoWindowOpenOptions object (recommended) or the map|panorama on which to render this InfoWindow.
  • anchor:  MVCObject optional The anchor to which this InfoWindow will be positioned. If the anchor is non-null, the InfoWindow will be positioned at the top-center of the anchor. The InfoWindow will be rendered on the same map or panorama as the anchor (when available).
Return Value:  None
Opens this InfoWindow on the given map. Optionally, an InfoWindow can be associated with an anchor. In the core API, the only anchor is the Marker class. However, an anchor can be any MVCObject that exposes a LatLng position property and optionally a Point anchorPoint property for calculating the pixelOffset (see InfoWindowOptions). The anchorPoint is the offset from the anchor's position to the tip of the InfoWindow. It is recommended to use the InfoWindowOpenOptions interface as the single argument for this method. To prevent changing browser focus on open, set InfoWindowOpenOptions.shouldFocus to false.
setContent
setContent([content])
Parameters: 
  • content:  string|Element|Text optional The content to be displayed by this InfoWindow.
Return Value:  None
setOptions
setOptions([options])
Parameters: 
Return Value:  None
setPosition
setPosition([position])
Parameters: 
  • position:  LatLng|LatLngLiteral optional The LatLng position at which to display this InfoWindow.
Return Value:  None
setZIndex
setZIndex(zIndex)
Parameters: 
  • zIndex:  number The z-index for this InfoWindow. An InfoWindow with a greater z-index will be displayed in front of all other InfoWindows with a lower z-index.
Return Value:  None
Inherited: addListener, bindTo, get, notify, set, setValues, unbind, unbindAll
closeclick
function()
Arguments:  None
This event is fired when the close button was clicked.
content_changed
function()
Arguments:  None
This event is fired when the content property changes.
domready
function()
Arguments:  None
This event is fired when the <div> containing the InfoWindow's content is attached to the DOM. You may wish to monitor this event if you are building out your info window content dynamically.
position_changed
function()
Arguments:  None
This event is fired when the position property changes.
zindex_changed
function()
Arguments:  None
This event is fired when the InfoWindow's zIndex changes.

InfoWindowOptions interface

google.maps.InfoWindowOptions interface

InfoWindowOptions object used to define the properties that can be set on a InfoWindow.
content optional
Type:  string|Element|Text optional
Content to display in the InfoWindow. This can be an HTML element, a plain-text string, or a string containing HTML. The InfoWindow will be sized according to the content. To set an explicit size for the content, set content to be a HTML element with that size.
disableAutoPan optional
Type:  boolean optional
Disable auto-pan on open. By default, the InfoWindow will pan the map so that it is fully visible when it opens.
maxWidth optional
Type:  number optional
Maximum width of the InfoWindow, regardless of content's width. This value is only considered if it is set before a call to open(). To change the maximum width when changing content, call close(), setOptions(), and then open().
minWidth optional
Type:  number optional
Minimum width of the InfoWindow, regardless of the content's width. When using this property, it is strongly recommended to set the minWidth to a value less than the width of the map (in pixels). This value is only considered if it is set before a call to open(). To change the minimum width when changing content, call close(), setOptions(), and then open().
pixelOffset optional
Type:  Size optional
The offset, in pixels, of the tip of the info window from the point on the map at whose geographical coordinates the info window is anchored. If an InfoWindow is opened with an anchor, the pixelOffset will be calculated from the anchor's anchorPoint property.
position optional
Type:  LatLng|LatLngLiteral optional
The LatLng at which to display this InfoWindow. If the InfoWindow is opened with an anchor, the anchor's position will be used instead.
zIndex optional
Type:  number optional
All InfoWindows are displayed on the map in order of their zIndex, with higher values displaying in front of InfoWindows with lower values. By default, InfoWindows are displayed according to their latitude, with InfoWindows of lower latitudes appearing in front of InfoWindows at higher latitudes. InfoWindows are always displayed in front of markers.

InfoWindowOpenOptions interface

google.maps.InfoWindowOpenOptions interface

Options for opening an InfoWindow
anchor optional
Type:  MVCObject optional
The anchor to which this InfoWindow will be positioned. If the anchor is non-null, the InfoWindow will be positioned at the top-center of the anchor. The InfoWindow will be rendered on the same map or panorama as the anchor (when available).
map optional
Type:  Map|StreetViewPanorama optional
The map or panorama on which to render this InfoWindow.
shouldFocus optional
Type:  boolean optional
Whether or not focus should be moved inside the InfoWindow when it is opened. When this property is unset or when it is set to null or undefined, a heuristic is used to decide whether or not focus should be moved. It is recommended to explicitly set this property to fit your needs as the heuristic is subject to change and may not work well for all use cases.