Path

public struct Path : Codable

Path holds the properties of values to be set when path is drawn

  • Color of the path drawn

    Declaration

    Swift

    public var color: String?
  • Pulse color of the path drawn

    Declaration

    Swift

    public var pulseColor: String?
  • Near radius of the path drawn (in meters since V4)

    Declaration

    Swift

    public var nearRadius: Double?
  • Far radius of the path drawn (in meters since V4)

    Declaration

    Swift

    public var farRadius: Double?
  • Duration of drawing

    Declaration

    Swift

    public var drawDuration: Double?
  • Whether to draw connection segments

    Declaration

    Swift

    public var drawConnectionSegments: Bool?
  • Set the pulse interations

    Declaration

    Swift

    public var pulseIterations: Double?
  • Set properties for connection path

    Declaration

    Swift

    public var connectionPathOptions: ConnectionPath?
  • Whether to display arrow on path drawn

    Declaration

    Swift

    public var displayArrowsOnPath: Bool?
  • Construct a MPIOptions.Path object with the given properties

    Declaration

    Swift

    public init(
        color: String? = nil,
        pulseColor: String? = nil,
        nearRadius: Double? = nil,
        farRadius: Double? = nil,
        drawDuration: Double? = nil,
        drawConnectionSegments: Bool? = nil,
        pulseIterations: Double? = nil,
        connectionPathOptions: ConnectionPath? = nil,
        displayArrowsOnPath: Bool? = nil
    )

    Parameters

    color

    color of the path

    pulseColor

    pulse color of the path

    nearRadius

    near radius of the path

    farRadius

    far radius of the path

    drawDuration

    duration of the drawing

    drawConnectionSegments

    whether to draw connection segments

    pulseIterations

    iterations of the pulse

    connectionPathOptions

    properties for connection path

    displayArrowsOnPath

    whether to display arrows on path