Install in Dash
RouteStepProgress Class Reference
RouteStepProgress
open class RouteStepProgress : CodableRouteStepProgress stores the user’s progress along a route step.
-
Returns the current
RouteStep.Declaration
Swift
public let step: RouteStep -
Returns distance user has traveled along current step.
Declaration
Swift
public var distanceTraveled: CLLocationDistance -
Returns distance from user to end of step.
Declaration
Swift
public var userDistanceToManeuverLocation: CLLocationDistance -
Total distance in meters remaining on current step.
Declaration
Swift
public var distanceRemaining: CLLocationDistance { get } -
Number between 0 and 1 representing fraction of current step traveled.
Declaration
Swift
public var fractionTraveled: Double { get } -
Number of seconds remaining on current step.
Declaration
Swift
public var durationRemaining: TimeInterval { get } -
Intializes a new
RouteStepProgress.Declaration
Swift
public init(step: RouteStep, spokenInstructionIndex: Int = 0)Parameters
stepStep on a
RouteLeg. -
All intersections on the current
RouteStepand also the first intersection on the upcomingRouteStep.The upcoming
RouteStepfirstIntersectionis added because it is omitted from the current step.Declaration
Swift
public var intersectionsIncludingUpcomingManeuverIntersection: [Intersection]? -
The next intersection the user will travel through.
The step must contain
intersectionsIncludingUpcomingManeuverIntersectionotherwise this property will benil.Declaration
Swift
public var upcomingIntersection: Intersection? { get } -
Index representing the current intersection.
Declaration
Swift
public var intersectionIndex: Int -
The current intersection the user will travel through.
The step must contain
intersectionsIncludingUpcomingManeuverIntersectionotherwise this property will benil.Declaration
Swift
public var currentIntersection: Intersection? { get } -
Returns an array of the calculated distances from the current intersection to the next intersection on the current step.
Declaration
Swift
public var intersectionDistances: Array<CLLocationDistance>? -
The distance in meters the user is to the next intersection they will pass through.
Declaration
Swift
public var userDistanceToUpcomingIntersection: CLLocationDistance? -
Index into
step.instructionsDisplayedAlongSteprepresenting the current visual instruction for the step.Declaration
Swift
public var visualInstructionIndex: Int -
An
Arrayof remainingVisualInstructionfor a step.Declaration
Swift
public var remainingVisualInstructions: [VisualInstructionBanner]? { get } -
Index into
step.instructionsSpokenAlongSteprepresenting the current spoken instruction.Declaration
Swift
public var spokenInstructionIndex: Int -
An
Arrayof remainingSpokenInstructionfor a step.Declaration
Swift
public var remainingSpokenInstructions: [SpokenInstruction]? { get } -
Current spoken instruction for the user’s progress along a step.
Declaration
Swift
public var currentSpokenInstruction: SpokenInstruction? { get } -
Current visual instruction for the user’s progress along a step.
Declaration
Swift
public var currentVisualInstruction: VisualInstructionBanner? { get }
View Source on GitHub