Step class

Each element in the steps array defines a single step of the calculated directions. A step is the most atomic unit of a direction's route, containing a single step describing a specific, single instruction on the journey. E.g. "Turn left at W. 4th St." The step not only describes the instruction but also contains distance and duration information relating to how this step relates to the following step. For example, a step denoted as "Merge onto I-80 West" may contain a duration of "37 miles" and "40 minutes," indicating that the next step is 37 miles/40 minutes from this step.

When using the Directions API to search for transit directions, the steps array will include additional transit details in the form of a transit_details array. If the directions include multiple modes of transportation, detailed directions will be provided for walking or driving steps in an inner steps array. For example, a walking step will include directions from the start and end locations: "Walk to Innes Ave & Fitch St". That step will include detailed walking directions for that route in the inner steps array, such as: "Head north-west", "Turn left onto Arelious Walker", and "Turn left onto Innes Ave".

Each step within the steps field(s) may contain the following fields:

  • instructions contains formatted instructions for this step, presented as a text string. (Corresponds to instructions in the Directions.Step interface.)

  • distance contains the distance covered by this step until the next step. (See the discussion of this field in Directions Legs above.) This field may be undefined if the distance is unknown.

  • duration contains the typical time required to perform the step, until the next step. (See the description in Directions Legs above.) This field may be undefined if the duration is unknown.

  • startLocation contains the location of the starting point of this step, as a single set of lat and lng fields.

  • endLocation contains the location of the last point of this step, as a single set of lat and lng fields.

  • path contains a sequence of GeoCoords describing the course of this step.

  • steps contains detailed directions for walking or driving steps in transit directions. Substeps are only available when travelMode is set to "transit". The inner steps array is of the same type as steps.

  • transitDetails contains transit specific information. This field is only returned with travelMode is set to "transit". See Transit Details below. (Corresponds to transit in the Directions.Step interface.)

  • travelMode contains the type of travel mode used.

Constructors

Step({Distance? distance, DirectionsDuration? duration, GeoCoord? endLocation, String? instructions, List<GeoCoord?>? path, GeoCoord? startLocation, List<Step>? steps, TransitDetails? transit, TravelMode? travelMode, OverviewPolyline? polyline})
const
Step.fromMap(Map<String, dynamic> map)
factory

Properties

distance → Distance?
Contains the distance covered by this step until the next step. This field may be undefined if the distance is unknown.
final
duration → DirectionsDuration?
Contains the typical time required to perform the step, until the next step. This field may be undefined if the duration is unknown.
final
endLocation → GeoCoord?
Contains the location of the last point of this step, as a single set of lat and lng fields.
final
hashCode → int
The hash code for this object.
no setterinherited
instructions → String?
Contains formatted instructions for this step, presented as a text string. (Corresponds to instructions in the directions_step_interface.)
final
path → List<GeoCoord?>?
Contains a sequence of GeoCoords describing the course of this step.
final
polyline → OverviewPolyline?
Contains a points describing the course of this step.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
startLocation → GeoCoord?
Contains the location of the starting point of this step, as a single set of lat and lng fields.
final
steps → List<Step>?
Contains detailed directions for walking or driving steps in transit directions. Substeps are only available when travelMode is set to "transit". The inner steps array is of the same type as steps.
final
transit → TransitDetails?
Contains transit specific information. This field is only returned with travelMode is set to "transit". See Transit Details below. (Corresponds to transit in the directions_step_interface.)
final
travelMode → TravelMode?
Contains the type of travel mode used.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited