Route

public protocol Route : AnyObject

Protocol specifying the Route object.

  • An instance of RouteDelegate.

    Declaration

    Swift

    var delegate: RouteDelegate? { get set }
  • tag

    A String to identify Route objects in the application.

    Declaration

    Swift

    var tag: String? { get set }

  • Unique ID of a route.

    Declaration

    Swift

    var routeID: UUID { get }

  • The coordinate region.

    Declaration

    Swift

    var bounds: CoordinateBounds { get }

  • Progress on route expressed in meters.

    Declaration

    Swift

    var progressOnRouteMeters: Double { get set }

  • A method for clearing route progress.

    Declaration

    Swift

    func clearProgress()

  • Provides information about the color of an unreachable route.

    Declaration

    Swift

    var unreachableColor: UIColor? { get }

  • Provides information about the route color.

    Declaration

    Swift

    var color: UIColor { get set }

  • Mark this Route as followable. Only one Route can be followed at a time. When this route is marked as followable, the previous one stops being followable.

    Declaration

    Swift

    func follow()

  • Mark this Route as non followable.

    Declaration

    Swift

    func unfollow()