com.gwidgets.api.leaflet

Class Marker

java.lang.Object

com.gwidgets.api.leaflet.Marker

@JsType(isNative=true)
public class Marker
extends java.lang.Object

Used to put markers on the map.

Author:

Zakaria Amine

Method Summary

Modifier and Type	Method and Description
L	addTo(Map map) Adds the marker to the map.
L	bindPopup(HTMLElement el, PopupOptions options) Binds a popup with a particular HTML content to a click on this marker.
L	bindPopup(Popup popup, PopupOptions options) Binds a popup with a particular HTML content to a click on this marker.
L	bindPopup(java.lang.String html, PopupOptions options) Binds a popup with a particular HTML content to a click on this marker.
static L	clearAllEventListeners() Clear all event listeners.
L	closePopup() Closes the bound popup of the marker if it's opened.
static L	fire(java.lang.String type) Fires an event of the specified type.
LatLng	getLatLng() Returns the current geographical position of the marker.
Popup	getPopup() Returns the popup previously bound by the bindPopup method.
static L	off(java.lang.String type, Function fn) the listener will only get fired once and then removed.
static L	on(java.lang.String type, Function fn) Adds a set of type/listener pairs.
static L	once(java.lang.String type, Function fn) Once.
L	openPopup() Opens the popup previously bound by the bindPopup method.
L	setIcon(Icon icon) Changes the marker icon.
L	setLatLng(LatLng latlng) Changes the marker position to the given point.
L	setOpacity(java.lang.Number opacity) Changes the zIndex offset of the marker.
L	setPopupContent(HTMLElement el, PopupOptions options) Sets an HTML content of the popup of this marker.
L	setPopupContent(java.lang.String html, PopupOptions options) Sets an HTML content of the popup of this marker.
L	setZIndexOffset(java.lang.Number offset) Sets the Z index offset.
com.google.gwt.core.client.JavaScriptObject	toGeoJSON() To geo JSON.
L	togglePopup() Toggles the popup previously bound by the bindPopup method.
L	unbindPopup() Unbinds the popup previously bound to the marker with bindPopup.
L	update() Updates the marker position, useful if coordinates of its latLng object were changed directly.

Methods inherited from class java.lang.Object

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

Method Detail

addTo

@JsMethod
public L addTo(Map map)

Adds the marker to the map.

Parameters:

map - the map

Returns:

the L class

getLatLng

@JsMethod
public LatLng getLatLng()

Returns the current geographical position of the marker.

Returns:

the lat lng

setLatLng

@JsMethod
public L setLatLng(LatLng latlng)

Changes the marker position to the given point.

Parameters:

latlng - the latlng

Returns:

the L class

setIcon

@JsMethod
public L setIcon(Icon icon)

Changes the marker icon.

Parameters:

icon - the icon

Returns:

the L class

setZIndexOffset

@JsMethod
public L setZIndexOffset(java.lang.Number offset)

Sets the Z index offset.

Parameters:

offset - the offset

Returns:

the l

setOpacity

@JsMethod
public L setOpacity(java.lang.Number opacity)

Changes the zIndex offset of the marker.

Parameters:

opacity - the opacity

Returns:

the L class

update

@JsMethod
public L update()

Updates the marker position, useful if coordinates of its latLng object were changed directly.

Returns:

the l

bindPopup

@JsMethod
public L bindPopup(java.lang.String html,
                              PopupOptions options)

Binds a popup with a particular HTML content to a click on this marker. You can also open the bound popup with the Marker openPopup method.

Parameters:

html - the html

options - the options

Returns:

the L class

bindPopup

@JsMethod
public L bindPopup(HTMLElement el,
                              PopupOptions options)

Binds a popup with a particular HTML content to a click on this marker. You can also open the bound popup with the Marker openPopup method.

Parameters:

el - the el

options - the options

Returns:

the L class

bindPopup

@JsMethod
public L bindPopup(Popup popup,
                              PopupOptions options)

Binds a popup with a particular HTML content to a click on this marker. You can also open the bound popup with the Marker openPopup method.

Parameters:

popup - the popup

options - the options

Returns:

the L class

unbindPopup

@JsMethod
public L unbindPopup()

Unbinds the popup previously bound to the marker with bindPopup.

Returns:

the L class

openPopup

@JsMethod
public L openPopup()

Opens the popup previously bound by the bindPopup method.

Returns:

the L class

getPopup

@JsMethod
public Popup getPopup()

Returns the popup previously bound by the bindPopup method.

Returns:

the L class

closePopup

@JsMethod
public L closePopup()

Closes the bound popup of the marker if it's opened.

Returns:

the l

togglePopup

@JsMethod
public L togglePopup()

Toggles the popup previously bound by the bindPopup method.

Returns:

the L class

setPopupContent

@JsMethod
public L setPopupContent(java.lang.String html,
                                    PopupOptions options)

Sets an HTML content of the popup of this marker.

Parameters:

html - the html

options - the options

Returns:

the L class

setPopupContent

@JsMethod
public L setPopupContent(HTMLElement el,
                                    PopupOptions options)

Sets an HTML content of the popup of this marker.

Parameters:

el - the element

options - the options

Returns:

the L class

toGeoJSON

@JsMethod
public com.google.gwt.core.client.JavaScriptObject toGeoJSON()

To geo JSON.

Returns:

the object

clearAllEventListeners

@JsMethod
public static L clearAllEventListeners()

Clear all event listeners.

Returns:

the L class

on

@JsMethod
public static L on(java.lang.String type,
                              Function fn)

Adds a set of type/listener pairs.

Parameters:

type - the type

fn - the callback function

Returns:

the L class

once

@JsMethod
public static L once(java.lang.String type,
                                Function fn)

Once.

Parameters:

type - the type

fn - the callback function

Returns:

the L class

off

@JsMethod
public static L off(java.lang.String type,
                               Function fn)

the listener will only get fired once and then removed.

Parameters:

type - the type

fn - the callback function

Returns:

the L class

fire

@JsMethod
public static L fire(java.lang.String type)

Fires an event of the specified type. You can optionally provide an data object — the first argument of the listener function will contain its properties.

Parameters:

type - the type

Returns:

the L class