Interface ITradingAnnotation
Defines the interface to a drawing tool, that is a special type of annotation, a custom drawable element over or under the SciChartSurface.
Namespace:
Assembly: .dll
Syntax
public interface ITradingAnnotationMethods
getBaseDataValues()
Gets the adorner data value positions
Declaration
public abstract tradingAnnotationsComparablePoint[] getBaseDataValues()Returns
| Type | Description |
|---|---|
| ComparablePoint[] | An array of ComparablePoint representing the base data values |
isCreated()
Gets whether the current annotation is created.
Declaration
public abstract boolean isCreated()Returns
| Type | Description |
|---|---|
| boolean | true if the annotation is created, false otherwise |
setAnnotationCreatedListener(tradingAnnotations.ITradingAnnotation.IAnnotationCreatedListener listener)
Sets the listener for annotation creation events
Declaration
public abstract void setAnnotationCreatedListener(tradingAnnotations.ITradingAnnotation.IAnnotationCreatedListener listener)Parameters
| Type | Name | Description |
|---|---|---|
| tradingAnnotations.ITradingAnnotation.IAnnotationCreatedListener | listener | The listener to set |
setBasePoint(Comparable<?> x, Comparable<?> y)
Called to set the base point at the specified position at (x) and (y). Programmatically sets an adorner point position. NOTICE: method should be called after annotation was added to SciChartSurface.Annotations collection.
Declaration
public abstract void setBasePoint(Comparable<?> x, Comparable<?> y)Parameters
| Type | Name | Description |
|---|---|---|
| Comparable<?> | x | The x data value |
| Comparable<?> | y | The y data value |
setCachedBasePoints()
Sets the cached base points for the annotation
Declaration
public abstract void setCachedBasePoints()updateBasePoint(int index, Comparable<?> x, Comparable<?> y)
Called to update the position of (index) point to a new position at (x) and (y). This method is used to update base points (and adorners also) that forces drawing tools annotation to re-draw.
Declaration
public abstract void updateBasePoint(int index, Comparable<?> x, Comparable<?> y)Parameters
| Type | Name | Description |
|---|---|---|
| int | index | The index of the base point to update |
| Comparable<?> | x | The new x data value |
| Comparable<?> | y | The new y data value |