Path

public final class Path : Element, Focusable

A Path is an Element that can show a route between two or more Coordinates on the map. This is used to help route a patron to their desired location.

  • The width of the Path, in Meters

    Declaration

    Swift

    public fileprivate(set) var width: Float { get }

  • The height of the Path in Meters

    Declaration

    Swift

    public fileprivate(set) var height: Float { get }

  • The color which the Path is drawn in

    Declaration

    Swift

    public fileprivate(set) var color: UIColor { get }

  • The color which the Path pulse is drawn in

    Declaration

    Swift

    public fileprivate(set) var pulseColor: UIColor { get }

  • How many path pulses to show before stopping the pulse None means unlimited

    Declaration

    Swift

    public fileprivate(set) var pulseLimit: Optional<Int> { get }

  • If the pulse is enabled or not.

    Declaration

    Swift

    public fileprivate(set) var pulseEnabled: Bool { get }

  • The time in second that it takes for the pulse to travel from the start of the path to the end.

    Declaration

    Swift

    public fileprivate(set) var pulseTime: Float { get }

  • Initialize a new Path object.

    Declaration

    Swift

    public init(points: [Coordinate],
            width: Float,
            height: Float,
            color: UIColor,
            pulseEnabled: Bool = false,
            pulseColor: UIColor = UIColor.white,
            pulseLimit: Optional<Int> = 10,
            pulseTime: Float = 2.0)

    Parameters

    points

    An array of Coordinates that describe the path
    width

    The width of the Path, in Meters
    height

    The height of the Path, in Meters
    color

    The color of the Path, see UIColor
    pulseEnabled

    if the path should have a pulse
    pulseColor

    the color of the pulse, defaults to white.
    pulseLimit

    A limit on the number of pulses, defaults to 10 a value of None will be unlimited.
    pulseSpeed

    The time in second that it takes for the pulse to travel from the start of the path to the end.