Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maplibre/maplibre-gl-directions
A plugin to show routing directions on a MapLibre GL JS map
https://github.com/maplibre/maplibre-gl-directions
directions mapbox maplibre osrm routing
Last synced: 28 days ago
JSON representation
A plugin to show routing directions on a MapLibre GL JS map
- Host: GitHub
- URL: https://github.com/maplibre/maplibre-gl-directions
- Owner: maplibre
- License: mit
- Created: 2022-04-06T11:34:22.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-03T18:48:57.000Z (10 months ago)
- Last Synced: 2024-04-14T05:45:27.838Z (10 months ago)
- Topics: directions, mapbox, maplibre, osrm, routing
- Language: TypeScript
- Homepage: https://maplibre.org/maplibre-gl-directions/
- Size: 5.53 MB
- Stars: 62
- Watchers: 6
- Forks: 13
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-maplibre - MapLibre GL Directions - A plugin to show routing directions on a MapLibre GL JS map (Navigation & Directions / Sprite Generation)
README
# MapLibre GL Directions
A plugin to show routing directions on a MapLibre GL JS map. Supports any [OSRM](http://project-osrm.org/) or [Mapbox Directions API](https://docs.mapbox.com/api/navigation/directions/) compatible Routing-provider.
[Live Demo](https://maplibre.org/maplibre-gl-directions/#/).
---
## Features
### Different Routing-providers
The plugin supports any OSRM- or Mapbox Directions API-compatible Routing-provider out of the box!
### Sane Defaults
Works without any configuration at all out of the box, though at the same time configurable enough to support most of the imaginable scenarios.
### User interaction
Add waypoints by clicking the map, click a waypoint to remove it, drag waypoints to move them, add waypoints in-between existing ones by dragging the selected route line, change the selected route by clicking an alternative route line or completely disable the user interaction with a single call. Everything is touch-friendly!
### Congestions
Supports the Mapbox Directions API congestions (both plain and numeric!)
### Bearings
Supports the waypoints' bearings settings with the help of a custom Control.
### Multiple routing profiles per single directions request
Originally, backends (e.g. OSRM and Mapbox Directions API) don't support multiple routing profiles per single routing request. But the plugin overcomes the limitation, and it becomes possible to retrieve directions for a walk to a bus stop, then riding on a bus and then again walking from the next bus stop to the final destination all in one request!
### Customization
The powerful customization interface allows to customize everything starting from visual aspects all the way up to request logic.
### Standard Controls
Provides standard map-controls. Currently, there're only 2 of them (loading-indicator and bearings), but there are more to come.
### TypeScript support
The plugin is written 100% in TypeScript and therefore ships with built-in types.
## Installation
```shell
npm i @maplibre/maplibre-gl-directions
```
## Usage
```typescript
// Import the plugin
import MapLibreGlDirections, { LoadingIndicatorControl } from "@maplibre/maplibre-gl-directions";
// Make sure to create a MapLibreGlDirections instance only after the map is loaded
map.on("load", () => {
// Create an instance of the default class
const directions = new MapLibreGlDirections(map);
// Enable interactivity (if needed)
directions.interactive = true;
// Optionally add the standard loading-indicator control
map.addControl(new LoadingIndicatorControl(directions));
// Set the waypoints programmatically
directions.setWaypoints([
[-73.8271025, 40.8032906],
[-73.8671258, 40.82234996],
]);
// Remove waypoints
directions.removeWaypoint(0);
// Add waypoints
directions.addWaypoint([-73.8671258, 40.82234996], 0);
// Remove everything plugin-related from the map
directions.clear();
});
```
Check out the [Demo](https://maplibre.org/maplibre-gl-directions/#/) or dive right into the [API Docs](https://maplibre.org/maplibre-gl-directions/api) for more!
## Future plans
- Implement default control
- Write tests