public interface IAnnotation extends com.scichart.core.IServiceProvider, IThemeable, com.scichart.core.framework.ISuspendable, com.scichart.core.framework.IAttachable, IAdornerProvider, IStrategyManagerListener, ILayoutManagerListener
SciChartSurface
Modifier and Type | Method and Description |
---|---|
Direction2D |
getDragDirections()
Gets the
Direction2D with the Drag direction for this annotation |
boolean |
getIsEditable()
Gets the value indicating whether this annotation is editable or not
|
Direction2D |
getResizeDirections()
Gets the
Direction2D with the Resize direction for this annotation |
java.lang.Comparable |
getX1()
Gets the X1 Coordinate of the Annotation.
|
java.lang.Comparable |
getX2()
Gets the X2 Coordinate of the Annotation.
|
IAxis |
getXAxis()
Gets the XAxis instance associated with this annotation
|
java.lang.String |
getXAxisId()
Gets the XAxis Id that this annotation is measured against.
|
java.lang.Comparable |
getY1()
Gets the Y1 Coordinate of the Annotation.
|
java.lang.Comparable |
getY2()
Gets the Y2 Coordinate of the Annotation.
|
IAxis |
getYAxis()
Gets the YAxis instance associated with this annotation
|
java.lang.String |
getYAxisId()
Gets the YAxis Id that this annotation is measured against.
|
void |
hide()
Hides the Annotation by removing it and its adorner markers from the parent
ISciChartSurface |
boolean |
isEditable()
Deprecated.
|
boolean |
isHidden()
Gets the value indicating whether this annotation is hidden or not
|
boolean |
isSelected()
Gets the value indicating whether this annotation is selected or not
|
void |
moveAnnotation(float horizOffset,
float vertOffset)
This method is used in internally to move annotation in X and Y direction
|
void |
moveBasePointTo(float xCoord,
float yCoord,
int index)
This method is used in internally to set an adorner point position
|
void |
onXAxesCollectionChanged(com.scichart.core.observable.CollectionChangedEventArgs<IAxis> args)
Called when parent
SciChartSurface.getXAxes() collection changes |
void |
onXAxesDrasticallyChanged(ISciChartSurface surface)
Called when parent
SciChartSurface.getXAxes() collection drastically changed |
void |
onYAxesCollectionChanged(com.scichart.core.observable.CollectionChangedEventArgs<IAxis> args)
Called when parent
SciChartSurface.getYAxes() collection changes |
void |
onYAxesDrasticallyChanged(ISciChartSurface surface)
Called when parent
SciChartSurface.getYAxes() collection drastically changed |
void |
refresh()
Refreshes the annotation position on the parent
ISciChartSurface , without causing a full redraw of the chart |
void |
setDragDirections(Direction2D dragDirections)
Sets the
Direction2D with the Drag direction for this annotation |
void |
setIsEditable(boolean isEditable)
Sets the value indicating whether this annotation is editable or not
|
void |
setIsHidden(boolean isHidden)
Sets the value indicating whether this annotation is hidden or not
|
void |
setOnAnnotationDragListener(OnAnnotationDragListener listener)
Sets the
OnAnnotationDragListener which is called when drag event occurs on this annotation |
void |
setOnAnnotationIsHiddenChangeListener(OnAnnotationIsHiddenChangeListener listener)
Sets the
OnAnnotationIsHiddenChangeListener which is called when isHidden() property changes |
void |
setOnAnnotationSelectionChangeListener(OnAnnotationSelectionChangeListener listener)
Sets the
OnAnnotationSelectionChangeListener which is called when isSelected() property changes |
void |
setResizeDirections(Direction2D resizeDirections)
Sets the
Direction2D with the Resize direction for this annotation |
void |
setSelected(boolean isSelected)
Sets the value indicating whether this annotation is selected or not
|
void |
setX1(java.lang.Comparable value)
Sets the X1 Coordinate of the Annotation.
|
void |
setX2(java.lang.Comparable value)
Sets the X2 Coordinate of the Annotation.
|
void |
setXAxisId(java.lang.String xAxisId)
Sets the XAxis Id that this annotation is measured against.
|
void |
setY1(java.lang.Comparable value)
Sets the Y1 Coordinate of the Annotation.
|
void |
setY2(java.lang.Comparable value)
Sets the Y2 Coordinate of the Annotation.
|
void |
setYAxisId(java.lang.String yAxisId)
Sets the YAxis Id that this annotation is measured against.
|
void |
show()
Shows annotation which being hidden by
hide() call |
void |
update(IAxis xAxis,
IAxis yAxis)
Updates the coordinate calculators and refreshes the annotation position on the parent
ISciChartSurface |
applyThemeProvider
decrementSuspend, getIsSuspended, resumeUpdates, suspendUpdates
attachTo, detach, isAttached
onDragDelta, onDragEnded, onDragStarted, onDrawAdorner, updateAdorner
onStrategyManagerChanged
onAxisAlignmentChanged
java.lang.String getXAxisId()
IAxisCore.getAxisId()
void setXAxisId(java.lang.String xAxisId)
xAxisId
- The XAxis IdIAxisCore.getAxisId()
java.lang.String getYAxisId()
IAxisCore.getAxisId()
void setYAxisId(java.lang.String yAxisId)
yAxisId
- The YAxis IdIAxisCore.getAxisId()
IAxis getXAxis()
IAxis getYAxis()
void setX1(java.lang.Comparable value)
AnnotationCoordinateMode.Absolute
, this must be a data-value on the XAxis such as a double for NumericAxis
For AnnotationCoordinateMode.Relative
, this must be a double value between 0.0 and 1.0, where 0.0 is the far left of the XAxis and 1.0 is the far right.value
- The X1 Coordinate valuejava.lang.Comparable getX1()
void setY1(java.lang.Comparable value)
AnnotationCoordinateMode.Absolute
, this must be a data-value on the YAxis such as a double for NumericAxis
For AnnotationCoordinateMode.Relative
, this must be a double value between 0.0 and 1.0, where 0.0 is the far left of the YAxis and 1.0 is the far right.value
- The Y1 Coordinate valuejava.lang.Comparable getY1()
void setX2(java.lang.Comparable value)
AnnotationCoordinateMode.Absolute
, this must be a data-value on the XAxis such as a double for NumericAxis
For AnnotationCoordinateMode.Relative
, this must be a double value between 0.0 and 1.0, where 0.0 is the far left of the XAxis and 1.0 is the far right.value
- The X2 Coordinate valuejava.lang.Comparable getX2()
void setY2(java.lang.Comparable value)
AnnotationCoordinateMode.Absolute
, this must be a data-value on the YAxis such as a double for NumericAxis
For AnnotationCoordinateMode.Relative
, this must be a double value between 0.0 and 1.0, where 0.0 is the far left of the YAxis and 1.0 is the far right.value
- The Y2 Coordinate valuejava.lang.Comparable getY2()
void update(IAxis xAxis, IAxis yAxis)
ISciChartSurface
xAxis
- The XAxis instanceyAxis
- The YAxis instancevoid refresh()
ISciChartSurface
, without causing a full redraw of the chartboolean isSelected()
void setSelected(boolean isSelected)
isSelected
- The new isSelected
value@Deprecated boolean isEditable()
boolean getIsEditable()
void setIsEditable(boolean isEditable)
isEditable
- The new isEditable
valueboolean isHidden()
void setIsHidden(boolean isHidden)
isHidden
- The new isHidden
valuevoid show()
hide()
callvoid hide()
ISciChartSurface
Direction2D getDragDirections()
Direction2D
with the Drag direction for this annotationDirection2D
valuevoid setDragDirections(Direction2D dragDirections)
Direction2D
with the Drag direction for this annotationdragDirections
- The Direction2D
valueDirection2D getResizeDirections()
Direction2D
with the Resize direction for this annotationDirection2D
valuevoid setResizeDirections(Direction2D resizeDirections)
Direction2D
with the Resize direction for this annotationresizeDirections
- The Direction2D
valuevoid moveBasePointTo(float xCoord, float yCoord, int index)
xCoord
- The new x coordinate of base point in pixelsyCoord
- The new y coordinate of base point in pixelsindex
- The index of base point to movevoid moveAnnotation(float horizOffset, float vertOffset)
horizOffset
- The horizontal offset in pixelsvertOffset
- The vertical offset in pixelsvoid onXAxesCollectionChanged(com.scichart.core.observable.CollectionChangedEventArgs<IAxis> args)
SciChartSurface.getXAxes()
collection changesargs
- The collection changed event argsvoid onYAxesCollectionChanged(com.scichart.core.observable.CollectionChangedEventArgs<IAxis> args)
SciChartSurface.getYAxes()
collection changesargs
- The collection changed event argsvoid onXAxesDrasticallyChanged(ISciChartSurface surface)
SciChartSurface.getXAxes()
collection drastically changedsurface
- The parent surfacevoid onYAxesDrasticallyChanged(ISciChartSurface surface)
SciChartSurface.getYAxes()
collection drastically changedsurface
- The parent surfacevoid setOnAnnotationDragListener(OnAnnotationDragListener listener)
OnAnnotationDragListener
which is called when drag event occurs on this annotationlistener
- The listener to setvoid setOnAnnotationSelectionChangeListener(OnAnnotationSelectionChangeListener listener)
OnAnnotationSelectionChangeListener
which is called when isSelected()
property changeslistener
- The listener to setvoid setOnAnnotationIsHiddenChangeListener(OnAnnotationIsHiddenChangeListener listener)
OnAnnotationIsHiddenChangeListener
which is called when isHidden()
property changeslistener
- The listener to set