com.gwidgets.api.leaflet.options

Class IconOptions.Builder

java.lang.Object

com.gwidgets.api.leaflet.options.IconOptions.Builder

Enclosing class:

IconOptions

public static class IconOptions.Builder
extends Object

The Class Builder.

Constructor Summary

Constructors

Constructor and Description
Builder(String iconUrl) Instantiates a new builder.

Method Summary

Modifier and Type	Method and Description
IconOptions.Builder	attribution(String attribution)
IconOptions	build() Builds the.
IconOptions.Builder	className(String className) A custom class name to assign to both icon and shadow images.
IconOptions.Builder	iconAnchor(Point iconAnchor) The coordinates of the "tip" of the icon (relative to its top left corner).
IconOptions.Builder	iconRetinaUrl(String iconRetinaUrl) The URL to a retina sized version of the icon image (absolute or relative to your script path).
IconOptions.Builder	iconSize(Point iconSize) Size of the icon image in pixels.
IconOptions.Builder	pane(String pane)
IconOptions.Builder	popupAnchor(Point popupAnchor) The coordinates of the point from which popups will "open", relative to the icon anchor.
IconOptions.Builder	shadowAnchor(Point shadowAnchor) The coordinates of the "tip" of the shadow (relative to its top left corner) (the same as iconAnchor if not specified).
IconOptions.Builder	shadowRetinaUrl(String shadowRetinaUrl) The URL to the retina sized version of the icon shadow image.
IconOptions.Builder	shadowSize(Point shadowSize) Size of the shadow image in pixels.
IconOptions.Builder	shadowUrl(String shadowUrl) 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

Constructor Detail

Builder

public Builder(String iconUrl)

Instantiates a new builder. takes the icon url (absolute or relative to your script path) as a required parameter

Parameters:

iconUrl - the icon url

Method Detail

iconRetinaUrl

public IconOptions.Builder iconRetinaUrl(String iconRetinaUrl)

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

Parameters:

iconRetinaUrl - the icon retina url

Returns:

the builder

iconSize

public IconOptions.Builder iconSize(Point iconSize)

Size of the icon image in pixels.

Parameters:

iconSize - the icon size

Returns:

the builder

iconAnchor

public IconOptions.Builder iconAnchor(Point iconAnchor)

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.

Parameters:

iconAnchor - the icon anchor

Returns:

the builder

shadowUrl

public IconOptions.Builder shadowUrl(String shadowUrl)

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

Parameters:

shadowUrl - the shadow url

Returns:

the builder

shadowRetinaUrl

public IconOptions.Builder shadowRetinaUrl(String shadowRetinaUrl)

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.

Parameters:

shadowRetinaUrl - the shadow retina url

Returns:

the builder

shadowSize

public IconOptions.Builder shadowSize(Point shadowSize)

Size of the shadow image in pixels.

Parameters:

shadowSize - the shadow size

Returns:

the builder

shadowAnchor

public IconOptions.Builder shadowAnchor(Point shadowAnchor)

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

Parameters:

shadowAnchor - the shadow anchor

Returns:

the builder

popupAnchor

public IconOptions.Builder popupAnchor(Point popupAnchor)

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

Parameters:

popupAnchor - the popup anchor

Returns:

the builder

className

public IconOptions.Builder className(String className)

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

Parameters:

className - the class name

Returns:

the builder

pane

public IconOptions.Builder pane(String pane)

attribution

public IconOptions.Builder attribution(String attribution)

build

public IconOptions build()

Builds the.

Returns:

the icon options