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 callingconst {InfoWindow} = await google.maps.importLibrary( "maps" )
orconst {InfoWindow} = await google.maps.importLibrary( "streetView" )
.SeeLibraries in the Maps JavaScript API.
Constructor | |
---|---|
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. |
Methods | |
---|---|
close |
close() Parameters:None
Return Value:None
Closes this InfoWindow by removing it from the DOM structure. |
focus |
focus() Parameters:None
Return Value:None
Sets focus on this InfoWindow .You may wish to consider using this method along with avisible event to make sure thatInfoWindow is visible before setting focus on it. AnInfoWindow that is not visible cannot be focused. |
getContent |
getContent() Parameters:None
|
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:
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 PointanchorPoint property for calculating thepixelOffset (see InfoWindowOptions). TheanchorPoint is the offset from the anchor's position to the tip of the InfoWindow. It is recommended to use theInfoWindowOpenOptions interface as the single argument for this method. To prevent changing browser focus on open, setInfoWindowOpenOptions.shouldFocus tofalse . |
setContent |
setContent([content]) Return Value:None
|
setOptions |
setOptions([options]) Parameters:
Return Value:None
|
setPosition |
setPosition([position]) Parameters:
Return Value:None
|
setZIndex |
setZIndex(zIndex) Parameters:
Return Value:None
|
Inherited:
addListener ,
bindTo ,
get ,
notify ,
set ,
setValues ,
unbind ,
unbindAll
|
Events | |
---|---|
close |
function() Arguments:None
This event is fired whenever the InfoWindow closes. For example, this could be from calling theInfoWindow.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 theInfoWindow '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 whenInfoWindow is panned off and then back on screen. |
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.
Properties | |
---|---|
ariaLabeloptional |
Type:
stringoptional AriaLabel to assign to the InfoWindow. |
contentoptional |
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. |
disableAutoPanoptional |
Type:
booleanoptional Default:
false Disable panning the map to make the InfoWindow fully visible when it opens. |
headerContentoptional |
The content to display in the InfoWindow header row. This can be an HTML element, or a string containing HTML. 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. |
headerDisabledoptional |
Type:
booleanoptional 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. |
maxWidthoptional |
Type:
numberoptional 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, callclose() ,setOptions() ,and thenopen() . |
minWidthoptional |
Type:
numberoptional 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 toopen() .To change the minimum width when changing content, callclose() ,setOptions() ,and thenopen() . |
pixelOffsetoptional |
Type:
Sizeoptional 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'sanchorPoint property. |
positionoptional |
Type:
LatLng|LatLngLiteraloptional The LatLng at which to display this InfoWindow. If the InfoWindow is opened with an anchor, the anchor's position will be used instead. |
zIndexoptional |
Type:
numberoptional 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 | |
---|---|
anchoroptional |
Type:
MVCObject|AdvancedMarkerElementoptional 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). |
mapoptional |
Type:
Map|StreetViewPanoramaoptional The map or panorama on which to render this InfoWindow. |
shouldFocusoptional |
Type:
booleanoptional 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 orundefined ,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. |