Class Polyline

L.Class powers the OOP facilities of Leaflet and is used to create almost all of the Leaflet classes documented.

Hierarchy

Index

Constructor methods

Methods

Constructor methods

constructor(latlngs: LatLng[], options?: PolylineOptions): Polyline

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

Parameters

Returns

Polyline

Methods

public addEventListener(type: string, fn: (e: L.LeafletEvent) => void, context?: any): Path

Parameters

  • type: string
  • fn: (e: L.LeafletEvent) => void
  • context?: any optional

Returns

Path

public addEventListener(eventMap: any, context?: any): Path

Parameters

  • eventMap: any
  • context?: any optional

Returns

Path

public addLatLng(latlng: LatLng): Polyline

Adds a given point to the polyline.

Parameters

Returns

Polyline

public addOneTimeEventListener(type: string, fn: (e: L.LeafletEvent) => void, context?: any): Path

Parameters

  • type: string
  • fn: (e: L.LeafletEvent) => void
  • context?: any optional

Returns

Path

public addTo(map: Map): Path

Adds the layer to the map.

Parameters

Returns

Path

public bindPopup(html: string, options?: PopupOptions): Path

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

Parameters

Returns

Path

public bindPopup(el: HTMLElement, options?: PopupOptions): Path

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

Parameters

Returns

Path

public bindPopup(popup: Popup, options?: PopupOptions): Path

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

Parameters

Returns

Path

public bringToBack(): Path

Brings the layer to the bottom of all path layers.

Returns

Path

public bringToFront(): Path

Brings the layer to the top of all path layers.

Returns

Path

public clearAllEventListeners(): Path

Returns

Path

public closePopup(): Path

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

Returns

Path

public fire(type: string, data?: any): Path

Parameters

  • type: string
  • data?: any optional

Returns

Path

public fireEvent(type: string, data?: any): Path

Parameters

  • type: string
  • data?: any optional

Returns

Path

public getBounds(): LatLngBounds

Returns the LatLngBounds of the polyline.

Returns

LatLngBounds

public getLatLngs(): LatLng[]

Returns an array of the points in the path.

Returns

LatLng[]

public hasEventListeners(type: string): boolean

Parameters

  • type: string

Returns

boolean

public off(type: string, fn?: (e: L.LeafletEvent) => void, context?: any): Path

Parameters

  • type: string
  • fn?: (e: L.LeafletEvent) => void optional
  • context?: any optional

Returns

Path

public off(eventMap?: any, context?: any): Path

Parameters

  • eventMap?: any optional
  • context?: any optional

Returns

Path

public on(type: string, fn: (e: L.LeafletEvent) => void, context?: any): Path

Parameters

  • type: string
  • fn: (e: L.LeafletEvent) => void
  • context?: any optional

Returns

Path

public on(eventMap: any, context?: any): Path

Parameters

  • eventMap: any
  • context?: any optional

Returns

Path

public onAdd(map: Map)

Should contain code that creates DOM elements for the overlay, adds them to map panes where they should belong and puts listeners on relevant map events. Called on map.addLayer(layer).

Parameters

public onRemove(map: Map)

Should contain all clean up code that removes the overlay's elements from the DOM and removes listeners previously added in onAdd. Called on map.removeLayer(layer).

Parameters

public once(type: string, fn: (e: L.LeafletEvent) => void, context?: any): Path

Parameters

  • type: string
  • fn: (e: L.LeafletEvent) => void
  • context?: any optional

Returns

Path

public openPopup(latlng?: LatLng): 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.

Parameters

Returns

Path

public redraw(): Path

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

Returns

Path

public removeEventListener(type: string, fn?: (e: L.LeafletEvent) => void, context?: any): Path

Parameters

  • type: string
  • fn?: (e: L.LeafletEvent) => void optional
  • context?: any optional

Returns

Path

public removeEventListener(eventMap?: any, context?: any): Path

Parameters

  • eventMap?: any optional
  • context?: any optional

Returns

Path

public setLatLngs(latlngs: LatLng[]): Polyline

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

Parameters

Returns

Polyline

public setStyle(object: PathOptions): Path

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

Parameters

Returns

Path

public spliceLatLngs(index: number, pointsToRemove: number, latlngs?: LatLng[]): LatLng[]

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: number
  • pointsToRemove: number
  • latlngs?: LatLng[] optional

Returns

LatLng[]

public toGeoJSON(): any

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

Returns

any

public unbindPopup(): Path

Unbinds the popup previously bound to the path with bindPopup.

Returns

Path