com.mapbox.api.isochrone

Class MapboxIsochrone

java.lang.Object

com.mapbox.core.MapboxService<com.mapbox.geojson.FeatureCollection,IsochroneService>

com.mapbox.api.isochrone.MapboxIsochrone

public abstract class MapboxIsochrone
extends com.mapbox.core.MapboxService<com.mapbox.geojson.FeatureCollection,IsochroneService>

An isochrone, from the Greek root words iso (equal) and chrone (time), is a line that connects points of equal travel time around a given location. The Mapbox Isochrone API computes areas that are reachable within a specified amount of time from a location, and returns the reachable regions as contours of polygons or lines that you can display on a map.

Given a location and a routing profile, retrieve up to four isochrone contours. The contours are calculated using rasters and are returned as either polygon or line features, depending on your input setting for the polygons parameter.

The Isochrone API is limited to 300 requests per minute. The Isochrone API supports 1 coordinate per request. The Isochrone API can support a maximum of 4 isochrone contours per request. The maximum time that can be specified for an isochrone contour is 60 minutes. Results must be displayed on a Mapbox map using one of the Mapbox libraries or SDKs. If you require a higher rate limit, contact us.

Since:

4.6.0

See Also:

API documentation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapboxIsochrone.Builder This builder is used to create a new request to the Mapbox Isochrone API.

Field Summary

Fields inherited from class com.mapbox.core.MapboxService

MAX_URL_SIZE, okHttpClient

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MapboxIsochrone()

Method Summary

Modifier and Type	Method and Description
protected abstract java.lang.String	baseUrl()
static MapboxIsochrone.Builder	builder() Build a new MapboxIsochrone object with the initial value set for baseUrl().
protected com.google.gson.GsonBuilder	getGsonBuilder()
protected retrofit2.Call<com.mapbox.geojson.FeatureCollection>	initializeCall()

Methods inherited from class com.mapbox.core.MapboxService

cancelCall, cloneCall, enableDebug, enqueueCall, executeCall, getCall, getCallFactory, getOkHttpClient, getRetrofit, getService, isEnableDebug, setCallFactory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MapboxIsochrone

protected MapboxIsochrone()

Method Detail

getGsonBuilder

protected com.google.gson.GsonBuilder getGsonBuilder()

Overrides:

getGsonBuilder in class com.mapbox.core.MapboxService<com.mapbox.geojson.FeatureCollection,IsochroneService>

initializeCall

protected retrofit2.Call<com.mapbox.geojson.FeatureCollection> initializeCall()

Specified by:

initializeCall in class com.mapbox.core.MapboxService<com.mapbox.geojson.FeatureCollection,IsochroneService>

builder

public static MapboxIsochrone.Builder builder()

Build a new MapboxIsochrone object with the initial value set for baseUrl().

Returns:

a MapboxIsochrone.Builder object for creating this object

Since:

4.6.0

baseUrl

@NonNull
protected abstract java.lang.String baseUrl()

Specified by:

baseUrl in class com.mapbox.core.MapboxService<com.mapbox.geojson.FeatureCollection,IsochroneService>