CircleAnnotation

 
public struct CircleAnnotation : 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 point backing this annotation

    Declaration

    Swift

    public var point: Point

  • 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

  • Handles tap gesture on this annotation.

    Should return true if the gesture is handled, or false to propagate it to the annotations or layers below.

    Declaration

    Swift

    public var tapHandler: ((MapContentGestureContext) -> Bool)? { get set }

  • Handles long press gesture on this annotation.

    Should return true if the gesture is handled, or false to propagate it to the annotations or layers below.

    Declaration

    Swift

    public var longPressHandler: ((MapContentGestureContext) -> Bool)? { get set }

  • Properties associated with the annotation

    Declaration

    Swift

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

  • Create a circle annotation with a Point and an optional identifier.

    Declaration

    Swift

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

  • Create a circle annotation with a center coordinate and an optional identifier

    Declaration

    Swift

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

    Parameters

    id

    Optional identifier for this annotation
    coordinate

    Coordinate where this circle annotation should be centered

Style Properties

  • 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 circleSortKey: Double?

  • Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity.

    Declaration

    Swift

    public var circleBlur: Double?

  • The fill color of the circle.

    Declaration

    Swift

    public var circleColor: StyleColor?

  • The opacity at which the circle will be drawn.

    Declaration

    Swift

    public var circleOpacity: Double?

  • Circle radius.

    Declaration

    Swift

    public var circleRadius: Double?

  • The stroke color of the circle.

    Declaration

    Swift

    public var circleStrokeColor: StyleColor?

  • The opacity of the circle’s stroke.

    Declaration

    Swift

    public var circleStrokeOpacity: Double?

  • The width of the circle’s stroke. Strokes are placed outside of the circle-radius.

    Declaration

    Swift

    public var circleStrokeWidth: Double?

  • 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

    @_documentation(visibility: public)
public func circleSortKey(_ newValue: Double) -> CircleAnnotation

  • Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity.

    Declaration

    Swift

    @_documentation(visibility: public)
public func circleBlur(_ newValue: Double) -> CircleAnnotation

  • The fill color of the circle.

    Declaration

    Swift

    @_documentation(visibility: public)
public func circleColor(_ newValue: StyleColor) -> CircleAnnotation

  • The opacity at which the circle will be drawn.

    Declaration

    Swift

    @_documentation(visibility: public)
public func circleOpacity(_ newValue: Double) -> CircleAnnotation

  • Circle radius.

    Declaration

    Swift

    @_documentation(visibility: public)
public func circleRadius(_ newValue: Double) -> CircleAnnotation

  • The stroke color of the circle.

    Declaration

    Swift

    @_documentation(visibility: public)
public func circleStrokeColor(_ newValue: StyleColor) -> CircleAnnotation

  • The opacity of the circle’s stroke.

    Declaration

    Swift

    @_documentation(visibility: public)
public func circleStrokeOpacity(_ newValue: Double) -> CircleAnnotation

  • The width of the circle’s stroke. Strokes are placed outside of the circle-radius.

    Declaration

    Swift

    @_documentation(visibility: public)
public func circleStrokeWidth(_ newValue: Double) -> CircleAnnotation

  • Adds a handler for tap gesture on current annotation.

    The handler should return true if the gesture is handled, or false to propagate it to the annotations or layers below.

    Parameters:

    • handler: A handler for tap gesture.

    Declaration

    Swift

    @_documentation(visibility: public)
public func onTapGesture(handler: @escaping (MapContentGestureContext) -> Bool) -> CircleAnnotation

  • Adds a handler for tap gesture on current annotation.

    Parameters:

    • handler: A handler for tap gesture.

    Declaration

    Swift

    @_documentation(visibility: public)
public func onTapGesture(handler: @escaping () -> Void) -> CircleAnnotation

  • Adds a handler for long press gesture on current annotation.

    The handler should return true if the gesture is handled, or false to propagate it to the annotations or layers below.

    Parameters:

    • handler: A handler for long press gesture.

    Declaration

    Swift

    @_documentation(visibility: public)
public func onLongPressGesture(handler: @escaping (MapContentGestureContext) -> Bool) -> CircleAnnotation

  • Adds a handler for long press gesture on current annotation.

    Parameters:

    • handler: A handler for long press gesture.

    Declaration

    Swift

    @_documentation(visibility: public)
public func onLongPressGesture(handler: @escaping () -> Void) -> CircleAnnotation