com.gwidgets.api.leaflet.options

Class IconOptions

java.lang.Object

com.gwidgets.api.leaflet.options.IconOptions

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

The Class IconOptions.

Author:

Zakaria Amine

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
String	getAttribution()
String	getClassName() Gets the class name assigned to both icon and shadow images.
Point	getIconAnchor() Gets the coordinates of the "tip" of the icon (relative to its top left corner).
String	getIconRetinaUrl() Gets The URL to a retina sized version of the icon image (absolute or relative to your script path).
Point	getIconSize() Gets the size of the icon image in pixels.
String	getIconUrl() Gets the URL to the icon image
String	getPane()
Point	getPopupAnchor() Gets the coordinates of the point from which popups will "open", relative to the icon anchor.
Point	getShadowAnchor() Gets the coordinates of the "tip" of the shadow (relative to its top left corner) (the same as iconAnchor if not specified).
String	getShadowRetinaUrl() Gets the URL to the retina sized version of the icon shadow image.
Point	getShadowSize() Gets the size of the shadow image in pixels.
String	getShadowUrl() Gets the URL to the icon shadow image.

Methods inherited from class java.lang.Object

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

Method Detail

getIconUrl

@JsOverlay
public final String getIconUrl()

Gets the URL to the icon image

Returns:

the icon url

getIconRetinaUrl

@JsOverlay
public final String getIconRetinaUrl()

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

Returns:

the icon retina url

getIconSize

@JsOverlay
public final Point getIconSize()

Gets the size of the icon image in pixels.

Returns:

the icon size

getIconAnchor

@JsOverlay
public final Point getIconAnchor()

Gets 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:

the icon anchor

getShadowUrl

@JsOverlay
public final String getShadowUrl()

Gets the URL to the icon shadow image. If not specified, no shadow image will be created.

Returns:

the shadow url

getShadowRetinaUrl

@JsOverlay
public final String getShadowRetinaUrl()

Gets 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:

the shadow retina url

getShadowSize

@JsOverlay
public final Point getShadowSize()

Gets the size of the shadow image in pixels.

Returns:

the shadow size

getShadowAnchor

@JsOverlay
public final Point getShadowAnchor()

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

Returns:

the shadow anchor

getPopupAnchor

@JsOverlay
public final Point getPopupAnchor()

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

Returns:

the popup anchor

getClassName

@JsOverlay
public final String getClassName()

Gets the class name assigned to both icon and shadow images. Empty by default.

Returns:

the class name

getPane

@JsOverlay
public final String getPane()

getAttribution

@JsOverlay
public final String getAttribution()