net.java.html.leaflet

Class MarkerOptions

java.lang.Object

net.java.html.leaflet.MarkerOptions

public final class MarkerOptions
extends Object

Options for configuring a Marker.

Constructor Summary

Constructors

Constructor and Description
MarkerOptions() Creates a MarkerOptions object

Method Summary

Modifier and Type	Method and Description
MarkerOptions	setAlt(String alt) Sets alt attribute option
MarkerOptions	setClickable(boolean clickable) Sets clickable option
MarkerOptions	setDraggable(boolean draggable) Sets draggable option
MarkerOptions	setIcon(Icon icon) Sets icon option
MarkerOptions	setKeyboard(boolean keyboard) Sets keyboard option
MarkerOptions	setOpacity(double opacity) Sets opacity option
MarkerOptions	setRiseOffset(double riseOffset) Sets riseOffset option
MarkerOptions	setRiseOnHover(boolean riseOnHover) Sets riseOnHover option
MarkerOptions	setTitle(String title) Sets title option
MarkerOptions	setZIndexOffset(double zIndexOffset) Sets zIndexOffset option

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MarkerOptions

public MarkerOptions()

Creates a MarkerOptions object

Method Detail

setIcon

public MarkerOptions setIcon(Icon icon)

Sets icon option

Parameters:

icon - Icon class to use for rendering the marker.

Returns:

updated options

setClickable

public MarkerOptions setClickable(boolean clickable)

Sets clickable option

Parameters:

clickable - If false, the marker will not emit mouse events and will act as a part of the underlying map.

Returns:

updated options

setDraggable

public MarkerOptions setDraggable(boolean draggable)

Sets draggable option

Parameters:

draggable - Whether the marker is draggable with mouse/touch or not.

Returns:

updated options

setKeyboard

public MarkerOptions setKeyboard(boolean keyboard)

Sets keyboard option

Parameters:

keyboard - Whether the marker can be tabbed to with a keyboard and clicked by pressing enter.

Returns:

updated options

setTitle

public MarkerOptions setTitle(String title)

Sets title option

Parameters:

title - Text for the browser tooltip that appear on marker hover (no tooltip by default).

Returns:

updated options

setAlt

public MarkerOptions setAlt(String alt)

Sets alt attribute option

Parameters:

alt - Text for the alt attribute of the icon image (useful for accessibility).

Returns:

updated options

setZIndexOffset

public MarkerOptions setZIndexOffset(double zIndexOffset)

Sets zIndexOffset option

Parameters:

zIndexOffset - By default, marker images zIndex is set automatically based on its latitude. Use this option if you want to put the marker on top of all others (or below), specifying a high value like 1000 (or high negative value, respectively).

Returns:

updated options

setOpacity

public MarkerOptions setOpacity(double opacity)

Sets opacity option

Parameters:

opacity - The opacity of the marker.

Returns:

updated options

setRiseOnHover

public MarkerOptions setRiseOnHover(boolean riseOnHover)

Sets riseOnHover option

Parameters:

riseOnHover - If true, the marker will get on top of others when you hover the mouse over it.

Returns:

updated options

setRiseOffset

public MarkerOptions setRiseOffset(double riseOffset)

Sets riseOffset option

Parameters:

riseOffset - The z-index offset used for the riseOnHover feature.

Returns:

updated options