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

ISCITradingAnnotation

@protocol ISCITradingAnnotation <NSObject>

@required

/// Sets the listener for annotation creation events.
- (void)setAnnotationCreatedListener:(id<ISCIAnnotationCreatedListener>)listener;

/// Returns YES if the annotation has been fully created.
- (BOOL)isCreated;

/// Appends a new base point (x, y).
- (void)setBasePointWithX:(id<ISCIComparable>)x y:(id<ISCIComparable>)y;

/// Updates the base point at the given index to a new (x, y).
- (void)updateBasePointAtIndex:(NSInteger)index x:(id<ISCIComparable>)x y:(id<ISCIComparable>)y;

/// Returns base-point positions in data-space.
- (NSArray<SCIComparablePoint *> *)getBaseDataValues;

/**
 * Returns pixel-space base points.
 * Respects horizontal vs. vertical axis orientation.
 */
- (NSArray<SCIComparablePoint *> *)getBasePoints;

/// Re-applies cached base points after a timeframe change.
- (void)setCachedBasePoints;

@end

Undocumented


                        
                        
                        -setAnnotationCreatedListener:

Sets the listener for annotation creation events.

Declaration

Objective-C

- (void)setAnnotationCreatedListener:
    (nonnull id<ISCIAnnotationCreatedListener>)listener;

Swift

func setAnnotationCreatedListener(_ listener: any ISCIAnnotationCreatedListener)

-isCreated
Returns YES if the annotation has been fully created.
Declaration
Objective-C

- (BOOL)isCreated;
Swift

func isCreated() -> Bool


                        
                        
                        -setBasePointWithX:y:

Appends a new base point (x, y).

Declaration

Objective-C

- (void)setBasePointWithX:(nonnull id<ISCIComparable>)x
                        y:(nonnull id<ISCIComparable>)y;

Swift

func setBasePointWithX(_ x: any ISCIComparable, y: any ISCIComparable)


                        
                        
                        -updateBasePointAtIndex:x:y:

Updates the base point at the given index to a new (x, y).

Declaration

Objective-C

- (void)updateBasePointAtIndex:(NSInteger)index
                             x:(nonnull id<ISCIComparable>)x
                             y:(nonnull id<ISCIComparable>)y;

Swift

func updateBasePoint(at index: Int, x: any ISCIComparable, y: any ISCIComparable)


                        
                        
                        -getBaseDataValues

Returns base-point positions in data-space.

Declaration

Objective-C

- (nonnull NSArray<SCIComparablePoint *> *)getBaseDataValues;

Swift

func getBaseDataValues() -> [SCIComparablePoint]

-getBasePoints
Returns pixel-space base points. Respects horizontal vs. vertical axis orientation.
Declaration
Objective-C

- (nonnull NSArray<SCIComparablePoint *> *)getBasePoints;
Swift

func getBasePoints() -> [SCIComparablePoint]
-setCachedBasePoints
Re-applies cached base points after a timeframe change.
Declaration
Objective-C

- (void)setCachedBasePoints;
Swift

func setCachedBasePoints()