Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/watergis/mapbox-gl-valhalla
This module adds a control which can integrate with valhalla api.
https://github.com/watergis/mapbox-gl-valhalla
Last synced: 2 months ago
JSON representation
This module adds a control which can integrate with valhalla api.
- Host: GitHub
- URL: https://github.com/watergis/mapbox-gl-valhalla
- Owner: watergis
- License: mit
- Created: 2021-04-04T12:38:37.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-06-22T14:35:57.000Z (over 1 year ago)
- Last Synced: 2024-10-30T05:43:06.275Z (3 months ago)
- Language: TypeScript
- Homepage: https://watergis.github.io/mapbox-gl-valhalla/
- Size: 4.3 MB
- Stars: 10
- Watchers: 3
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-maplibre - mapbox-gl-valhalla - Adds a control to provide isochrone features from valhalla server. (User Interface Plugins / JavaScript)
README
# mapbox-gl-valhalla
This module adds a control which can integrate with valhalla api.
## Installation:
```bash
npm i @watergis/mapbox-gl-valhalla --save
```
## Demo:
See [codesandbox](https://codesandbox.io/s/mapbox-gl-valhalla-nxmiw).
See [demo](https://watergis.github.io/mapbox-gl-valhalla/#12/-1.08551/35.87063).
## Usage:
```ts
import { MapboxValhallaControl} from "@watergis/mapbox-gl-valhalla";
import '@watergis/mapbox-gl-valhalla/css/styles.css';
import mapboxgl from 'mapbox-gl';
const map = new mapboxgl.Map();
map.addControl(new MapboxValhallaControl(
'http://localhost:8002',
{
Contours: [
{
time: 3,
distance: 1,
color: 'ff0000',
},
{
time: 5,
distance: 2,
color: 'ffff00',
},
{
time: 10,
distance: 3,
color: '0000ff',
},
]
}
), 'top-right');
```
### Options
You can specify default option as follows.
- URL
- Please specify your URL for valhalla services. eg. `http://localhost:8002`
- Contours
- See the specification of valhalla isochrone API [here](https://valhalla.readthedocs.io/en/latest/api/isochrone/api-reference/#inputs-of-the-isochrone-service).
- A JSON array of contour objects with the time in minutes in kilometers and color to use for each isochrone contour. You can specify up to four contours.
- default is as follows:
```js
[
{
time: 5,
distance: 1,
color: 'ff0000',
},
{
time: 10,
distance: 2,
color: 'ffff00',
},
{
time: 15,
distance: 3,
color: '0000ff',
},
]
```
## Development:
```
yarn run lint # check styling of source code
yarn run lint:fix # fix styling by eslint
yarn run dev
```
open [http://localhost:8080](http://localhost:8080).
If there are any changes on source code, it will be reflected automatically.
## Build package:
```
yarn run build
```
The modules will be generated under `dist` folder.
## Deploy to Github pages
```
yarn run deploy
```
It will deploy files under `example` folder to gh-pages.
## How to release
```zsh
npm version patch # it increase patch version 0.0.X
npm version minor # it increase minor version 0.x.0
npm version major # it increase major version x.0.0
git push origin main --tag
# release CI will create draft release in Github pages, then publish it if it is ready.
# publish CI will deploy npmjs and Github Packages.
```
## Contribution
This Mapbox GL Valhalla plugin is still under development. so most welcome any feedbacks and pull request to this repository.