Structure

RouteStep

A single route between a requested start and end point.

Declaration

dictionary RouteStep {
    mapkit.Coordinate[] path;
    String instructions;
    Number distance;
    mapkit.Directions.Transport transportType;
};

Overview

A RouteStep encapsulates information for a discrete segment of a route. A Route object's steps property is an array of RouteStep objects. RouteStep objects can't be instantiated directly; they are returned in the DirectionsResponse.

Topics

Route Step Geometry

path

An array of coordinate objects representing the path of the route segment.

Route Step Details

instructions

The written instructions for following the path represented by the step.

distance

The step distance in meters.

transportType

The transport type of the step.

mapkit.Directions.Transport

The modes of transportation.

See Also

Getting Directions

route

Retrieves directions and estimated travel time based on the specified start and end points.

DirectionsRequest

The requested start and end points for a route, as well as the planned mode of transportation.

DirectionsResponse

The directions and estimated travel time returned for a route.

Route

Information about a route, including step-by-step instructions, distance, and estimated travel time.