com.gwidgets.api.leaflet.options

Class MarkerOptions

java.lang.Object

com.gwidgets.api.leaflet.options.MarkerOptions

@JsType(isNative=true,
        namespace="<global>",
        name="Object")
public class MarkerOptions
extends Object

The Class MarkerOptions.

Author:

Zakaria Amine

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MarkerOptions.Builder The Class Builder.

Method Summary

Modifier and Type	Method and Description
String	getAlt() Gets the text for the alt attribute of the icon image (useful for accessibility).
String	getAttribution()
boolean	getClickable() Gets whether the marker will not emit mouse events and will act as a part of the underlying map default true
boolean	getDraggable() Gets Whether the marker is draggable with mouse/touch or not.
Icon	getIcon() Gets Icon class to use for rendering the marker.
boolean	getInteractive()
boolean	getKeyboard() Gets Whether the marker can be tabbed to with a keyboard and clicked by pressing enter.
double	getOpacity() Gets The opacity of the marker.
String	getPane()
double	getRiseOffset() Gets The z-index offset used for the riseOnHover feature.
boolean	getRiseOnHover() Gets whether the marker will get on top of others when you hover the mouse over it.
String	getTitle() Gets Text for the browser tooltip that appear on marker hover (no tooltip by default).
double	getzIndexOffset() Gets z index offset default 0

Methods inherited from class java.lang.Object

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

Method Detail

getIcon

@JsOverlay
public final Icon getIcon()

Gets Icon class to use for rendering the marker. Set to new L.Icon.Default() by default.

Returns:

the icon

getClickable

@JsOverlay
public final boolean getClickable()

Gets whether the marker will not emit mouse events and will act as a part of the underlying map
default true

Returns:

the clickable

getDraggable

@JsOverlay
public final boolean getDraggable()

Gets Whether the marker is draggable with mouse/touch or not.
default false

Returns:

the draggable

getKeyboard

@JsOverlay
public final boolean getKeyboard()

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

Returns:

the keyboard

getTitle

@JsOverlay
public final String getTitle()

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

Returns:

the title

getAlt

@JsOverlay
public final String getAlt()

Gets the text for the alt attribute of the icon image (useful for accessibility).

Returns:

the title

getzIndexOffset

@JsOverlay
public final double getzIndexOffset()

Gets z index offset
default 0

Returns:

the z index offset

getOpacity

@JsOverlay
public final double getOpacity()

Gets The opacity of the marker.
default 1.0

Returns:

the opacity

getRiseOnHover

@JsOverlay
public final boolean getRiseOnHover()

Gets whether the marker will get on top of others when you hover the mouse over it.
default false

Returns:

the rise on hover

getRiseOffset

@JsOverlay
public final double getRiseOffset()

Gets The z-index offset used for the riseOnHover feature.
default 250

Returns:

the rise offset

getPane

@JsOverlay
public final String getPane()

getAttribution

@JsOverlay
public final String getAttribution()

getInteractive

@JsOverlay
public final boolean getInteractive()