Options
All
  • Public
  • Public/Protected
  • All
Menu

InfoWindowOptions object used to define the properties that can be set on a InfoWindow.

see

Maps JavaScript API

see

{@link InfoWindow#setOptions}

Hierarchy

  • InfoWindowOptions

Index

Properties

Optional content

content: undefined | string | Node

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.

see

Maps JavaScript API

see

{@link InfoWindow#getContent}

see

{@link InfoWindow#setContent}

Optional disableAutoPan

disableAutoPan: undefined | boolean

Disable auto-pan on open. By default, the InfoWindow will pan the map so that it is fully visible when it opens.

see

Maps JavaScript API

Optional maxWidth

maxWidth: undefined | number

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, {@link InfoWindow#setOptions setOptions}, and then open.

see

Maps JavaScript API

Optional pixelOffset

pixelOffset: undefined | Size

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 {@link MarkerOptions#anchorPoint anchorPoint} property.

see

Maps JavaScript API

Optional position

position: undefined | LatLng | LatLngLiteral

The LatLng at which to display this InfoWindow. If the InfoWindow is opened with an anchor, the anchor's position will be used instead.

see

Maps JavaScript API

see

{@link InfoWindow#getPosition}

see

{@link InfoWindow#setPosition}

Optional zIndex

zIndex: undefined | number

All InfoWindow are displayed on the map in order of their zIndex, with higher values displaying in front of InfoWindow with lower values. By default, InfoWindow are displayed according to their latitude, with InfoWindow of lower latitudes appearing in front of InfoWindow at higher latitudes. InfoWindow are always displayed in front of markers.

see

Maps JavaScript API

see

{@link InfoWindow#getZIndex}

see

{@link InfoWindow#setZIndex}

Generated using TypeDoc