L.polyline

L.polyline(latLng, options)

wrld.js requires that users create instances of L.polyline via the standard Leaflet factory (see creation example below).

// Create a polyline in downtown San Francisco.
var polylinePoints = [
        [37.781814, -122.404740],
        [37.781719, -122.404637],
        [37.781489, -122.404949],
        [37.780704, -122.403945],
        [37.780012, -122.404827]
      ];            
      
var polyline = L.polyline(polylinePoints).addTo(map);

Argument	Type	Description
latlngs	L.LatLng[]	latlngs forming the polyline.
options	object	Accepts all of the options to `L.polyline`, plus additional wrld.js entries.

Options

Options	Type	Default	Description
elevation	number	0.0	Altitude above ground or sea level in meters.
elevationMode	string	‘heightAboveGround’	Whether altitude is measured above ground level (“heightAboveGround”) or sea level (“heightAboveSeaLevel”).
indoorMapId	string	’’	The id of the indoor map with which the Polyline will be associated.
indoorMapFloorId	number	0	The id of the indoor map floor with which the Polyline will be associated.

Methods

getElevation()

Returns the elevation in meters.

setElevation(elevation)

Set the elevation in meters.

Argument	Type	Description
elevation	number	The elevation in meters

v0.1.1335