RouteLegProgress

open class RouteLegProgress : Codable

RouteLegProgress stores the user’s progress along a route leg.

Details About the Leg

leg
Returns the current RouteLeg.
Declaration
Swift

public let leg: RouteLeg
View Source on GitHub
distanceTraveled
Total distance traveled in meters along current leg.
Declaration
Swift

public var distanceTraveled: CLLocationDistance { get }
View Source on GitHub
durationRemaining
Duration remaining in seconds on current leg.
Declaration
Swift

public var durationRemaining: TimeInterval { get }
View Source on GitHub
distanceRemaining
Distance remaining on the current leg.
Declaration
Swift

public var distanceRemaining: CLLocationDistance { get }
View Source on GitHub
fractionTraveled
Number between 0 and 1 representing how far along the current leg the user has traveled.
Declaration
Swift

public var fractionTraveled: Double { get }
View Source on GitHub

Details About the Leg’s Steps

stepIndex
Index representing the current step.
Declaration
Swift

public var stepIndex: Int { get set }
View Source on GitHub
remainingSteps
The remaining steps for user to complete.
Declaration
Swift

public var remainingSteps: [RouteStep] { get }
View Source on GitHub
stepBefore(_:)
Returns the RouteStep before a given step. Returns nil if there is no step prior.
Declaration
Swift

public func stepBefore(_ step: RouteStep) -> RouteStep?
View Source on GitHub
stepAfter(_:)
Returns the RouteStep after a given step. Returns nil if there is not a step after.
Declaration
Swift

public func stepAfter(_ step: RouteStep) -> RouteStep?
View Source on GitHub
priorStep
Returns the RouteStep before the current step.

If there is no priorStep, nil is returned.
Declaration
Swift

public var priorStep: RouteStep? { get }
View Source on GitHub
currentStep
Returns the current RouteStep for the leg the user is on.
Declaration
Swift

public var currentStep: RouteStep { get }
View Source on GitHub
followOnStep
Returns step 2 steps ahead.

If there is no followOnStep, nil is returned.
Declaration
Swift

public var followOnStep: RouteStep? { get }
View Source on GitHub
isCurrentStep(_:)
Return bool whether step provided is the current RouteStep the user is on.
Declaration
Swift

public func isCurrentStep(_ step: RouteStep) -> Bool
View Source on GitHub
currentStepProgress
Returns the progress along the current RouteStep.
Declaration
Swift

public var currentStepProgress: RouteStepProgress
View Source on GitHub
currentSpeedLimit
Returns the SpeedLimit for the current position along the route. Returns SpeedLimit.invalid if the speed limit is unknown or missing.

The maximum speed may be an advisory speed limit for segments where legal limits are not posted, such as highway entrance and exit ramps. If the speed limit along a particular segment is unknown, it is set to nil. If the speed is unregulated along the segment, such as on the German Autobahn system, it is represented by a measurement whose value is Double.infinity.

Speed limit data is available in a number of countries and territories worldwide.
Declaration
Swift

public var currentSpeedLimit: Measurement<UnitSpeed>? { get }
View Source on GitHub
shapeIndex
Index relative to leg shape, representing the point the user is currently located at.
Declaration
Swift

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


                    
                    
                    init(leg:stepIndex:spokenInstructionIndex:shapeIndex:intersectionIndex:)

Intializes a new RouteLegProgress.

Declaration

Swift

public init(leg: RouteLeg, stepIndex: Int = 0, spokenInstructionIndex: Int = 0, shapeIndex: Int = 0, intersectionIndex: Int = 0)

Parameters

`leg`	Leg on a `Route`.
`stepIndex`	Current step the user is on.
`shapeIndex`	Index relative to leg shape, representing the point the user is currently located at.

View Source on GitHub