class
Directions
A class that provides driving direction functionality.
Extends: Evented<DirectionsEventTable>
new constructor
(map, options)Example:
```js
const directions = new mapgl.Directions(map, {
directionsApiKey: 'Your Directions API access key',
});
directions.carRoute({
points: [
[55.2772379, 25.2377810],
[55.2986956, 25.2576546],
],
});
```
Parameters
map
Map<>
The map instance.
options
Directions initialization options.
Returns
Directions<>
Methods
carRoute
(options)Finds and draws an optimal car route.
Parameters
clear
Clears the map from any previously drawn routes.
Returns
void
emit
(type, data?)Calls all event listeners with event type
`type`
Parameters
type
K
Event type
data?
DirectionsEventTable[K]
Data transferred to events
Returns
this
off
(type, listener)Removes event listener registered with
`on`
Parameters
type
K
Event type
listener
(ev: DirectionsEventTable[K]) => void
Event handler
Returns
this
on
(type, listener)Registers event listener
Parameters
type
K
Event type
listener
(ev: DirectionsEventTable[K]) => void
Event handler
Returns
this
once
(type, listener)Registers event listener which will be called once
Parameters
type
K
Event type
listener
(ev: DirectionsEventTable[K]) => void
Event handler
Returns
this
pedestrianRoute
(options)Finds and draws an optimal pedestrian route.
Parameters
Evented
Event emitter
new constructor
Returns
Evented<M>
Methods
emit
(type, data?)Calls all event listeners with event type
`type`
Parameters
type
K
Event type
data?
M[K]
Data transferred to events
Returns
this
off
(type, listener)Removes event listener registered with
`on`
Parameters
type
K
Event type
listener
(ev: M[K]) => void
Event handler
Returns
this
on
(type, listener)Registers event listener
Parameters
type
K
Event type
listener
(ev: M[K]) => void
Event handler
Returns
this
once
(type, listener)Registers event listener which will be called once
Parameters
type
K
Event type
listener
(ev: M[K]) => void
Event handler
Returns
this