Top Description Fields Constructors Methods
com.dlsc.gmapsfx.javascript.object

public Class InfoWindowOptions

extends JavascriptObject
Class Inheritance
Imports
com.dlsc.gmapsfx.javascript.JavascriptObject

Options for setting an InfoWindow on a Map. This class corresponds to google.maps.InfoWindowOptions" in the Google Maps JavaScript API.
Author
Rob Terpilowski

Field Summary

Inherited from com.dlsc.gmapsfx.javascript.JavascriptObject:
jsObjectobjectCounterpeerRegistryruntimevariableName

Constructor Summary

AccessConstructor and Description
public
InfoWindowOptions()

Default constructor

Method Summary

Modifier and TypeMethod and Description
public InfoWindowOptions

Returns:

this instance of the InfoWindowOptions
content
(String content)

Content to display in the InfoWindow.

public InfoWindowOptions

Returns:

this instance of the InfoWindowOptions
disableAutoPan
(boolean
true if it should be disabled
disabled
)

Disable auto-pan on open.

public InfoWindowOptions

Returns:

this instance of the InfoWindowOptions
maxWidth
(int
The max width
width
)

Maximum width of the infowindow, regardless of content's width.

public InfoWindowOptions

Returns:

this instance of the InfoWindowOptions
pixelOffset
(Size
The offset in pixels.
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.

public InfoWindowOptions

Returns:

this instance of the InfoWindowOptions
position
(LatLong
The position of the window
latlong
)

The LatLng at which to display this InfoWindow.

public InfoWindowOptions

Returns:

this instance of the InfoWindowOptions
zIndex
(int
The index to set this window to
index
)

All InfoWindows are displayed on the map in order of their zIndex, with higher values displaying in front of InfoWindows with lower values.

Inherited from com.dlsc.gmapsfx.javascript.JavascriptObject:
checkBooleancheckIntegercheckUndefinedgetJSObjectgetNextVariableNamegetPropertygetPropertygetVariableNameinvokeJavascriptinvokeJavascriptinvokeJavascriptReturnValueinvokeJavascriptReturnValueisMemberDefinedsetPropertysetPropertysetProperty

Constructor Detail

InfoWindowOptionsback to summary
public InfoWindowOptions()

Default constructor

Method Detail

contentback to summary
public InfoWindowOptions content(String content)

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.

Returns:InfoWindowOptions

this instance of the InfoWindowOptions

disableAutoPanback to summary
public InfoWindowOptions disableAutoPan(boolean disabled)

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

Parameters
disabled:boolean

true if it should be disabled

Returns:InfoWindowOptions

this instance of the InfoWindowOptions

maxWidthback to summary
public InfoWindowOptions maxWidth(int width)

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.

Parameters
width:int

The max width

Returns:InfoWindowOptions

this instance of the InfoWindowOptions

pixelOffsetback to summary
public InfoWindowOptions pixelOffset(Size 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 anchorPoint property.

Parameters
size:Size

The offset in pixels.

Returns:InfoWindowOptions

this instance of the InfoWindowOptions

positionback to summary
public InfoWindowOptions position(LatLong latlong)

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

Parameters
latlong:LatLong

The position of the window

Returns:InfoWindowOptions

this instance of the InfoWindowOptions

zIndexback to summary
public InfoWindowOptions zIndex(int index)

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.

Parameters
index:int

The index to set this window to

Returns:InfoWindowOptions

this instance of the InfoWindowOptions