net.java.html.leaflet

Class PolyLine

java.lang.Object

net.java.html.leaflet.ILayer

net.java.html.leaflet.Path

net.java.html.leaflet.PolyLine

Direct Known Subclasses:

Polygon

public class PolyLine
extends Path

A class for drawing polyline overlays on a map.

Constructor Summary

Constructors

Constructor and Description
PolyLine(LatLng[] latlngs) Instantiates a polyline object given an array of geographical points.
PolyLine(LatLng[] latlngs, PolyLineOptions options) Instantiates a polyline object given an array of geographical points and an options object.

Method Summary

Modifier and Type	Method and Description
PolyLine	addLatLng(LatLng latlng) Adds a given point to the polyline.
PolyLine	addTo(Map map) Adds the layer to the map.
PolyLine	bindPopup(Popup popup) Binds a popup to a click on this polyline.
PolyLine	bindPopup(Popup popup, PopupOptions options) Binds a popup with a particular popup configuration options to a click on this polyline.
PolyLine	bindPopup(String html) Binds a popup with a particular HTML content to a click on this polyline.
PolyLine	bringToBack() Brings the layer to the bottom of all path layers.
PolyLine	bringToFront() Brings the layer to the top of all path layers.
PolyLine	closePopup() Closes the bound popup of the polyline if it's opened.
LatLng[]	getLatLngs() Returns an array of the points in the path.
PolyLine	openPopup() Opens the popup previously bound by the bindPopup method.
PolyLine	redraw() Redraws the layer.
PolyLine	setLatLngs(LatLng[] latlngs) Replaces all the points in the polyline with the given array of geographical points.
PolyLine	setStyle(PathOptions options) Changes the appearance of a Path based on the options in the PathOptions object.
LatLng[]	spliceLatLngs(int index, int pointsToRemove, LatLng... latlngs) Allows adding, removing or replacing points in the polyline.
PolyLine	unbindPopup() Unbinds the popup previously bound to the polyline with bindPopup.

Methods inherited from class net.java.html.leaflet.Path

addEventListener, addMouseListener, addPopupListener, clearAllEventListeners, getBounds, removeEventListener, removeMouseListener, removePopupListener

Methods inherited from class java.lang.Object

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

Constructor Detail

PolyLine

public PolyLine(LatLng[] latlngs)

Instantiates a polyline object given an array of geographical points.

Parameters:

latlngs - array of geographical points

PolyLine

public PolyLine(LatLng[] latlngs,
                PolyLineOptions options)

Instantiates a polyline object given an array of geographical points and an options object.

Parameters:

latlngs - array of geographical points

options - configuration options

Method Detail

addLatLng

public PolyLine addLatLng(LatLng latlng)

Adds a given point to the polyline.

Parameters:

latlng - point to add

Returns:

this

getLatLngs

public LatLng[] getLatLngs()

Returns an array of the points in the path.

Returns:

array of the points in the path

setLatLngs

public PolyLine setLatLngs(LatLng[] latlngs)

Replaces all the points in the polyline with the given array of geographical points.

Parameters:

latlngs - array of points that replace the existing ones

Returns:

this

spliceLatLngs

public LatLng[] spliceLatLngs(int index,
                              int pointsToRemove,
                              LatLng... latlngs)

Allows adding, removing or replacing points in the polyline. Syntax is the same as in Array#splice. Returns the array of removed points (if any).

Parameters:

index - index from that points should be inserted/removed

pointsToRemove - number of points to remove

latlngs - array of points to insert

Returns:

array of removed points (if any)

addTo

public PolyLine addTo(Map map)

Adds the layer to the map.

Overrides:

addTo in class Path

Parameters:

map - The map

Returns:

this

setStyle

public PolyLine setStyle(PathOptions options)

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

Overrides:

setStyle in class Path

Parameters:

options - path configuration options

Returns:

this

bringToFront

public PolyLine bringToFront()

Brings the layer to the top of all path layers.

Overrides:

bringToFront in class Path

Returns:

this

bringToBack

public PolyLine bringToBack()

Brings the layer to the bottom of all path layers.

Overrides:

bringToBack in class Path

Returns:

this

redraw

public PolyLine redraw()

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

Overrides:

redraw in class Path

Returns:

this

bindPopup

public PolyLine bindPopup(String html)

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

Overrides:

bindPopup in class Path

Parameters:

html - HTML content of the popup

Returns:

this

bindPopup

public PolyLine bindPopup(Popup popup)

Binds a popup to a click on this polyline. You can also open the bound popup with the Polyline openPopup method.

Overrides:

bindPopup in class Path

Parameters:

popup - popup object

Returns:

this

bindPopup

public PolyLine bindPopup(Popup popup,
                          PopupOptions options)

Binds a popup with a particular popup configuration options to a click on this polyline. You can also open the bound popup with the Polyline openPopup method.

Overrides:

bindPopup in class Path

Parameters:

popup - popup object

options - popup configuration options

Returns:

this

unbindPopup

public PolyLine unbindPopup()

Unbinds the popup previously bound to the polyline with bindPopup.

Overrides:

unbindPopup in class Path

Returns:

this

openPopup

public PolyLine openPopup()

Opens the popup previously bound by the bindPopup method.

Overrides:

openPopup in class Path

Returns:

this

closePopup

public PolyLine closePopup()

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

Overrides:

closePopup in class Path

Returns:

this