com.gwidgets.api.leaflet.options

Class MarkerOptions.Builder

java.lang.Object

com.gwidgets.api.leaflet.options.MarkerOptions.Builder

Enclosing class:

MarkerOptions

public static class MarkerOptions.Builder
extends Object

The Class Builder.

Constructor Summary

Constructors

Constructor and Description
Builder() Instantiates a new builder.

Method Summary

Modifier and Type	Method and Description
MarkerOptions.Builder	alt(String alt) Text for the alt attribute of the icon image (useful for accessibility).
MarkerOptions.Builder	attribution(String attribution)
MarkerOptions	build() Builds the MarkerOptions new instace
MarkerOptions.Builder	clickable(Boolean clickable) If false, the marker will not emit mouse events and will act as a part of the underlying map.
MarkerOptions.Builder	draggable(Boolean draggable) Whether the marker is draggable with mouse/touch or not.
MarkerOptions.Builder	icon(Icon icon) Icon class to use for rendering the marker.
MarkerOptions.Builder	interactive(Boolean interactive)
MarkerOptions.Builder	keyboard(Boolean keyboard) Whether the marker can be tabbed to with a keyboard and clicked by pressing enter.
MarkerOptions.Builder	opacity(Double opacity) The opacity of the marker.
MarkerOptions.Builder	pane(String pane)
MarkerOptions.Builder	riseOffset(Double riseOffset) The z-index offset used for the riseOnHover feature.
MarkerOptions.Builder	riseOnHover(Boolean riseOnHover) If true, the marker will get on top of others when you hover the mouse over it.
MarkerOptions.Builder	title(String title) Text for the browser tooltip that appear on marker hover (no tooltip by default).
MarkerOptions.Builder	zIndexOffset(Double zIndexOffset) By default, zIndex for the marker image is set automatically based on its latitude.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Instantiates a new builder.

Method Detail

icon

public MarkerOptions.Builder icon(Icon icon)

Icon class to use for rendering the marker. See Icon documentation for details on how to customize the marker icon. Set to new L.Icon.Default() by default

Parameters:

icon - the icon

Returns:

the builder

clickable

public MarkerOptions.Builder clickable(Boolean clickable)

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

Parameters:

clickable - the clickable

Returns:

the builder

draggable

public MarkerOptions.Builder draggable(Boolean draggable)

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

Parameters:

draggable - the draggable

Returns:

the builder

keyboard

public MarkerOptions.Builder keyboard(Boolean keyboard)

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

Parameters:

keyboard - the keyboard

Returns:

the builder

title

public MarkerOptions.Builder title(String title)

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

Parameters:

title - the title

Returns:

the builder

alt

public MarkerOptions.Builder alt(String alt)

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

Parameters:

alt - the alt

Returns:

the builder

zIndexOffset

public MarkerOptions.Builder zIndexOffset(Double zIndexOffset)

By default, zIndex for the marker image 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).
default 0

Parameters:

zIndexOffset - the z index offset

Returns:

the builder

opacity

public MarkerOptions.Builder opacity(Double opacity)

The opacity of the marker.
default 1.0

Parameters:

opacity - the opacity

Returns:

the builder

riseOnHover

public MarkerOptions.Builder riseOnHover(Boolean riseOnHover)

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

Parameters:

riseOnHover - the rise on hover

Returns:

the builder

riseOffset

public MarkerOptions.Builder riseOffset(Double riseOffset)

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

Parameters:

riseOffset - the rise offset

Returns:

the builder

pane

public MarkerOptions.Builder pane(String pane)

attribution

public MarkerOptions.Builder attribution(String attribution)

interactive

public MarkerOptions.Builder interactive(Boolean interactive)

build

public MarkerOptions build()

Builds the MarkerOptions new instace

Returns:

the marker options