ISCIAnnotation Protocol Reference

xAxisId
Defines the ID of the X-Axis which this Annotation is measured against.

See
ISCIAxisCore.axisId.
Declaration
Objective-C

@property (nonatomic, copy) NSString *_Nonnull xAxisId;
Swift

var xAxisId: String { get set }
yAxisId
Defines the ID of the Y-Axis which this Annotation is measured against.

See
ISCIAxisCore.axisId.
Declaration
Objective-C

@property (nonatomic, copy) NSString *_Nonnull yAxisId;
Swift

var yAxisId: String { get set }


                        
                        
                        xAxis

Gets the X-Axis instance associated with this annotation.

Declaration

Objective-C

@property (nonatomic, weak, readonly, nullable) id<ISCIAxis> xAxis;

Swift

weak var xAxis: (any ISCIAxis)? { get }


                        
                        
                        yAxis

Gets the Y-Axis instance associated with this annotation.

Declaration

Objective-C

@property (nonatomic, weak, readonly, nullable) id<ISCIAxis> yAxis;

Swift

weak var yAxis: (any ISCIAxis)? { get }

Coordinates

x1
Defines the X1 Coordinate of the Annotation.

Note
For SCIAnnotationCoordinateMode.SCIAnnotationCoordinateMode_Absolute, this must be a data-value on the X-Axis such as a double for SCINumericAxis.

Note
For SCIAnnotationCoordinateMode.SCIAnnotationCoordinateMode_Relative, this must be a double value between 0.0 and 1.0, where 0.0 is the far left of the X-Axis and 1.0 is the far right.
Declaration
Objective-C

@property (nonatomic, strong) NS_REFINED_FOR_SWIFT id<ISCIComparable> x1;
y1
Defines the Y1 Coordinate of the Annotation.

Note
For SCIAnnotationCoordinateMode.SCIAnnotationCoordinateMode_Absolute, this must be a data-value on the Y-Axis such as a double for SCINumericAxis.

Note
For SCIAnnotationCoordinateMode.SCIAnnotationCoordinateMode_Relative, this must be a double value between 0.0 and 1.0, where 0.0 is the far top of the X-Axis and 1.0 is the far bottom.
Declaration
Objective-C

@property (nonatomic, strong) NS_REFINED_FOR_SWIFT id<ISCIComparable> y1;
x2
Defines the X2 Coordinate of the Annotation.

Note
For SCIAnnotationCoordinateMode.SCIAnnotationCoordinateMode_Absolute, this must be a data-value on the X-Axis such as a double for SCINumericAxis.

Note
For SCIAnnotationCoordinateMode.SCIAnnotationCoordinateMode_Relative, this must be a double value between 0.0 and 1.0, where 0.0 is the far left of the X-Axis and 1.0 is the far right.
Declaration
Objective-C

@property (nonatomic, strong) NS_REFINED_FOR_SWIFT id<ISCIComparable> x2;
y2
Defines the Y2 Coordinate of the Annotation.

Note
For SCIAnnotationCoordinateMode.SCIAnnotationCoordinateMode_Absolute, this must be a data-value on the Y-Axis such as a double for SCINumericAxis.

Note
For SCIAnnotationCoordinateMode.SCIAnnotationCoordinateMode_Relative, this must be a double value between 0.0 and 1.0, where 0.0 is the far top of the X-Axis and 1.0 is the far bottom.
Declaration
Objective-C

@property (nonatomic, strong) NS_REFINED_FOR_SWIFT id<ISCIComparable> y2;

Properties

isEnabled
Get whether this ISCIAnnotation instance is enabled for interaction.
Declaration
Objective-C

@property (nonatomic, readonly) BOOL isEnabled;
Swift

var isEnabled: Bool { get }
isSelected
Detines the value indicating whether this annotation is selected or not
Declaration
Objective-C

@property (nonatomic) BOOL isSelected;
Swift

var isSelected: Bool { get set }
isEditable
Defines the value indicating whether this annotation is editable or not.
Declaration
Objective-C

@property (nonatomic) BOOL isEditable;
Swift

var isEditable: Bool { get set }
isHidden
Defines the value indicating whether this annotation is hidden or not.
Declaration
Objective-C

@property (nonatomic) BOOL isHidden;
Swift

var isHidden: Bool { get set }
annotationSurface
Defines the Surface to place the annotation on. The default is SCIAnnotationSurfaceEnum.SCIAnnotationSurface_AboveChart.
Declaration
Objective-C

@property (nonatomic) SCIAnnotationSurfaceEnum annotationSurface;
Swift

var annotationSurface: SCIAnnotationSurfaceEnum { get set }
dragDirections
Defines the SCIDirection2D with the Drag direction for this annotation.
Declaration
Objective-C

@property (nonatomic) SCIDirection2D dragDirections;
Swift

var dragDirections: SCIDirection2D { get set }
resizeDirections
Defines the SCIDirection2D with the Resize direction for this annotation.
Declaration
Objective-C

@property (nonatomic) SCIDirection2D resizeDirections;
Swift

var resizeDirections: SCIDirection2D { get set }

Updates


                        
                        
                        -updateWithXAxis:yAxis:

Updates the coordinate calculators and refreshes the annotation position on the parent ISCIChartSurface.

Declaration

Objective-C

- (void)updateWithXAxis:(nonnull id<ISCIAxis>)xAxis
                  yAxis:(nonnull id<ISCIAxis>)yAxis;

Swift

func update(withXAxis xAxis: any ISCIAxis, yAxis: any ISCIAxis)

Parameters

`xAxis`	The `X-Axis` instance.
`yAxis`	The `Y-Axis` instance.

-show
Shows annotation which being hidden by -hide method.
Declaration
Objective-C

- (void)show;
Swift

func show()
-hide
Hides the Annotation by removing it and its adorner markers from the parent ISCIChartSurface.
Declaration
Objective-C

- (void)hide;
Swift

func hide()


                        
                        
                        -isCoordinates:inBounds:

Checks whether coordinates are within canvas bounds.

Declaration

Objective-C

- (BOOL)isCoordinates:(nonnull SCIAnnotationCoordinates *)coordinates
             inBounds:(CGRect)bounds;

Swift

func isCoordinates(_ coordinates: SCIAnnotationCoordinates, inBounds bounds: CGRect) -> Bool

Parameters

`coordinates`	The annotation coordinates.
`bounds`	The parent annotation surface bounds.

Return Value

YES - if annotation is in bounds.


                        
                        
                        -moveBasePointTo:atIndex:

This method is used in internally to set an adorner point position.

Declaration

Objective-C

- (void)moveBasePointTo:(CGPoint)point atIndex:(SCIAnnotationPointIndex)index;

Swift

func moveBasePoint(to point: CGPoint, at index: SCIAnnotationPointIndex)

Parameters

`point`	The new x-y coordinate of base point in pixels.
`index`	The index of base point to move.


                        
                        
                        -moveAnnotationByXDelta:yDelta:

This method is used in internally to move annotation in X and Y direction.

Declaration

Objective-C

- (void)moveAnnotationByXDelta:(CGFloat)xDelta yDelta:(CGFloat)yDelta;

Swift

func move(byXDelta xDelta: CGFloat, yDelta: CGFloat)

Parameters

`xDelta`	The horizontal offset in pixels.
`yDelta`	The vertical offset in pixels.

Drawing


                        
                        
                        -onDrawBelowSurfaceWithContext:assetManager:

Draws this ISCIAnnotation instance below chart series.

Declaration

Objective-C

- (void)
    onDrawBelowSurfaceWithContext:(nonnull id<ISCIRenderContext2D>)renderContext
                     assetManager:(nonnull id<ISCIAssetManager2D>)assetManager;

Swift

func onDrawBelowSurface(with renderContext: any ISCIRenderContext2D, assetManager: any ISCIAssetManager2D)

Parameters

`renderContext`	The render context instance to draw on.
`assetManager`	The asset manager associated with render context.


                        
                        
                        -onDrawAboveSurfaceWithContext:assetManager:

Draws this ISCIAnnotation instance above chart series.

Declaration

Objective-C

- (void)
    onDrawAboveSurfaceWithContext:(nonnull id<ISCIRenderContext2D>)renderContext
                     assetManager:(nonnull id<ISCIAssetManager2D>)assetManager;

Swift

func onDrawAboveSurface(with renderContext: any ISCIRenderContext2D, assetManager: any ISCIAssetManager2D)

Parameters

`renderContext`	The render context instance to draw on.
`assetManager`	The asset manager associated with render context.


                        
                        
                        -onDrawAboveGridWithContext:assetManager:

Draws this ISCIAnnotation instance above chart series.

Declaration

Objective-C

- (void)onDrawAboveGridWithContext:
            (nonnull id<ISCIRenderContext2D>)renderContext
                      assetManager:(nonnull id<ISCIAssetManager2D>)assetManager;

Swift

func onDrawAboveGrid(with renderContext: any ISCIRenderContext2D, assetManager: any ISCIAssetManager2D)

Parameters

`renderContext`	The render context instance to draw on.
`assetManager`	The asset manager associated with render context.


                        
                        
                        -onDrawOnAxisWithContext:assetManager:

Draws this ISCIAnnotation instance on one appropriate axis.

Declaration

Objective-C

- (void)onDrawOnAxisWithContext:(nonnull id<ISCIRenderContext2D>)renderContext
                   assetManager:(nonnull id<ISCIAssetManager2D>)assetManager;

Swift

func onDrawOnAxis(with renderContext: any ISCIRenderContext2D, assetManager: any ISCIAssetManager2D)

Parameters

`renderContext`	The render context instance to draw on.
`assetManager`	The asset manager associated with render context.

Selections

-onTrySelectAnnotation
Tries to select this ISCIAnnotation instance.
Declaration
Objective-C

- (BOOL)onTrySelectAnnotation;
Swift

func onTrySelect() -> Bool
Return Value

YES - if selection is successful.

Listeners


                        
                        
                        annotationDragListener

Defines the ISCIAnnotationDragListener which is called when drag event occurs on this annotation.

Declaration

Objective-C

@property (nonatomic, strong, nullable) id<ISCIAnnotationDragListener> annotationDragListener;

Swift

var annotationDragListener: (any ISCIAnnotationDragListener)? { get set }


                        
                        
                        annotationSelectionChangedListener

Sets the listener which is called when isSelected property changes.

Declaration

Objective-C

@property (nonatomic, strong, nullable) SCIAnnotationSelectionChangedListener annotationSelectionChangedListener;

Swift

var annotationSelectionChangedListener: SCIAnnotationSelectionChangedListener? { get set }


                        
                        
                        annotationIsHiddenChangedListener

Sets the listener which is called when isHidden property changes.

Declaration

Objective-C

@property (nonatomic, strong, nullable) SCIAnnotationIsHiddenChangedListener annotationIsHiddenChangedListener;

Swift

var annotationIsHiddenChangedListener: SCIAnnotationIsHiddenChangedListener? { get set }


                        
                        
                        axisAlignmentChangedListener

Defines the block to get notification about changes in LayoutManager.

Declaration

Objective-C

@property (nonatomic, strong, nullable) SCIAxisAlignmentChangedListener axisAlignmentChangedListener;

Swift

var axisAlignmentChangedListener: SCIAxisAlignmentChangedListener? { get set }