Route

public class Route

Class specifying the Route object.

Important

This is a Public Preview API. It may be changed or removed at any time.

Public

  • Unique ID of a route.

    Declaration

    Swift

    public var routeID: UUID
  • tag

    A String to identify Route objects in the application.

    Declaration

    Swift

    public var tag: String?

  • Provides information about the color of an unreachable route.

    Declaration

    Swift

    public var unreachableColor: UIColor?

  • An instance of RouteDelegate.

    Declaration

    Swift

    public weak var delegate: RouteDelegate?

  • The coordinate region.

    Declaration

    Swift

    public var bounds: CoordinateBounds { get }

  • Progress on route expressed.

    Declaration

    Swift

    public var progressOnRoute: Measurement<UnitLength> { get set }

  • Provides information about the route color.

    Declaration

    Swift

    public var color: UIColor { get set }

  • A method for clearing route progress.

    Declaration

    Swift

    public func clearProgress()

  • 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

    public func follow()

  • Mark this Route as non followable.

    Declaration

    Swift

    public func unfollow()