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 String

Length of the route. If distanceUnit parameter was set to "km" (default), totalDistance is a string containing the total distance expressed in kilometers, followed by " Km" (e.g. : "19.6 Km"). If distanceUnit parameter was set to "m", totalDistance is a string containing the total distance expressed in meters (e.g. : "19599.14").

totalTime Float

Route duration in seconds.