PolylineAnnotation

 
public struct PolylineAnnotation : Annotation, Equatable

Undocumented

  • id

    Identifier for this annotation

    Declaration

    Swift

    internal(set) public var id: String { get }

  • The geometry backing this annotation

    Declaration

    Swift

    public var geometry: Geometry { get }

  • The line string backing this annotation

    Declaration

    Swift

    public var lineString: LineString

  • Toggles the annotation’s selection state. If the annotation is deselected, it becomes selected. If the annotation is selected, it becomes deselected.

    Declaration

    Swift

    public var isSelected: Bool

  • Property to determine whether annotation can be manually moved around map

    Declaration

    Swift

    public var isDraggable: Bool

  • Properties associated with the annotation

    Declaration

    Swift

    public var userInfo: [String : Any]? { get set }

  • Create a polyline annotation with a LineString and an optional identifier.

    Declaration

    Swift

    public init(id: String = UUID().uuidString, lineString: LineString, isSelected: Bool = false, isDraggable: Bool = false)

  • Create a polyline annotation with an array of coordinates and an optional identifier.

    Declaration

    Swift

    public init(id: String = UUID().uuidString, lineCoordinates: [CLLocationCoordinate2D], isSelected: Bool = false, isDraggable: Bool = false)

Style Properties

  • The display of lines when joining.

    Declaration

    Swift

    public var lineJoin: LineJoin?

  • Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.

    Declaration

    Swift

    public var lineSortKey: Double?

  • Blur applied to the line, in pixels.

    Declaration

    Swift

    public var lineBlur: Double?

  • The color of the line border. If line-border-width is greater than zero and the alpha value of this color is 0 (default), the color for the border will be selected automatically based on the line color.

    Declaration

    Swift

    public var lineBorderColor: StyleColor?

  • The width of the line border. A value of zero means no border.

    Declaration

    Swift

    public var lineBorderWidth: Double?

  • The color with which the line will be drawn.

    Declaration

    Swift

    public var lineColor: StyleColor?

  • Draws a line casing outside of a line’s actual path. Value indicates the width of the inner gap.

    Declaration

    Swift

    public var lineGapWidth: Double?

  • The line’s offset. For linear features, a positive value offsets the line to the right, relative to the direction of the line, and a negative value to the left. For polygon features, a positive value results in an inset, and a negative value results in an outset.

    Declaration

    Swift

    public var lineOffset: Double?

  • The opacity at which the line will be drawn.

    Declaration

    Swift

    public var lineOpacity: Double?

  • Name of image in sprite to use for drawing image lines. For seamless patterns, image width must be a factor of two (2, 4, 8, …, 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.

    Declaration

    Swift

    public var linePattern: String?

  • Stroke thickness.

    Declaration

    Swift

    public var lineWidth: Double?

  • The display of lines when joining.

    Declaration

    Swift

     public func lineJoin(_ newValue: LineJoin) -> PolylineAnnotation

  • Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.

    Declaration

    Swift

     public func lineSortKey(_ newValue: Double) -> PolylineAnnotation

  • Blur applied to the line, in pixels.

    Declaration

    Swift

     public func lineBlur(_ newValue: Double) -> PolylineAnnotation

  • The color of the line border. If line-border-width is greater than zero and the alpha value of this color is 0 (default), the color for the border will be selected automatically based on the line color.

    Declaration

    Swift

     public func lineBorderColor(_ newValue: StyleColor) -> PolylineAnnotation

  • The width of the line border. A value of zero means no border.

    Declaration

    Swift

     public func lineBorderWidth(_ newValue: Double) -> PolylineAnnotation

  • The color with which the line will be drawn.

    Declaration

    Swift

     public func lineColor(_ newValue: StyleColor) -> PolylineAnnotation

  • Draws a line casing outside of a line’s actual path. Value indicates the width of the inner gap.

    Declaration

    Swift

     public func lineGapWidth(_ newValue: Double) -> PolylineAnnotation

  • The line’s offset. For linear features, a positive value offsets the line to the right, relative to the direction of the line, and a negative value to the left. For polygon features, a positive value results in an inset, and a negative value results in an outset.

    Declaration

    Swift

     public func lineOffset(_ newValue: Double) -> PolylineAnnotation

  • The opacity at which the line will be drawn.

    Declaration

    Swift

     public func lineOpacity(_ newValue: Double) -> PolylineAnnotation

  • Name of image in sprite to use for drawing image lines. For seamless patterns, image width must be a factor of two (2, 4, 8, …, 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.

    Declaration

    Swift

     public func linePattern(_ newValue: String) -> PolylineAnnotation

  • Stroke thickness.

    Declaration

    Swift

     public func lineWidth(_ newValue: Double) -> PolylineAnnotation

  • Handles annotation tap gesture.

    Declaration

    Swift

     public func onTapGesture(handler: @escaping () -> Void) -> PolylineAnnotation