RouteProgress

RouteProgress stores the user’s progress along a route.

  • Returns the current Route.

  • Index representing current RouteLeg.

  • If waypoints are provided in the Route, this will contain which leg the user is on.

  • Returns the remaining legs left on the current route

  • Returns the remaining steps left on the current route

  • Returns true if currentLeg is the last leg.

  • Total distance traveled by user along all legs.

  • Total seconds remaining on all legs.

  • Number between 0 and 1 representing how far along the Route the user has traveled.

  • Total distance remaining in meters along route.

  • The waypoints remaining on the current route.

    This property does not include waypoints whose Waypoint.separatesLegs property is set to false.

  • Returns the progress along the current RouteLeg.

  • The step prior to the current step along this route.

    The prior step may be part of a different RouteLeg than the current step. If the current step is the first step along the route, this property is set to nil.

  • The leg following the current leg along this route.

    If this leg is the last leg of the route, this property is set to nil.

  • The step following the current step along this route.

    The upcoming step may be part of a different RouteLeg than the current step. If it is the last step along the route, this property is set to nil.

  • Returns an array of CLLocationCoordinate2D of the coordinates along the current step and any adjacent steps.

    Important

    The adjacent steps may be part of legs other than the current leg.

  • Tuple containing a CongestionLevel and a corresponding TimeInterval representing the expected travel time for this segment.

  • If the route contains both segmentCongestionLevels and expectedSegmentTravelTimes, this property is set to a deeply nested array of TimeCongestionLevels per segment per step per leg.

  • An dictionary containing a TimeInterval total per CongestionLevel. Only CongestionLevel founnd on that step will present. Broken up by leg and then step.

  • Intializes a new RouteProgress.

  • An index into the route’s coordinates and congestionTravelTimesSegmentsByStep that corresponds to a step’s maneuver location.