ViewAnnotationOptions

 
public struct ViewAnnotationOptions : Equatable

Stores layout and visibility settings for a view annotation.

Important

ViewAnnotationOptions is deprecated and will be removed in future releases. Use ViewAnnotation instead.

  • Undocumented

    Declaration

    Swift

    public var annotatedFeature: AnnotatedFeature?

  • View annotation width in pixels.

    Declaration

    Swift

    public var width: CGFloat?

  • View annotation height in pixels.

    Declaration

    Swift

    public var height: CGFloat?

  • If true, the annotation will be visible even if it collides with other previously drawn annotations. If allowOverlap is null, default value false will be applied. Note: When the value is true, the ordering of the views are determined by the order of their addition.

    Declaration

    Swift

    public var allowOverlap: Bool?

  • Specifies if this view annotation is visible or not.

    Note: If this property is not specified explicitly when creating / updating view annotation, visibility will be handled automatically based on the ViewAnnotation view’s visibility e.g. if actual view is set to be not visible the SDK will automatically update view annotation to have visible = false.

    If visible is null, default value true will be applied.

    Declaration

    Swift

    public var visible: Bool?

  • Undocumented

    Declaration

    Swift

    public var variableAnchors: [ViewAnnotationAnchorConfig]?

  • Specifies if this view annotation is selected meaning it should be placed on top of others. If selected in null, default value false will be applied.

    Declaration

    Swift

    public var selected: Bool?

  • Initializes a ViewAnnotationOptions

    Declaration

    Swift

    public init(
    annotatedFeature: AnnotatedFeature? = nil,
    width: CGFloat? = nil,
    height: CGFloat? = nil,
    allowOverlap: Bool? = nil,
    visible: Bool? = nil,
    selected: Bool? = nil,
    variableAnchors: [ViewAnnotationAnchorConfig]? = nil
)

  • Initializes a ViewAnnotationOptions with geometry.

    Declaration

    Swift

    @available(*, deprecated, message: "Use ViewAnnotation to create view annotations.")
public init(geometry: GeometryConvertible? = nil,
            width: CGFloat? = nil,
            height: CGFloat? = nil,
            associatedFeatureId: String? = nil,
            allowOverlap: Bool? = nil,
            visible: Bool? = nil,
            anchor: ViewAnnotationAnchor? = nil,
            offsetX: CGFloat? = nil,
            offsetY: CGFloat? = nil,
            selected: Bool? = nil)