GoogleNavigation Framework Reference

GMSNavigationStepInfo

@interface GMSNavigationStepInfo : NSObject

Information about a single step along a navigation route.

• maneuver

  The GMSNavigationManeuver for this step.

  Declaration

  Swift

  var maneuver: GMSNavigationManeuver { get }

  Objective-C

  @property (nonatomic, readonly) GMSNavigationManeuver maneuver;

• -maneuverImageWithOptions:

  The UIImage for the maneuver of this step using provided options. Default options values will be used if the options parameter is nil.

  Declaration

  Swift

  func maneuverImage(with options: GMSNavigationStepInfoImageOptions?) -> UIImage?

  Objective-C

  - (nullable UIImage *)maneuverImageWithOptions:
      (nullable GMSNavigationStepInfoImageOptions *)options;

  Return Value

  nil if there is no maneuver image for this step.

• lanes

  The different available lanes for this step.

  The array is ordered such that the first lane is on the left and last lane is on the right regardless of driving side.

  Declaration

  Swift

  var lanes: [GMSNavigationLane]? { get }

  Objective-C

  @property (nonatomic, readonly, nullable) NSArray<GMSNavigationLane *> *lanes;

  Return Value

  nil if there is no lane guidance for this step.

• -lanesImageWithOptions:

  The UIImage for the lane guidance of this step using provided options. Default options values will be used if the options parameter is nil.

  Declaration

  Swift

  func lanesImage(with options: GMSNavigationStepInfoImageOptions?) -> UIImage?

  Objective-C

  - (nullable UIImage *)lanesImageWithOptions:
      (nullable GMSNavigationStepInfoImageOptions *)options;

  Return Value

  nil if there is no lane guidance for this step.

• fullRoadName

  The full road name for this step containing all information for the road including direction.

  Examples (each line is a separate example):

  Lean Ave

  CA-85 / Mtn View

  Exit 9A / North First Street

  Declaration

  Swift

  var fullRoadName: String { get }

  Objective-C

  @property (nonatomic, readonly) NSString *_Nonnull fullRoadName;

• simpleRoadName

  The simplified version of the road name. This is shorter than the full road name and may not contain all pieces of identifying information about the road such as direction or name of exit.

  Examples (each line is a separate example):

  Lean Ave

  CA-85

  Exit 9A

  Declaration

  Swift

  var simpleRoadName: String { get }

  Objective-C

  @property (nonatomic, readonly) NSString *_Nonnull simpleRoadName;

• fullInstructionText

  The full text of the instruction for this step.

  Examples (each line is a separate example):

  Turn left onto Lean Ave.

  Use the right lane to take the CA-85 ramp to Mtn View.

  Use the 2nd from the right lane to take exit 9A toward North First Street.

  Declaration

  Swift

  var fullInstructionText: String { get }

  Objective-C

  @property (nonatomic, readonly) NSString *_Nonnull fullInstructionText;

• exitNumber

  Exit number of this step if it exists.

  Declaration

  Swift

  var exitNumber: String? { get }

  Objective-C

  @property (nonatomic, readonly, nullable) NSString *exitNumber;

• drivingSide

  Whether this step is on a drive-on-right or drive-on-left route.

  Declaration

  Swift

  var drivingSide: GMSNavigationDrivingSide { get }

  Objective-C

  @property (nonatomic, readonly) GMSNavigationDrivingSide drivingSide;

• roundaboutTurnNumber

  The counted number of the exit to take relative to the location where the roundabout was entered. Only set for roundabouts, otherwise -1.

  Declaration

  Swift

  var roundaboutTurnNumber: Int { get }

  Objective-C

  @property (nonatomic, readonly) NSInteger roundaboutTurnNumber;

• stepNumber

  The index of the step in the list of all steps in the route. The first step has step number 0.

  Declaration

  Swift

  var stepNumber: Int { get }

  Objective-C

  @property (nonatomic, readonly) NSInteger stepNumber;

• distanceFromPrevStepMeters

  The total distance of this step. This value does not change.

  Declaration

  Swift

  var distanceFromPrevStepMeters: CLLocationDistance { get }

  Objective-C

  @property (nonatomic, readonly) CLLocationDistance distanceFromPrevStepMeters;

• timeFromPrevStepSeconds

  The estimated time it takes to complete this step. This value does not change.

  Declaration

  Swift

  var timeFromPrevStepSeconds: TimeInterval { get }

  Objective-C

  @property (nonatomic, readonly) NSTimeInterval timeFromPrevStepSeconds;

• -init

  Unavailable

  Declaration

  Objective-C

  - (null_unspecified instancetype)init NS_UNAVAILABLE;