com.gwidgets.api.leaflet

Class Polyline

java.lang.Object

com.gwidgets.api.leaflet.Path

com.gwidgets.api.leaflet.Polyline

Direct Known Subclasses:

Polygon

@JsType(isNative=true)
public class Polyline
extends Path

A class for drawing polyline overlays on a map. Extends Path. Use addLayer of the class Map to add it to the map.

Author:

Zakaria Amine

Method Summary

Modifier and Type	Method and Description
L	addLatLng(LatLng latlng) Adds a given point to the polyline.
LatLngBounds	getBounds() Returns the LatLngBounds of the path.
LatLng[]	getLatLngs() Returns an array of the points in the path.
L	setLatLngs(LatLng[] latlngs) Sets the lat lngs.
LatLng[]	spliceLatLngs(java.lang.Number index, java.lang.Number pointsToRemove, LatLng latlng) Allows adding, removing or replacing points in the polyline.
com.google.gwt.core.client.JavaScriptObject	toGeoJSON() Returns a GeoJSON representation of the polyline (GeoJSON LineString Feature).

Methods inherited from class com.gwidgets.api.leaflet.Path

addTo, bindPopup, bindPopup, bindPopup, bringToBack, bringToFront, clearAllEventListeners, closePopup, fire, off, on, once, openPopup, redraw, setStyle, unbindPopup

Methods inherited from class java.lang.Object

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

Method Detail

addLatLng

@JsMethod
public L addLatLng(LatLng latlng)

Adds a given point to the polyline.

Parameters:

latlng - the latlng

Returns:

the L class

setLatLngs

@JsMethod
public L setLatLngs(LatLng[] latlngs)

Sets the lat lngs.

Parameters:

latlngs - the latlngs

Returns:

the L class

getLatLngs

@JsMethod
public LatLng[] getLatLngs()

Returns an array of the points in the path.

Returns:

the lat lngs

spliceLatLngs

@JsMethod
public LatLng[] spliceLatLngs(java.lang.Number index,
                                         java.lang.Number pointsToRemove,
                                         LatLng latlng)

Allows adding, removing or replacing points in the polyline. Returns the array of removed points (if any).

Parameters:

index - the index

pointsToRemove - the points to remove

latlng - the latlng

Returns:

an array of removed points (if any).

getBounds

@JsMethod
public LatLngBounds getBounds()

Description copied from class: Path

Returns the LatLngBounds of the path.

Overrides:

getBounds in class Path

Returns:

the bounds

toGeoJSON

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

Returns a GeoJSON representation of the polyline (GeoJSON LineString Feature).

Returns:

the object