API.md

Directions

L.mapbox.directions(options)

Extends: L.Class

Options	Type	Description
options	object	Directions options object

Directions options

Option	Type	Default	Description
accessToken	String	null	Required unless L.mapbox.accessToken is set globally
profile	String	mapbox.driving	Routing profile to use. Options: mapbox.driving, mapbox.walking, mapbox.cycling
units	String	imperial	Measurement system to be used in navigation instructions. Options: imperial, metric

Directions events

Event	Content
origin	Fired when the origin is selected.
destination	Fired when the destination is selected.
profile	Fired when a profile is selected.
selectRoute	Fired when a route is selected.
highlightRoute	Fired when a route is highlighted.
highlightStep	Fired when a step is highlighted.
load	Fired when directions load.
error	Fired when remote requests result in an error.

directions.getOrigin()

Returns the origin of the current route.

Returns: the origin

directions.setOrigin()

Sets the origin of the current route.

Returns: this

directions.getDestination()

Returns the destination of the current route.

Returns: the destination

directions.setDestination()

Sets the destination of the current route.

Returns: this

directions.queryable()

Returns: boolean, whether both the destination and the origin are set properly and directions can be retrieved at this time.

directions.query(opts, callback)

After you've set an origin and destination, query fires the query to geocoding and sets results in the controller.

Options is an optional options object, which can specify:

• proximity: a L.LatLng object that is fed into the geocoder and biases matches around a point

Callback is an optional callback that will be called with (err, results)

Returns: this

directions.addWaypoint(index, waypoint)

Add a waypoint to the route at the given index. waypoint can be a GeoJSON Point Feature or a L.LatLng.

Returns: this

directions.removeWaypoint(index)

Remove the waypoint at the given index from the route.

Returns: this

directions.setWaypoint(index, waypoint)

Change the waypoint at the given index. waypoint can be a GeoJSON Point Feature or a L.LatLng.

Returns: this

directions.reverse()

Swap the origin and destination.

Returns: this

directions.query(opts)

Send a directions query request. opts can contain a proximity LatLng object for geocoding origin/destination/waypoint strings.

Returns: this

L.mapbox.directions.layer(directions, options)

Extends: L.LayerGroup

Create a new layer that displays a given set of directions on a map.

Options	Value	Description
options	object	Layer options object

Layer options

Option	Type	Default	Description
readonly	Boolean	false	Optional. If set to true marker and linestring interaction is disabled.
routeStyle	Object	{color: '#3BB2D0', weight: 4, opacity: .75}	GeoJSON style to specify color, weight and opacity of route polyline.

L.mapbox.directions.inputControl

inputControl.addTo(map)

Add this control to a given map object.

Returns: this

L.mapbox.directions.errorsControl

errorsControl.addTo(map)

Add this control to a given map object.

Returns: this

L.mapbox.directions.routesControl

routesControl.addTo(map)

Add this control to a given map object.

Returns: this

L.mapbox.directions.instructionsControl