RouteProgress

open class RouteProgress : Codable

RouteProgress stores the user’s progress along a route.


                    
                    
                    init(route:options:legIndex:spokenInstructionIndex:routeShapeIndex:legShapeIndex:)

Intializes a new RouteProgress.

Declaration

Swift

public init(route: Route, options: RouteOptions, legIndex: Int = 0, spokenInstructionIndex: Int = 0, routeShapeIndex: Int = 0, legShapeIndex: Int = 0)

Parameters

`route`	The route to follow.
`options`	The route options that were attached to the route request.
`legIndex`	Zero-based index indicating the current leg the user is on.
`routeShapeIndex`	Index relative to route shape, representing the point the user is currently located at.
`legShapeIndex`	Index relative to leg shape, representing the point the user is currently located at.

View Source on GitHub


                    
                    
                    reroutingOptions(from:)

Current RouteOptions, optimized for rerouting.

This method is useful for implementing custom rerouting. Resulting RouteOptions skip passed waypoints and include current user heading if possible.

Declaration

Swift

public func reroutingOptions(from location: CLLocation) -> RouteOptions

Parameters


                                  location

Current user location. Treated as route origin for rerouting.

Return Value

Modified RouteOptions.

View Source on GitHub

Route Statistics

routeOptions
Returns the current RouteOptions.
Declaration
Swift

public let routeOptions: RouteOptions
View Source on GitHub
distanceTraveled
Total distance traveled by user along all legs.
Declaration
Swift

public var distanceTraveled: CLLocationDistance { get }
View Source on GitHub
durationRemaining
Total seconds remaining on all legs.
Declaration
Swift

public var durationRemaining: TimeInterval { get }
View Source on GitHub
fractionTraveled
Number between 0 and 1 representing how far along the Route the user has traveled.
Declaration
Swift

public var fractionTraveled: Double { get }
View Source on GitHub
distanceRemaining
Total distance remaining in meters along route.
Declaration
Swift

public var distanceRemaining: CLLocationDistance { get }
View Source on GitHub
remainingWaypoints
The waypoints remaining on the current route.

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

public var remainingWaypoints: [Waypoint] { get }
View Source on GitHub
upcomingRouteAlerts
Upcoming RouteAlerts as reported by the navigation engine.

The contents of the array depend on user’s current progress along the route and are modified on each location update. This array contains only the alerts that the user has not passed. Some events may have non-zero length and are also included while the user is traversing it. You can use this property to get information about incoming points of interest.
Declaration
Swift

public internal(set) var upcomingRouteAlerts: [RouteAlert] { get }
View Source on GitHub
nearbyShape
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.
Declaration
Swift

public var nearbyShape: LineString { get }
View Source on GitHub

Updating the RouteProgress

route
Returns the current Route.
Declaration
Swift

public var route: Route
View Source on GitHub
refreshRoute(with:at:)
Updates the current route with attributes from the given skeletal route.
Declaration
Swift

public func refreshRoute(with refreshedRoute: RouteRefreshSource, at location: CLLocation)
View Source on GitHub


                    
                    
                    refreshRoute(with:at:legIndex:legShapeIndex:)

Declaration

Swift

public func refreshRoute(with refreshedRoute: RouteRefreshSource, at location: CLLocation, legIndex: Int, legShapeIndex: Int)

View Source on GitHub

shapeIndex
Index relative to route shape, representing the point the user is currently located at.
Declaration
Swift

public internal(set) var shapeIndex: Int { get }
View Source on GitHub


                    
                    
                    updateDistanceTraveled(with:)

Increments the progress according to new location specified.

Declaration

Swift

public func updateDistanceTraveled(with location: CLLocation)

Parameters


                                  location

Updated user location.

View Source on GitHub

Leg Statistics

legIndex
Index representing current RouteLeg.
Declaration
Swift

public var legIndex: Int { get set }
View Source on GitHub
currentLeg
If waypoints are provided in the Route, this will contain which leg the user is on.
Declaration
Swift

public var currentLeg: RouteLeg { get }
View Source on GitHub
remainingLegs
Returns the remaining legs left on the current route
Declaration
Swift

public var remainingLegs: [RouteLeg] { get }
View Source on GitHub
isFinalLeg
Returns true if currentLeg is the last leg.
Declaration
Swift

public var isFinalLeg: Bool { get }
View Source on GitHub
currentLegProgress
Returns the progress along the current RouteLeg.
Declaration
Swift

public var currentLegProgress: RouteLegProgress
View Source on GitHub
priorLeg
Declaration
Swift

public var priorLeg: RouteLeg? { get }
View Source on GitHub
upcomingLeg
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.
Declaration
Swift

public var upcomingLeg: RouteLeg? { get }
View Source on GitHub

Step Statistics

remainingSteps
Returns the remaining steps left on the current route
Declaration
Swift

public var remainingSteps: [RouteStep] { get }
View Source on GitHub
priorStep
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.
Declaration
Swift

public var priorStep: RouteStep? { get }
View Source on GitHub
upcomingStep
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.
Declaration
Swift

public var upcomingStep: RouteStep? { get }
View Source on GitHub

Leg Attributes

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

public typealias TimedCongestionLevel = (CongestionLevel, TimeInterval)
View Source on GitHub
congestionTravelTimesSegmentsByStep
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.
Declaration
Swift

public private(set) var congestionTravelTimesSegmentsByStep: [[[TimedCongestionLevel]]] { get }
View Source on GitHub
congestionTimesPerStep
An dictionary containing a TimeInterval total per CongestionLevel. Only CongestionLevel founnd on that step will present. Broken up by leg and then step.
Declaration
Swift

public private(set) var congestionTimesPerStep: [[[CongestionLevel : TimeInterval]]] { get }
View Source on GitHub


                    
                    
                    averageCongestionLevelRemainingOnLeg

Declaration

Swift

public var averageCongestionLevelRemainingOnLeg: CongestionLevel? { get }

View Source on GitHub

Codable Implementation


                    
                    
                    init(from:)

Declaration

Swift

required public init(from decoder: Decoder) throws

View Source on GitHub


                    
                    
                    encode(to:)

Declaration

Swift

public func encode(to encoder: Encoder) throws

View Source on GitHub