net.java.html.leaflet

Class IconOptions

java.lang.Object

net.java.html.leaflet.IconOptions

public final class IconOptions
extends Object

Options for configuring a Icon.

Constructor Summary

Constructors

Constructor and Description
IconOptions(String url) Creates an Icon options instance

Method Summary

Modifier and Type	Method and Description
IconOptions	setClassName(String className) Sets className option
IconOptions	setIconAnchor(Point anchor) Sets icon anchor option
IconOptions	setIconRetinaUrl(String url) Sets icon retina url option
IconOptions	setIconSize(Point size) Sets icon size option
IconOptions	setPopupAnchor(Point anchor) Sets popup anchor option
IconOptions	setShadowAnchor(Point anchor) Sets shadow anchor option
IconOptions	setShadowRetinaUrl(String url) Sets shadow retina url option
IconOptions	setShadowSize(Point size) Sets shadow size option
IconOptions	setShadowUrl(String url) Sets shadow url option

Methods inherited from class java.lang.Object

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

Constructor Detail

IconOptions

public IconOptions(String url)

Creates an Icon options instance

Parameters:

url - The URL to the icon image (absolute or relative to your script path).

Method Detail

setIconRetinaUrl

public IconOptions setIconRetinaUrl(String url)

Sets icon retina url option

Parameters:

url - The URL to a retina sized version of the icon image (absolute or relative to your script path). Used for Retina screen devices.

Returns:

updated options

setIconSize

public IconOptions setIconSize(Point size)

Sets icon size option

Parameters:

size - Size of the icon image in pixels.

Returns:

updated options

setIconAnchor

public IconOptions setIconAnchor(Point anchor)

Sets icon anchor option

Parameters:

anchor - The coordinates of the "tip" of the icon (relative to its top left corner). The icon will be aligned so that this point is at the marker's geographical location. Centered by default if size is specified, also can be set in CSS with negative margins.

Returns:

updated options

setShadowUrl

public IconOptions setShadowUrl(String url)

Sets shadow url option

Parameters:

url - The URL to the icon shadow image. If not specified, no shadow image will be created.

Returns:

updated options

setShadowRetinaUrl

public IconOptions setShadowRetinaUrl(String url)

Sets shadow retina url option

Parameters:

url - The URL to the retina sized version of the icon shadow image. If not specified, no shadow image will be created. Used for Retina screen devices.

Returns:

updated options

setShadowSize

public IconOptions setShadowSize(Point size)

Sets shadow size option

Parameters:

size - Size of the shadow image in pixels.

Returns:

updated options

setShadowAnchor

public IconOptions setShadowAnchor(Point anchor)

Sets shadow anchor option

Parameters:

anchor - The coordinates of the "tip" of the shadow (relative to its top left corner) (the same as iconAnchor if not specified).

Returns:

updated options

setPopupAnchor

public IconOptions setPopupAnchor(Point anchor)

Sets popup anchor option

Parameters:

anchor - The coordinates of the point from which popups will "open", relative to the icon anchor.

Returns:

updated options

setClassName

public IconOptions setClassName(String className)

Sets className option

Parameters:

className - A custom class name to assign to both icon and shadow images. Empty by default.

Returns:

updated options