Properties  Methods  Events

IAnnotation Interface Members

The following tables list the members exposed by IAnnotation.

Public Properties
 NameDescription
 PropertyGets the height of the SciChart.Core.Framework.IHitTestable (Inherited from SciChart.Core.Framework.IHitTestable)
 PropertyGets the width of the SciChart.Core.Framework.IHitTestable (Inherited from SciChart.Core.Framework.IHitTestable)
 PropertyGets or sets the data context  
 PropertyLimits 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  
 PropertyGets or sets whether the current annotation is attached  
 PropertyGets or sets whether you can interact current annotation  
 PropertyGets or sets value, indicates whether current annotation was hidden by Hide call  
 PropertyGets value, indicates whether current instance is resizable  
 PropertyGets or sets whether the current annotation is selected  
 PropertyGets or sets the parent SciChart.Charting.Visuals.ISciChartSurface that this Annotation belongs to  
 PropertyLimits 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  
 PropertyGets or sets a SciChart.Core.Utility.IServiceContainer container  
 PropertyGets 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.  
 PropertyGets 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.  
 PropertyReturns the XAxes on the parent SciChart.Charting.Visuals.SciChartSurface  
 PropertyGets the XAxis SciChart.Charting.Visuals.Axes.IAxis instance on the parent SciChart.Charting.Visuals.SciChartSurface  
 PropertyGets or sets the XAxis Id that this annotation is measured against. See SciChart.Charting.Visuals.Axes.AxisCore.Id  
 PropertyGets 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  
 PropertyGets 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  
 PropertyReturns the YAxes on the parent SciChart.Charting.Visuals.SciChartSurface  
 PropertyGets the primary YAxis, this is the first axis in the YAxes collection  
 PropertyGets or sets the YAxis Id that this annotation is measured against. See SciChart.Charting.Visuals.Axes.AxisCore.Id  
Top
Public Methods
 NameDescription
 MethodCaptures the mouse  
 MethodThis method is used in internally by the SciChart.Charting.Visuals.Annotations.AnnotationResizeAdorner. Gets the adorner point positions  
 MethodGets the bounds of the current SciChart.Core.Framework.IHitTestable element relative to another SciChart.Core.Framework.IHitTestable element (Inherited from SciChart.Core.Framework.IHitTestable)
 MethodThis 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)
 MethodHides the Annotation by removing adorner markers from the ParentSurface AdornerLayerCanvas and setting Visibility to Collapsed  
 MethodReturns true if the Point is within the bounds of the current SciChart.Core.Framework.IHitTestable element (Inherited from SciChart.Core.Framework.IHitTestable)
 MethodThis method is used internally by the AnnotationDragAdorner. Programmatically moves the annotation by an X,Y offset.  
 MethodCalled when the Annotation is attached to parent surface  
 MethodCalled when the Annotation is detached from its parent surface  
 MethodRaises 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  
 MethodRaises the AnnotationBase.DragEnded event, called when a drag operation ends  
 MethodRaises the AnnotationBase.DragStarted event, called when a drag operation starts  
 MethodRaises notification when parent SciChart.Charting.Visuals.SciChartSurface.XAxes changes.  
 MethodRaises notification when parent SciChart.Charting.Visuals.SciChartSurface.YAxes changes.  
 MethodGenerates an object from its XML representation. (Inherited from System.Xml.Serialization.IXmlSerializable)
 MethodRefreshes the annnotation position on the parent SciChart.Charting.Visuals.SciChartSurface, without causing a full redraw of the chart  
 MethodReleases mouse capture  
 MethodThis method is used in internally by the SciChart.Charting.Visuals.Annotations.AnnotationResizeAdorner. Programmatically sets an adorner point position  
 MethodShows annotation which being hidden by Hide call  
 MethodTranslates the point relative to the other SciChart.Core.Framework.IHitTestable element (Inherited from SciChart.Core.Framework.IHitTestable)
 MethodUpdates the coordinate calculators and refreshes the annotation position on the parent SciChart.Charting.Visuals.SciChartSurface  
 MethodConverts an object into its XML representation. (Inherited from System.Xml.Serialization.IXmlSerializable)
Top
Public Events
 NameDescription
 EventOccurs when current AnnotationBase is dragged or moved  
 EventOccurs when a Drag or move operation ends  
 EventOccurs when a Drag or move operation starts  
 EventOccurs when IAnnotation becomes selected.  
 EventOccurs when IAnnotation becomes unselected.  
Top
See Also