Mapbox Navigation SDK for iOS Docs Navigation SDK for iOS Reference

View on GitHub

Install in Dash

Mapbox Navigation SDK for iOS Reference Configuration Reference
  • Guides
    • Storyboards
  • Turn-by-turn UI
    • NavigationViewController
    • NavigationViewControllerDelegate
    • RouteVoiceController
  • Core Navigation Logic
    • RouteController
    • RouteControllerDelegate
    • RouteProgress
    • RouteLegProgress
    • RouteStepProgress
  • Maps
    • NavigationMapView
    • MGLMapView
  • Styling
    • Style
  • Formatters
    • DistanceFormatter
  • Notifications
    • AlertLevel
    • RouteControllerAlertLevelDidChange
    • RouteControllerAlertLevelDidChangeNotificationDistanceToEndOfManeuverKey
    • RouteControllerAlertLevelDidChangeNotificationRouteProgressKey
    • RouteControllerDidFailToReroute
    • RouteControllerDidReroute
    • RouteControllerNotificationErrorKey
    • RouteControllerNotificationLocationKey
    • RouteControllerNotificationRouteKey
    • RouteControllerProgressDidChange
    • RouteControllerProgressDidChangeNotificationLocationKey
    • RouteControllerProgressDidChangeNotificationProgressKey
    • RouteControllerProgressDidChangeNotificationSecondsRemainingOnStepKey
    • RouteControllerWillReroute
  • Configuration
    • MaxSecondsSpentTravelingAwayFromStartOfRoute
    • RouteControllerDeadReckoningTimeInterval
    • RouteControllerHighAlertInterval
    • RouteControllerManeuverZoneRadius
    • RouteControllerMaxManipulatedCourseAngle
    • RouteControllerMaximumAllowedDegreeOffsetForTurnCompletion
    • RouteControllerMaximumDistanceBeforeRecalculating
    • RouteControllerMediumAlertInterval
    • RouteControllerMinimumDistanceForHighAlertCycling
    • RouteControllerMinimumDistanceForHighAlertDriving
    • RouteControllerMinimumDistanceForHighAlertWalking
    • RouteControllerMinimumDistanceForMediumAlertCycling
    • RouteControllerMinimumDistanceForMediumAlertDriving
    • RouteControllerMinimumDistanceForMediumAlertWalking
    • RouteControllerUserLocationSnappingDistance
  • Other Classes
    • DefaultStyle
    • NavigationLocationManager
    • PollyVoiceController
    • ReplayLocationManager
    • SimulatedLocationManager
  • Other Functions
    • RouteControllerMinimumDistanceForHighAlert(identifier:)
    • RouteControllerMinimumDistanceForMediumAlert(identifier:)
    • wrap(_:min:max:)

Configuration

  • MaxSecondsSpentTravelingAwayFromStartOfRoute

    Maximum number of seconds the user can travel away from the start of the route before rerouting occurs

    Declaration

    Swift

    public var MaxSecondsSpentTravelingAwayFromStartOfRoute: TimeInterval = 3
    View Source on GitHub
  • RouteControllerDeadReckoningTimeInterval

    When calculating whether or not the user is on the route, we look where the user will be given their speed and this variable.

    Declaration

    Swift

    public var RouteControllerDeadReckoningTimeInterval:TimeInterval = 1.0
    View Source on GitHub
  • RouteControllerHighAlertInterval

    Number of seconds left on step when a high alert is emitted.

    Declaration

    Swift

    public var RouteControllerHighAlertInterval: TimeInterval = 15
    View Source on GitHub
  • RouteControllerManeuverZoneRadius

    Radius in meters the user must enter to count as completing a step. One of two heuristics used to know when a user completes a step, see RouteControllerMaximumAllowedDegreeOffsetForTurnCompletion.

    Declaration

    Swift

    public var RouteControllerManeuverZoneRadius: CLLocationDistance = 40
    View Source on GitHub
  • RouteControllerMaxManipulatedCourseAngle

    Maximum angle the user puck will be rotated when snapping the user’s course to the route line.

    Declaration

    Swift

    public var RouteControllerMaxManipulatedCourseAngle:CLLocationDirection = 25
    View Source on GitHub
  • RouteControllerMaximumAllowedDegreeOffsetForTurnCompletion

    Threshold user must be in within to count as completing a step. One of two heuristics used to know when a user completes a step, see RouteControllerManeuverZoneRadius.

    The users heading and the finalHeading are compared. If this number is within RouteControllerMaximumAllowedDegreeOffsetForTurnCompletion, the user has completed the step.

    Declaration

    Swift

    public var RouteControllerMaximumAllowedDegreeOffsetForTurnCompletion: Double = 30
    View Source on GitHub
  • RouteControllerMaximumDistanceBeforeRecalculating

    Maximum number of meters the user can travel away from step before RouteControllerShouldReroute is emitted.

    Declaration

    Swift

    public var RouteControllerMaximumDistanceBeforeRecalculating: CLLocationDistance = 50
    View Source on GitHub
  • RouteControllerMediumAlertInterval

    Number of seconds left on step when a medium alert is emitted.

    Declaration

    Swift

    public var RouteControllerMediumAlertInterval: TimeInterval = 70
    View Source on GitHub
  • RouteControllerMinimumDistanceForHighAlertCycling

    Distance in meters for the minimum length of a step for giving a high alert while using MBDirectionsProfileIdentifierCycling.

    Declaration

    Swift

    public var RouteControllerMinimumDistanceForHighAlertCycling: CLLocationDistance = 60
    View Source on GitHub
  • RouteControllerMinimumDistanceForHighAlertDriving

    Distance in meters for the minimum length of a step for giving a high alert while using MBDirectionsProfileIdentifierAutomobile or MBDirectionsProfileIdentifierAutomobileAvoidingTraffic.

    Declaration

    Swift

    public var RouteControllerMinimumDistanceForHighAlertDriving: CLLocationDistance = 100
    View Source on GitHub
  • RouteControllerMinimumDistanceForHighAlertWalking

    Distance in meters for the minimum length of a step for giving a high alert while using MBDirectionsProfileIdentifierWalking.

    Declaration

    Swift

    public var RouteControllerMinimumDistanceForHighAlertWalking: CLLocationDistance = 20
    View Source on GitHub
  • RouteControllerMinimumDistanceForMediumAlertCycling

    Distance in meters for the minimum length of a step for giving a medium alert while using MBDirectionsProfileIdentifierCycling.

    Declaration

    Swift

    public var RouteControllerMinimumDistanceForMediumAlertCycling: CLLocationDistance = 200
    View Source on GitHub
  • RouteControllerMinimumDistanceForMediumAlertDriving

    Distance in meters for the minimum length of a step for giving a medium alert while using MBDirectionsProfileIdentifierAutomobile or MBDirectionsProfileIdentifierAutomobileAvoidingTraffic.

    Declaration

    Swift

    public var RouteControllerMinimumDistanceForMediumAlertDriving: CLLocationDistance = 400
    View Source on GitHub
  • RouteControllerMinimumDistanceForMediumAlertWalking

    Distance in meters for the minimum length of a step for giving a medium alert while using MBDirectionsProfileIdentifierWalking.

    Declaration

    Swift

    public var RouteControllerMinimumDistanceForMediumAlertWalking: CLLocationDistance = 100
    View Source on GitHub
  • RouteControllerUserLocationSnappingDistance

    Accepted deviation excluding horizontal accuracy before the user is considered to be off route.

    Declaration

    Swift

    public var RouteControllerUserLocationSnappingDistance: CLLocationDistance = 10
    View Source on GitHub

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.8.2, a Realm project.