wrld.js

L.circle(latLng, options)

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

// Create a circle in downtown San Francisco.
L.circle([37.786542, -122.386022], { color: 'red', radius: 50.0 }).addTo(map);        
Argument Type Description
latlng L.LatLng the center of the circle.
options object Accepts all of the options to L.circle, 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 Circle will be associated.
indoorMapFloorId number 0 The id of the indoor map floor with which the Circle 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