com.gwidgets.api.leaflet

Class Path

java.lang.Object

com.gwidgets.api.leaflet.Path

Direct Known Subclasses:

Circle, Polyline

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

An abstract class that contains options and constants shared between vector overlays (Polygon, Polyline, Circle). Do not use it directly.

Author:

Zakaria Amine

Method Summary

Modifier and Type	Method and Description
L	addTo(Map map) Adds the layer to the map.
L	bindPopup(HTMLElement el, PopupOptions options) Binds a popup with a particular HTML content to a click on this path.
L	bindPopup(Popup popup, PopupOptions options) Binds a popup with a particular HTML content to a click on this path.
L	bindPopup(java.lang.String html, PopupOptions options) Bind popup.
L	bringToBack() Brings the layer to the bottom of all path layers.
L	bringToFront() Brings the layer to the top of all path layers.
static L	clearAllEventListeners() Clear all event listeners.
L	closePopup() Closes the path's bound popup if it is opened.
static L	fire(java.lang.String type) Fires an event of the specified type.
LatLngBounds	getBounds() Returns the LatLngBounds of the path.
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(LatLng latlng) Opens the popup previously bound by the bindPopup method in the given point, or in one of the path's points if not specified.
L	redraw() Redraws the layer.
L	setStyle(PathOptions object) Changes the appearance of a Path based on the options in the Path options object.
L	unbindPopup() Unbind popup.

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 layer to the map.

Parameters:

map - the map

Returns:

the L class

bindPopup

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

Bind popup.

Parameters:

html - the html

options - the options

Returns:

the l

bindPopup

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

Binds a popup with a particular HTML content to a click on this path.

Parameters:

el - the element

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 path.

Parameters:

popup - the popup

options - the options

Returns:

the L class

unbindPopup

@JsMethod
public L unbindPopup()

Unbind popup.

Returns:

the L class

openPopup

@JsMethod
public L openPopup(LatLng latlng)

Opens the popup previously bound by the bindPopup method in the given point, or in one of the path's points if not specified.

Parameters:

latlng - the latlng

Returns:

the L class

closePopup

@JsMethod
public L closePopup()

Closes the path's bound popup if it is opened.

Returns:

the l

setStyle

@JsMethod
public L setStyle(PathOptions object)

Changes the appearance of a Path based on the options in the Path options object.

Parameters:

object - the object

Returns:

the L class

getBounds

@JsMethod
public LatLngBounds getBounds()

Returns the LatLngBounds of the path.

Returns:

the bounds

bringToFront

@JsMethod
public L bringToFront()

Brings the layer to the top of all path layers.

Returns:

the L class

bringToBack

@JsMethod
public L bringToBack()

Brings the layer to the bottom of all path layers.

Returns:

the L class

redraw

@JsMethod
public L redraw()

Redraws the layer. Sometimes useful after you changed the coordinates that the path uses.

Returns:

the L class

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