IAnchorPointAnnotation Interface Members
The following tables list the members exposed by IAnchorPointAnnotation.
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 (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
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 (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
HorizontalAnchorPoint | Gets or sets the HorizontalAnchorPoint. The value of Left means the X1,Y1 coordinate of the annotation is on the Left horizontally. The value of Center means the X1,Y1 coordinate of the annotation is at the center horizontally. The value of Right means the X1,Y1 coordinate of the annotation is at the right horizontally. | |
HorizontalOffset | Gets the computed HorizontalOffset in pixels to apply to this annotation when placing | |
IsAttached | Gets or sets whether the current annotation is attached (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
IsEditable | Gets or sets whether you can interact current annotation (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
IsHidden | Gets or sets value, indicates whether current annotation was hidden by IAnnotation.Hide call (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
IsResizable | Gets value, indicates whether current instance is resizable (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
IsSelected | Gets or sets whether the current annotation is selected (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
ParentSurface | Gets or sets the parent SciChart.Charting.Visuals.ISciChartSurface that this Annotation belongs to (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
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 (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
Services | Gets or sets a SciChart.Core.Utility.IServiceContainer container (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
VerticalAnchorPoint | Gets or sets the VerticalAnchorPoint. The value of Top means the X1,Y1 coordinate of the annotation is on the Top vertically. The value of Center means the X1,Y1 coordinate of the annotation is at the center vertically. The value of Bottom means the X1,Y1 coordinate of the annotation is at the Bottom vertically. | |
VerticalOffset | Gets the computed VerticalOffset in pixels to apply to this annotation when placing | |
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. (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
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. (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
XAxes | Returns the XAxes on the parent SciChart.Charting.Visuals.SciChartSurface (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
XAxis | Gets the XAxis SciChart.Charting.Visuals.Axes.IAxis instance on the parent SciChart.Charting.Visuals.SciChartSurface (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
XAxisId | Gets or sets the XAxis Id that this annotation is measured against. See SciChart.Charting.Visuals.Axes.AxisCore.Id (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
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 (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
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 (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
YAxes | Returns the YAxes on the parent SciChart.Charting.Visuals.SciChartSurface (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
YAxis | Gets the primary YAxis, this is the first axis in the YAxes collection (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
YAxisId | Gets or sets the YAxis Id that this annotation is measured against. See SciChart.Charting.Visuals.Axes.AxisCore.Id (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) |
Public Methods
Name | Description | |
---|---|---|
CaptureMouse | Captures the mouse (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
GetBasePoints | This method is used in internally by the AnnotationResizeAdorner. Gets the adorner point positions (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
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 IAnnotation.ParentSurface AdornerLayerCanvas and setting Visibility to Collapsed (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
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. (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
OnAttached | Called when the Annotation is attached to parent surface (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
OnDetached | Called when the Annotation is detached from its parent surface (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
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 (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
OnDragEnded | Raises the AnnotationBase.DragEnded event, called when a drag operation ends (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
OnDragStarted | Raises the AnnotationBase.DragStarted event, called when a drag operation starts (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
OnXAxesCollectionChanged | Raises notification when parent SciChart.Charting.Visuals.SciChartSurface.XAxes changes. (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
OnYAxesCollectionChanged | Raises notification when parent SciChart.Charting.Visuals.SciChartSurface.YAxes changes. (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
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 (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
ReleaseMouseCapture | Releases mouse capture (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
SetBasePoint | This method is used in internally by the AnnotationResizeAdorner. Programmatically sets an adorner point position (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
Show | Shows annotation which being hidden by IAnnotation.Hide call (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
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 (Inherited from SciChart.Charting.Visuals.Annotations.IAnnotation) | |
WriteXml | Converts an object into its XML representation. (Inherited from System.Xml.Serialization.IXmlSerializable) |
See Also