RouteLegProgress Class Reference

leg

Returns the current RouteLeg.

Declaration

Swift

public let leg: RouteLeg

View Source on GitHub


                    
                    
                    stepIndex

Index representing the current step.

Declaration

Swift

public var stepIndex: Int

View Source on GitHub


                    
                    
                    distanceTraveled

Total distance traveled in meters along current leg.

Declaration

Swift

public var distanceTraveled: CLLocationDistance

View Source on GitHub


                    
                    
                    durationRemaining

Duration remaining in seconds on current leg.

Declaration

Swift

public var durationRemaining: TimeInterval

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

View Source on GitHub


                    
                    
                    alertUserLevel

AlertLevel for the current step.

Declaration

Swift

public var alertUserLevel: AlertLevel = .none

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?

View Source on GitHub


                    
                    
                    currentStep

Returns the current RouteStep for the leg the user is on.

Declaration

Swift

public var currentStep: RouteStep

View Source on GitHub


                    
                    
                    upComingStep

Returns the upcoming RouteStep.

If there is no upcomingStep, nil is returned.

Declaration

Swift

public var upComingStep: RouteStep?

View Source on GitHub


                    
                    
                    followOnStep

Returns step 2 steps ahead.

If there is no followOnStep, nil is returned.

Declaration

Swift

public var followOnStep: RouteStep?

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


                    
                    
                    init(leg:stepIndex:alertLevel:)

Intializes a new RouteLegProgress.

Declaration

Swift

public init(leg: RouteLeg, stepIndex: Int = 0, alertLevel: AlertLevel = .none)

Parameters

`leg`	Leg on a `Route`.
`stepIndex`	Current step the user is on.
`alertLevel`	Optional `AlertLevel` to start the `RouteProgress` at.

View Source on GitHub


                    
                    
                    nearbyCoordinates

Returns an array of CLLocationCoordinate2D of the prior, current and upcoming step geometry.

Declaration

Swift

public var nearbyCoordinates: [CLLocationCoordinate2D]

View Source on GitHub