Geoportal Resources Access API Reference

Namespace: RouteResponse

Gp.Services.RouteResponse

Response object for Gp.Services.route() invocation when successful. Received as the argument of onSuccess callback function.

Properties:
Name Type Description
bbox Gp.BBox

Bounding Box of the route. Given when provideBBox parameter is used in function call.

routeGeometry Object

Geometry (expressed in GeoJSON) of the route.

routeInstructions Array.<Gp.Services.Route.RouteInstruction>

Instructions of the route.

totalDistance Float

Length of the route. Expressed in km or m, depending on distanceUnit parameter.

totalTime Float

Route duration in seconds.