IAnnotation Interface Members
The following tables list the members exposed by IAnnotation.
Public Properties
Name | Description | |
---|---|---|
ActualHeight | Gets the height of the SciChart.Core.Framework.IHitTestable (Inherited from SciChart.Core.Framework.IHitTestable) | |
ActualWidth | Gets the width of the SciChart.Core.Framework.IHitTestable (Inherited from SciChart.Core.Framework.IHitTestable) | |
DataContext | Gets or sets the data context | |
DragDirections | Limits the Drag direction when dragging the annotation using the mouse, e.g in the X-Direction, Y-Direction or XyDirection. See the SciChart.Charting.XyDirection enumeration for options | |
IsAttached | Gets or sets whether the current annotation is attached | |
IsEditable | Gets or sets whether you can interact current annotation | |
IsHidden | Gets or sets value, indicates whether current annotation was hidden by Hide call | |
IsResizable | Gets value, indicates whether current instance is resizable | |
IsSelected | Gets or sets whether the current annotation is selected | |
ParentSurface | Gets or sets the parent SciChart.Charting.Visuals.ISciChartSurface that this Annotation belongs to | |
ResizeDirections | Limits the Resize direction when resiaing the annotation using the mouse, e.g in the X-Direction, Y-Direction or XyDirection. See the SciChart.Charting.XyDirection enumeration for options | |
Services | Gets or sets a SciChart.Core.Utility.IServiceContainer container | |
X1 | Gets or sets the X1 Coordinate of the Annotation. For AnnotationCoordinateMode.Absolute, this must be a data-value on the X-Axis such as a DateTime for SciChart.Charting.Visuals.Axes.DateTimeAxis, double for SciChart.Charting.Visuals.Axes.NumericAxis or integer index for SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis. 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. | |
X2 | Gets or sets the X2 Coordinate of the Annotation. For AnnotationCoordinateMode.Absolute, this must be a data-value on the X-Axis such as a DateTime for SciChart.Charting.Visuals.Axes.DateTimeAxis, double for SciChart.Charting.Visuals.Axes.NumericAxis or integer index for SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis. 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. | |
XAxes | Returns the XAxes on the parent SciChart.Charting.Visuals.SciChartSurface | |
XAxis | Gets the XAxis SciChart.Charting.Visuals.Axes.IAxis instance on the parent SciChart.Charting.Visuals.SciChartSurface | |
XAxisId | Gets or sets the XAxis Id that this annotation is measured against. See SciChart.Charting.Visuals.Axes.AxisCore.Id | |
Y1 | Gets or sets the Y1 Coordinate of the Annotation. For AnnotationCoordinateMode.Absolute, this must be a data-value on the Y-Axis such as a double for SciChart.Charting.Visuals.Axes.NumericAxis For AnnotationCoordinateMode.Relative, this must be a double value between 0.0 and 1.0, where 0.0 is the bottom of the YAxis and 1.0 is the top | |
Y2 | Gets or sets the Y2 Coordinate of the Annotation. For AnnotationCoordinateMode.Absolute, this must be a data-value on the Y-Axis such as a double for SciChart.Charting.Visuals.Axes.NumericAxis For AnnotationCoordinateMode.Relative, this must be a double value between 0.0 and 1.0, where 0.0 is the bottom of the YAxis and 1.0 is the top | |
YAxes | Returns the YAxes on the parent SciChart.Charting.Visuals.SciChartSurface | |
YAxis | Gets the primary YAxis, this is the first axis in the YAxes collection | |
YAxisId | Gets or sets the YAxis Id that this annotation is measured against. See SciChart.Charting.Visuals.Axes.AxisCore.Id |
Public Methods
Name | Description | |
---|---|---|
CaptureMouse | Captures the mouse | |
GetBasePoints | This method is used in internally by the AnnotationResizeAdorner. Gets the adorner point positions | |
GetBoundsRelativeTo | Gets the bounds of the current SciChart.Core.Framework.IHitTestable element relative to another SciChart.Core.Framework.IHitTestable element (Inherited from SciChart.Core.Framework.IHitTestable) | |
GetSchema | This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return a null reference (Nothing in Visual Basic) (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the System.Xml.Serialization.XmlSchemaProviderAttribute to the class. (Inherited from System.Xml.Serialization.IXmlSerializable) | |
Hide | Hides the Annotation by removing adorner markers from the ParentSurface AdornerLayerCanvas and setting Visibility to Collapsed | |
IsPointWithinBounds | Returns true if the Point is within the bounds of the current SciChart.Core.Framework.IHitTestable element (Inherited from SciChart.Core.Framework.IHitTestable) | |
MoveAnnotation | This method is used internally by the AnnotationDragAdorner. Programmatically moves the annotation by an X,Y offset. | |
OnAttached | Called when the Annotation is attached to parent surface | |
OnDetached | Called when the Annotation is detached from its parent surface | |
OnDragDelta | Raises the AnnotationBase.DragDelta event, called when a drag operation is in progress and each time the X1 Y1 X2 Y2 points update in the annotation | |
OnDragEnded | Raises the AnnotationBase.DragEnded event, called when a drag operation ends | |
OnDragStarted | Raises the AnnotationBase.DragStarted event, called when a drag operation starts | |
OnXAxesCollectionChanged | Raises notification when parent SciChart.Charting.Visuals.SciChartSurface.XAxes changes. | |
OnYAxesCollectionChanged | Raises notification when parent SciChart.Charting.Visuals.SciChartSurface.YAxes changes. | |
ReadXml | Generates an object from its XML representation. (Inherited from System.Xml.Serialization.IXmlSerializable) | |
Refresh | Refreshes the annnotation position on the parent SciChart.Charting.Visuals.SciChartSurface, without causing a full redraw of the chart | |
ReleaseMouseCapture | Releases mouse capture | |
SetBasePoint | This method is used in internally by the AnnotationResizeAdorner. Programmatically sets an adorner point position | |
Show | Shows annotation which being hidden by Hide call | |
TranslatePoint | Translates the point relative to the other SciChart.Core.Framework.IHitTestable element (Inherited from SciChart.Core.Framework.IHitTestable) | |
Update | Updates the coordinate calculators and refreshes the annotation position on the parent SciChart.Charting.Visuals.SciChartSurface | |
WriteXml | Converts an object into its XML representation. (Inherited from System.Xml.Serialization.IXmlSerializable) |
Public Events
Name | Description | |
---|---|---|
DragDelta | Occurs when current AnnotationBase is dragged or moved | |
DragEnded | Occurs when a Drag or move operation ends | |
DragStarted | Occurs when a Drag or move operation starts | |
Selected | Occurs when IAnnotation becomes selected. | |
Unselected | Occurs when IAnnotation becomes unselected. |
See Also