net.java.html.leaflet

Class MultiPolyline

java.lang.Object

net.java.html.leaflet.ILayer

net.java.html.leaflet.LayerGroup

net.java.html.leaflet.FeatureGroup

net.java.html.leaflet.MultiPolyline

public final class MultiPolyline
extends FeatureGroup

Extends FeatureGroup to allow creating multi-polylines (single layer that consists of several polylines that share styling/popup).

Constructor Summary

Constructors

Constructor and Description
MultiPolyline(LatLng[][] latlngs) Instantiates a multi-polyline object given an array of arrays of geographical points (one for each individual polyline).
MultiPolyline(LatLng[][] latlngs, PolyLineOptions options) Instantiates a multi-polyline object given an array of arrays of geographical points (one for each individual polyline) and an options object.

Method Summary

Modifier and Type	Method and Description
MultiPolyline	addLayer(ILayer layer) Adds a given layer to the group.
MultiPolyline	addTo(Map map) Adds the group of layers to the map.
MultiPolyline	bindPopup(String html) Binds a popup with a particular HTML content to a click on this group.
MultiPolyline	bindPopup(String html, PopupOptions options) Binds a popup with a particular HTML content and the given options to the group.
MultiPolyline	bringToBack() Brings the layer to the bottom of all path layers.
MultiPolyline	bringToFront() Brings the layer to the top of all path layers.
MultiPolyline	clearLayers() Removes all the layers from the group.
LatLng[][]	getLatLngs() Returns an array of arrays of geographical points in each line.
MultiPolyline	openPopup() Opens the popup previously bound by bindPopup.
MultiPolyline	removeLayer(ILayer layer) Removes a given layer from the group.
MultiPolyline	removeLayer(String layerId) Removes a given layer of the given id from the group.
MultiPolyline	setLatLngs(LatLng[][] latlngs) Replace all lines and their paths with the given array of arrays of geographical points.
MultiPolyline	setStyle(PathOptions options) Changes the appearance of a FeatureGroup based on the options in the PathOptions object.

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

addLayerListener, addMouseListener, clearAllEventListeners, getBounds, removeLayerListener, removeMouseListener

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

getLayers, hasLayer

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiPolyline

public MultiPolyline(LatLng[][] latlngs)

Instantiates a multi-polyline object given an array of arrays of geographical points (one for each individual polyline).

Parameters:

latlngs - arrays of geographical points

MultiPolyline

public MultiPolyline(LatLng[][] latlngs,
                     PolyLineOptions options)

Instantiates a multi-polyline object given an array of arrays of geographical points (one for each individual polyline) and an options object.

Parameters:

latlngs - arrays of geographical points

options - configuration options

Method Detail

setLatLngs

public MultiPolyline setLatLngs(LatLng[][] latlngs)

Replace all lines and their paths with the given array of arrays of geographical points.

Parameters:

latlngs - array of arrays of geographical points

Returns:

this

getLatLngs

public LatLng[][] getLatLngs()

Returns an array of arrays of geographical points in each line.

Returns:

array of arrays of geographical points

openPopup

public MultiPolyline openPopup()

Opens the popup previously bound by bindPopup.

Returns:

this

bindPopup

public MultiPolyline bindPopup(String html)

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

Overrides:

bindPopup in class FeatureGroup

Parameters:

html - poup HTML content

Returns:

this

bindPopup

public MultiPolyline bindPopup(String html,
                               PopupOptions options)

Binds a popup with a particular HTML content and the given options to the group.

Overrides:

bindPopup in class FeatureGroup

Parameters:

html - poup HTML content

options - popup configuration object

Returns:

this

setStyle

public MultiPolyline setStyle(PathOptions options)

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

Overrides:

setStyle in class FeatureGroup

Parameters:

options - path configuration options

Returns:

this

bringToFront

public MultiPolyline bringToFront()

Brings the layer to the top of all path layers.

Overrides:

bringToFront in class FeatureGroup

Returns:

this

bringToBack

public MultiPolyline bringToBack()

Brings the layer to the bottom of all path layers.

Overrides:

bringToBack in class FeatureGroup

Returns:

this

addTo

public MultiPolyline addTo(Map map)

Adds the group of layers to the map.

Overrides:

addTo in class FeatureGroup

Parameters:

map - The map

Returns:

this

addLayer

public MultiPolyline addLayer(ILayer layer)

Adds a given layer to the group.

Overrides:

addLayer in class FeatureGroup

Parameters:

layer - The layer to add

Returns:

this

removeLayer

public MultiPolyline removeLayer(ILayer layer)

Removes a given layer from the group.

Overrides:

removeLayer in class FeatureGroup

Parameters:

layer - The layer to remove

Returns:

this

removeLayer

public MultiPolyline removeLayer(String layerId)

Removes a given layer of the given id from the group.

Overrides:

removeLayer in class FeatureGroup

Parameters:

layerId - The layer id of the layer to remove

Returns:

this

clearLayers

public MultiPolyline clearLayers()

Removes all the layers from the group.

Overrides:

clearLayers in class FeatureGroup

Returns:

this