https://github.com/mapbox/mapbox-isochrone

Isochrone generator built atop the Mapbox Matrix API, with CONREC polygonization.
https://github.com/mapbox/mapbox-isochrone

Last synced: 9 days ago
JSON representation

Isochrone generator built atop the Mapbox Matrix API, with CONREC polygonization.

• Host: GitHub
• URL: https://github.com/mapbox/mapbox-isochrone
• Owner: mapbox
• License: mit
• Created: 2017-05-18T22:07:42.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-01-10T20:49:32.000Z (almost 6 years ago)
• Last Synced: 2024-08-01T00:53:57.820Z (3 months ago)
• Language: JavaScript
• Size: 867 KB
• Stars: 119
• Watchers: 104
• Forks: 28
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# isochrone

Isochrone generator built atop the Mapbox Matrix API, with CONREC polygonization. Calculates isochrones up to 1 hour of travel time.

**[Demo!](https://www.mapbox.com/bites/00156/)**

## Setup

Clone the repository, and either

- include `dist/app.js` in your markup directly, or

- build your own via `browserify index.js -o `

For all pull requests that modify `isochrone.js`, please also rebuild  `dist/app.js` to make sure your changes get applied.

## Usage

`isochrone(origin, options, callback)`

- `origin`

Starting point for isochrone generation expressed as `[lng, lat]`.

- `options`

Parameter | Required? | Default | Limits | Description

--- | --- | --- |--- | ---

`token` | Yes | n/a | --- | 🔑 Mapbox user token

`threshold` | Yes | n/a | min:1, max: 3600 | ⌛️ Time thresholds for the desired ischrone(s), expressed in seconds. Can be expressed as either a) an array of numbers (e.g. `[600, 1200, 1800]`) to calculate isochrones at those specific time cutoffs, or b) a single number (e.g. `1800`) to calculate isochrones at 60-second intervals, up to that time

`mode` | No | `driving` | one of `driving`, `cycling`, or `walking` | 🚗 🚲 👟 Method of transportation desired, as defined in the Mapbox Matrix API [documentation](https://www.mapbox.com/api-documentation/navigation/#retrieve-a-matrix).

`direction` | No | `divergent` | `divergent` or `convergent` | ⬇️ ⬆️ Direction of travel. `Divergent` isochrones are the total area reachable _from_ the origin within the given time, while `convergent` ones cover the total area that _can_ reach it.

`resolution` | No | An `auto` value, computed from `mode` and maximum threshold | min:0.05, max: 5 | 📏 Granularity of the underlying sample grid, in units of kilometers. Lower values yield finer results, but are more expensive in both query time and API request load. Scaling this value with both time threshold and transport mode is recommended.

`batchSize` | No | 25 | min: 2 | 👨 👬 👨‍👦‍👦  Number of coordinates per Matrix API request. The default value applies for most Mapbox starter plans. Higher values will speed up computation and avoid rate-limiting issues.

- `callback`

Function to execute once the calculation completes.

## Example

This requests a set of isochrones at 1-minute intervals up to 30 minutes, from near Sacramento, CA:

```javascript

	isochrone([-121.4738,38.6194], {"token":, "threshold":1800}, function(err, output){

		if (err) throw err;

		console.log(output);

	})

```

## Output

Isochrones are returned as a GeoJSON featurecollection of polygon features. Each feature contains a `time` parameter that corresponds to its threshold in seconds.