InfoWindow class
google.maps
. InfoWindow
class
An overlay that looks like a bubble and is often connected to a marker.
This class extends MVCObject
.
Access by calling const {InfoWindow} = await google.maps.importLibrary("maps")
or const {InfoWindow} = await google.maps.importLibrary("streetView")
.
See Libraries in the Maps JavaScript API
.
Constructor
InfoWindow([opts])
-
opts
:InfoWindowOptions optional
Properties |
|
---|---|
isOpen
|
Type:
boolean
Checks if the InfoWindow is open.
|
Methods
close()
focus()
InfoWindow
. You may wish to consider using this method along with a visible
event to make sure that InfoWindow
is visible before setting focus on it. An InfoWindow
that is not visible cannot be focused.getHeaderContent()
string| Element
| Text
|null|undefined
The header content of this InfoWindow. See InfoWindowOptions.headerContent
.getHeaderDisabled()
boolean|undefined
Whether the whole header row is disabled or not. See InfoWindowOptions.headerDisabled
.getPosition()
LatLng
|null|undefined
The LatLng position of this InfoWindow.getZIndex()
number
The zIndex of this InfoWindow.open([options, anchor])
-
options
:InfoWindowOpenOptions | Map | StreetViewPanorama optional
Either an InfoWindowOpenOptions object (recommended) or the map|panorama on which to render this InfoWindow. -
anchor
:MVCObject | AdvancedMarkerElement 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).
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
.setHeaderContent([headerContent])
-
headerContent
:string| Element | Text optional
The header content to be displayed by this InfoWindow. SeeInfoWindowOptions.headerContent
.
setHeaderDisabled([headerDisabled])
-
headerDisabled
:boolean optional
Specifies whether to disable the whole header row. SeeInfoWindowOptions.headerDisabled
.
setPosition([position])
-
position
:LatLng | LatLngLiteral optional
The LatLng position at which to display this InfoWindow.
setZIndex(zIndex)
-
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.
Events |
|
---|---|
close
|
function()
Arguments: None
This event is fired whenever the
InfoWindow
closes. For example, this could be from calling the InfoWindow.close
method, pressing the escape key to close the InfoWindow, or clicking the close button or moving the InfoWindow to another map. |
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. |
headercontent_changed
|
function()
Arguments: None
This event is fired when the headerContent property changes.
|
headerdisabled_changed
|
function()
Arguments: None
This event is fired when the headerDisabled property changes.
|
position_changed
|
function()
Arguments: None
This event is fired when the position property changes.
|
visible
|
function()
Arguments: None
This event is fired when the
InfoWindow
is fully visible. This event is not fired when InfoWindow
is panned off and then back on screen. |
zindex_changed
|
function()
Arguments: None
|
InfoWindowOptions interface
google.maps
. InfoWindowOptions
interface
InfoWindowOptions object used to define the properties that can be set on a InfoWindow.
Properties |
|
---|---|
ariaLabel
optional
|
Type:
string optional
AriaLabel to assign to the InfoWindow.
|
content
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
Default:
false
Disable panning the map to make the InfoWindow fully visible when it opens.
|
headerContent
optional
|
The content to display in the InfoWindow header row. This can be an HTML element, or a string of plain text. The InfoWindow will be sized according to the content. To set an explicit size for the header content, set headerContent to be a HTML element with that size.
|
headerDisabled
optional
|
Type:
boolean optional
Disables the whole header row in the InfoWindow. When set to true, the header will be removed so that the header content and the close button will be hidden.
|
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
Properties |
|
---|---|
anchor
optional
|
Type:
MVCObject
| AdvancedMarkerElement
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. |