public interface IsochroneService
| Modifier and Type | Method and Description |
|---|---|
retrofit2.Call<com.nbmap.geojson.FeatureCollection> |
getCall(java.lang.String user,
java.lang.String profile,
java.lang.String coordinates,
java.lang.String contoursMinutes,
java.lang.String accessToken,
java.lang.String contoursColors,
java.lang.Boolean polygons,
java.lang.Float denoise,
java.lang.Float generalize)
Constructs the HTTP request for the specified parameters.
|
@GET(value="/isochrone/v1/{user}/{profile}/{coordinates}")
retrofit2.Call<com.nbmap.geojson.FeatureCollection> getCall(@Path(value="user")
java.lang.String user,
@Path(value="profile")
java.lang.String profile,
@Path(value="coordinates")
java.lang.String coordinates,
@Query(value="contours_minutes")
java.lang.String contoursMinutes,
@Query(value="key")
java.lang.String accessToken,
@Query(value="contours_colors")
java.lang.String contoursColors,
@Query(value="polygons")
java.lang.Boolean polygons,
@Query(value="denoise")
java.lang.Float denoise,
@Query(value="generalize")
java.lang.Float generalize)
user - The username for the account that the Isochrone engine runs on.
In most cases, this should always remain the default value of
IsochroneCriteria.PROFILE_DEFAULT_USER.profile - A Nbmap Directions routing profile ID. Options are
IsochroneCriteria.PROFILE_DRIVING for travel times
by car, IsochroneCriteria.PROFILE_WALKING for pedestrian
and hiking travel times,and IsochroneCriteria.PROFILE_CYCLING
for travel times by bicycle.coordinates - A Point object which represents a
{longitude,latitude} coordinate pair around which to center
the isochrone lines.contoursMinutes - A single String which has a comma-separated time in minutes to use for
each isochrone contour.accessToken - A valid Nbmap access token.contoursColors - The colors to use for each isochrone contour, specified as hex values
without a leading # (for example, ff0000 for red). If this parameter is
used, there must be the same number of colors as there are entries in
contours_minutes. If no colors are specified, the Isochrone API will
assign a default rainbow color scheme to the output.polygons - Specify whether to return the contours as GeoJSON polygons (true) or
linestrings (false, default). When polygons=true, any contour that
forms a ring is returned as a polygon.denoise - A floating point value from 0.0 to 1.0 that can be used to remove
smaller contours. The default is 1.0. A value of 1.0 will only
return the largest contour for a given time value. A value of 0.5
drops any contours that are less than half the area of the largest
contour in the set of contours for that same time value.generalize - A positive floating point value in meters used as the tolerance for
Douglas-Peucker generalization. There is no upper bound. If no value is
specified in the request, the Isochrone API will choose the most
optimized generalization to use for the request. Note that the
generalization of contours can lead to self-intersections, as well
as intersections of adjacent contours.FeatureCollection in a Call wrapper