
iOS & macOS Charting Documentation - SciChart iOS & macOS Charts SDK v4.x
SCIAnnotationBase
@interface SCIAnnotationBase
: NSObject <ISCIAnnotation, ISCIChartSurfaceProvider>
Provides a base class for annotations to be rendered over the chart.
-
Defines the
SCIAnnotationCoordinateMode
to use when placing the annotation.Note
E.g. the default Absolute requires thatX1, Y1, X2, Y2
are data-values. The Relative requires thatX1, Y1, X2, Y2
are double values from 0.0 to 1.0.Declaration
Objective-C
@property (nonatomic) SCIAnnotationCoordinateMode coordinateMode;
-
Defines the
z-index
position for this annotation.Declaration
Objective-C
@property (nonatomic) int zIndex;
-
Defines the
ISCIResizingGrip
instance for this annotation.Declaration
Objective-C
@property (nonatomic, strong) id<ISCIResizingGrip> _Nonnull resizingGrip;
-
Defines the
ISCIAnnotationSelectionDrawable
instance for this annotation.Declaration
Objective-C
@property (nonatomic, strong) id<ISCIAnnotationSelectionDrawable> _Nonnull annotationSelectionDrawable;
-
Defines if a annotation should be clipped to it’s parrent
annotation surface
.Declaration
Objective-C
@property (nonatomic) BOOL clipAdornerToAnnotationSurface;
-
Determines whether the coordinate is valid for placing on the canvas, e.g. is greater than zero and less than
canvasMeasurement
.Declaration
Objective-C
- (BOOL)isCoordinateValid:(CGFloat)coord withSize:(CGFloat)size;
Parameters
coord
the coordinate.
size
The canvas dimension in this axis.
Return Value
YES - if coordinate is valid, otherwise - NO.
-
Gets the position of resizing grip with specified index
Declaration
Objective-C
- (CGPoint)getResizingGripPositionFor: (SCIAnnotationPointIndex)resizingGripIndex;
Parameters
resizingGripIndex
Index of resizing grip
Return Value
Position of resizing grip