iOS & macOS Charting Documentation - SciChart iOS & macOS Charts SDK v4.x

SCIAnnotationCreationModifierBase

@interface SCIAnnotationCreationModifierBase : SCIGestureModifierBase

Undocumented

  • Gets the annotation type that this modifier creates. Set once at initialisation via initWithAnnotationType: and never changes.

    Declaration

    Objective-C

    @property (nonatomic, readonly) SCIAnnotationCreationType annotationType;

    Swift

    var annotationType: SCIAnnotationCreationType { get }
  • Gets or sets the ID of the X-Axis which this Annotation is measured against

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *xAxisId;

    Swift

    var xAxisId: String? { get set }
  • Gets or sets the ID of the Y-Axis which this Annotation is measured against

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *yAxisId;

    Swift

    var yAxisId: String? { get set }
  • tag

    Defines the tag for this modifier.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSString *tag;

    Swift

    var tag: String? { get set }
  • Defines the value indicating whether this annotation is editable or not.

    Declaration

    Objective-C

    @property (nonatomic) BOOL isEditable;

    Swift

    var isEditable: Bool { get set }
  • A completion block invoked once when the user finishes drawing an annotation. Receives the completed annotation and its type.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) SCIAnnotationCreationCompletionListener annotationCreationCompletionListener;

    Swift

    var annotationCreationCompletionListener: SCIAnnotationCreationCompletionListener? { get set }
  • Initialises the modifier with a fixed annotation type. This is the designated initialiser; annotationType cannot be changed after init.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithAnnotationType:
        (SCIAnnotationCreationType)annotationType;

    Swift

    init(annotationType: SCIAnnotationCreationType)