com.gwidgets.api.leaflet

Class Polyline

java.lang.Object

com.gwidgets.api.leaflet.Path

com.gwidgets.api.leaflet.Polyline

All Implemented Interfaces:

Evented, Layer

Direct Known Subclasses:

Polygon

@JsType(isNative=true)
public class Polyline
extends Path
implements Layer, Evented

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Polyline()

Method Summary

Modifier and Type	Method and Description
L	addEventParent(Evented obj) Adds an event parent - an Evented that will receive propagated events
L	addLatLng(LatLng latlng) Adds a given point to the polyline.
L	addTo(Map map) Adds the layer to the map.
L	bindPopup(elemental2.dom.HTMLElement content, PopupOptions options) Binds a popup with a particular HTML content to a click on this path.
L	bindPopup(String id, PopupOptions options) Bind popup.
L	bindTooltip(elemental2.dom.HTMLElement content, TooltipOptions options) Binds a tooltip to the layer with the passed *content and sets up the neccessary event listeners.
L	bindTooltip(String content, TooltipOptions options) Binds a tooltip to the layer with the passed *content and sets up the neccessary event listeners.
L	bindTooltip(Tooltip content, TooltipOptions options) Binds a tooltip to the layer with the passed content and sets up the neccessary event listeners.
L	clearAllEventListeners() Clear all event listeners.
L	closePopup() Closes the path's bound popup if it is opened.
L	closeTooltip() Closes the tooltip bound to this layer if it is open.
L	fire(String type) Fires an event of the specified type.
LatLngBounds	getBounds() Returns the LatLngBounds of the path.
LatLng[][]	getLatLngs() Returns an array of the points in the path.
elemental2.dom.HTMLElement	getPane(String name) Returns the HTMLElement representing the named pane on the map.
Popup	getPopup() Returns the popup bound to this layer.
Tooltip	getTooltip() Returns the tooltip bound to this layer.
boolean	isPopupOpen() Returns true if the popup bound to this layer is currently open.
boolean	isTooltipOpen() Returns true if the tooltip bound to this layer is currently open.
Boolean	listens(String type) Returns true if a particular event type has any listeners attached to it.
L	off() Removes all listener
L	off(String type) Removes a listener
L	off(String[] type) Removes a set of listener
L	on(String type, EventCallback fn) Adds a set of type/listener pairs.
L	once(String type, EventCallback fn) the listener will only get fired once and then removed.
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	openTooltip(LatLng latlng) Opens the bound tooltip at the specificed latlng or at the default tooltip anchor if no latlng is passed.
L	remove() Removes the tooltip from the map it is currently active on.
L	removeEventParent(Evented obj) Removes an event parent, so it will stop receiving propagated events
L	removeFrom(Map map) Removes the tooltip from the given map
L	setLatLngs(LatLng[] latlngs) Sets the lat lngs.
L	setPopupContent(elemental2.dom.HTMLElement content) Sets the content of the popup bound to this layer.
L	setPopupContent(Popup content) Sets the content of the popup bound to this layer.
L	setPopupContent(String content) Sets the content of the popup bound to this layer.
L	setTooltipContent(elemental2.dom.HTMLElement content) Sets the content of the tooltip bound to this layer.
L	setTooltipContent(String content) Sets the content of the tooltip bound to this layer.
L	setTooltipContent(Tooltip content) Sets the content of the tooltip bound to this layer.
LatLng[]	spliceLatLngs(double index, double 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).
L	togglePopup() Opens or closes the popup bound to this layer depending on its current state.
L	toggleTooltip() Opens or closes the tooltip bound to this layer depending on its current state.
L	unbindPopup() Unbind popup.
L	unbindTooltip() Removes the tooltip previously bound with *bindTooltip.

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

bindPopup, bringToBack, bringToFront, redraw, setStyle

Methods inherited from class java.lang.Object

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

Constructor Detail

Polyline

protected Polyline()

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(double index,
                                        double 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

bindPopup

@JsMethod
public L bindPopup(elemental2.dom.HTMLElement content,
                             PopupOptions options)

Description copied from class: Path

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

Specified by:

bindPopup in interface Layer

Overrides:

bindPopup in class Path

Parameters:

content - the element

options - the options

Returns:

the L class

bindPopup

@JsMethod
public L bindPopup(String id,
                             PopupOptions options)

Description copied from class: Path

Bind popup.

Specified by:

bindPopup in interface Layer

Overrides:

bindPopup in class Path

Parameters:

id - the html

options - the options

Returns:

the l

unbindPopup

@JsMethod
public L unbindPopup()

Description copied from class: Path

Unbind popup.

Specified by:

unbindPopup in interface Layer

Overrides:

unbindPopup in class Path

Returns:

the L class

openPopup

@JsMethod
public L openPopup(LatLng latlng)

Description copied from class: Path

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

Specified by:

openPopup in interface Layer

Overrides:

openPopup in class Path

Parameters:

latlng - the latlng

Returns:

the L class

closePopup

@JsMethod
public L closePopup()

Description copied from class: Path

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

Specified by:

closePopup in interface Layer

Overrides:

closePopup in class Path

Returns:

the L class

togglePopup

@JsMethod
public L togglePopup()

Description copied from interface: Layer

Opens or closes the popup bound to this layer depending on its current state.

Specified by:

togglePopup in interface Layer

Returns:

the L class

isPopupOpen

@JsMethod
public boolean isPopupOpen()

Description copied from interface: Layer

Returns true if the popup bound to this layer is currently open.

Specified by:

isPopupOpen in interface Layer

Returns:

true if pop up is open false if closed

setPopupContent

@JsMethod
public L setPopupContent(String content)

Description copied from interface: Layer

Sets the content of the popup bound to this layer.

Specified by:

setPopupContent in interface Layer

Returns:

the L class

setPopupContent

@JsMethod
public L setPopupContent(elemental2.dom.HTMLElement content)

Description copied from interface: Layer

Sets the content of the popup bound to this layer.

Specified by:

setPopupContent in interface Layer

Returns:

the L class

setPopupContent

@JsMethod
public L setPopupContent(Popup content)

Description copied from interface: Layer

Sets the content of the popup bound to this layer.

Specified by:

setPopupContent in interface Layer

Returns:

the L class

getPopup

@JsMethod
public Popup getPopup()

Description copied from interface: Layer

Returns the popup bound to this layer.

Specified by:

getPopup in interface Layer

Returns:

Popup the Pop bound to this layer.

bindTooltip

public L bindTooltip(String content,
                     TooltipOptions options)

Description copied from interface: Layer

Binds a tooltip to the layer with the passed *content and sets up the neccessary event listeners. If a Function is passed it will receive the layer as the first argument and should return a String or HTMLElement.

Specified by:

bindTooltip in interface Layer

Returns:

the L class

bindTooltip

public L bindTooltip(elemental2.dom.HTMLElement content,
                     TooltipOptions options)

Description copied from interface: Layer

Binds a tooltip to the layer with the passed *content and sets up the neccessary event listeners. If a Function is passed it will receive the layer as the first argument and should return a String or HTMLElement.

Specified by:

bindTooltip in interface Layer

Returns:

the L class

bindTooltip

public L bindTooltip(Tooltip content,
                     TooltipOptions options)

Description copied from interface: Layer

Binds a tooltip to the layer with the passed content and sets up the neccessary event listeners. If a Function is passed it will receive the layer as the first argument and should return a String or HTMLElement.

Specified by:

bindTooltip in interface Layer

Returns:

the L class

unbindTooltip

public L unbindTooltip()

Description copied from interface: Layer

Removes the tooltip previously bound with *bindTooltip.

Specified by:

unbindTooltip in interface Layer

Returns:

the L class

openTooltip

public L openTooltip(LatLng latlng)

Description copied from interface: Layer

Opens the bound tooltip at the specificed latlng or at the default tooltip anchor if no latlng is passed.

Specified by:

openTooltip in interface Layer

Returns:

the L class

closeTooltip

public L closeTooltip()

Description copied from interface: Layer

Closes the tooltip bound to this layer if it is open.

Specified by:

closeTooltip in interface Layer

Returns:

the L class

toggleTooltip

public L toggleTooltip()

Description copied from interface: Layer

Opens or closes the tooltip bound to this layer depending on its current state.

Specified by:

toggleTooltip in interface Layer

Returns:

the L class

isTooltipOpen

public boolean isTooltipOpen()

Description copied from interface: Layer

Returns true if the tooltip bound to this layer is currently open.

Specified by:

isTooltipOpen in interface Layer

Returns:

boolean true if tooltip is open, false otherwise

setTooltipContent

public L setTooltipContent(String content)

Description copied from interface: Layer

Sets the content of the tooltip bound to this layer.

Specified by:

setTooltipContent in interface Layer

Returns:

the L class

setTooltipContent

public L setTooltipContent(elemental2.dom.HTMLElement content)

Description copied from interface: Layer

Sets the content of the tooltip bound to this layer.

Specified by:

setTooltipContent in interface Layer

Returns:

the L class

setTooltipContent

public L setTooltipContent(Tooltip content)

Description copied from interface: Layer

Sets the content of the tooltip bound to this layer.

Specified by:

setTooltipContent in interface Layer

Returns:

the L class

getTooltip

public Tooltip getTooltip()

Description copied from interface: Layer

Returns the tooltip bound to this layer.

Specified by:

getTooltip in interface Layer

Returns:

ToolTip the tooltip

addTo

public L addTo(Map map)

Description copied from class: Path

Adds the layer to the map.

Specified by:

addTo in interface Layer

Overrides:

addTo in class Path

Parameters:

map - the map

Returns:

the L class

remove

public L remove()

Description copied from interface: Layer

Removes the tooltip from the map it is currently active on.

Specified by:

remove in interface Layer

Returns:

the L class

removeFrom

public L removeFrom(Map map)

Description copied from interface: Layer

Removes the tooltip from the given map

Specified by:

removeFrom in interface Layer

Returns:

the L class

getPane

public elemental2.dom.HTMLElement getPane(String name)

Description copied from interface: Layer

Returns the HTMLElement representing the named pane on the map. If name is omitted, returns the pane for this layer.

Specified by:

getPane in interface Layer

Returns:

HTMLElement the element

clearAllEventListeners

public L clearAllEventListeners()

Description copied from interface: Evented

Clear all event listeners.

Specified by:

clearAllEventListeners in interface Evented

Returns:

the L class

on

public L on(String type,
            EventCallback fn)

Description copied from interface: Evented

Adds a set of type/listener pairs.

Specified by:

on in interface Evented

Parameters:

type - the type

fn - the callback function

Returns:

the L class

once

public L once(String type,
              EventCallback fn)

Description copied from interface: Evented

the listener will only get fired once and then removed.

Specified by:

once in interface Evented

Parameters:

type - the type

fn - the callback function

Returns:

the L class

off

public L off(String type)

Description copied from interface: Evented

Removes a listener

Specified by:

off in interface Evented

Parameters:

type - the type

Returns:

the L class

off

public L off(String[] type)

Description copied from interface: Evented

Removes a set of listener

Specified by:

off in interface Evented

Parameters:

type - the type

Returns:

the L class

off

public L off()

Description copied from interface: Evented

Removes all listener

Specified by:

off in interface Evented

Returns:

the L class

fire

public L fire(String type)

Description copied from interface: Evented

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.

Specified by:

fire in interface Evented

Parameters:

type - the type

Returns:

the L class

listens

public Boolean listens(String type)

Description copied from interface: Evented

Returns true if a particular event type has any listeners attached to it.

Specified by:

listens in interface Evented

Returns:

true if there is listener, false otherwise

addEventParent

public L addEventParent(Evented obj)

Description copied from interface: Evented

Adds an event parent - an Evented that will receive propagated events

Specified by:

addEventParent in interface Evented

Returns:

the L class

removeEventParent

public L removeEventParent(Evented obj)

Description copied from interface: Evented

Removes an event parent, so it will stop receiving propagated events

Specified by:

removeEventParent in interface Evented

Returns:

the L class