Properties  Events

IAnnotationViewModel Interface Members

The following tables list the members exposed by IAnnotationViewModel.

Public Properties
 NameDescription
 PropertyGets or sets the AnnotationCanvas to place the annotation on. The default is SciChart.Charting.Visuals.Annotations.AnnotationCanvas.AboveChart  
 PropertyGets or sets whether text can be edited on this SciChart.Charting.Visuals.Annotations.AnnotationBase. Supported by Text or label annotations only  
 PropertyGets or sets the SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode to use when placing the annotation. E.g. the default of Absolute requires that X1,Y1 coordinates are data-values. The value of Relative requires that X1,Y1 are double values from 0.0 to 1.0  
 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  
 Property Gets or sets whether the Annotation is editable via user interaction  
 Property Gets or sets whether the Annotation is hidden when drawn  
 Property Gets or sets whether the Annotation is selected  
 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  
 Property The StyleKey to apply to the View (Inherited from SciChart.Charting.Model.ChartSeries.ISciChartElementViewModel)
 Property Gets The View Type to instantiate for this ViewModel. The View.DataContext will be set to this ViewModel instance (Inherited from SciChart.Charting.Model.ChartSeries.ISciChartElementViewModel)
 PropertyGets or sets the X1 Coordinate of the Annotation. For SciChart.Charting.Visuals.Annotations.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 SciChart.Charting.Visuals.Annotations.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 SciChart.Charting.Visuals.Annotations.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 SciChart.Charting.Visuals.Annotations.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.  
 Property Gets or sets the ID of the X-Axis which this Annotation is measured against  
 PropertyGets or sets the Y1 Coordinate of the Annotation. For SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Absolute, this must be a data-value on the Y-Axis such as a double for SciChart.Charting.Visuals.Axes.NumericAxis For SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Relative, this must be a double value between 0.0 and 1.0, where 0.0 is the top of the YAxis and 1.0 is the bottom  
 PropertyGets or sets the Y2 Coordinate of the Annotation. For SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Absolute, this must be a data-value on the Y-Axis such as a double for SciChart.Charting.Visuals.Axes.NumericAxis For SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Relative, this must be a double value between 0.0 and 1.0, where 0.0 is the top of the YAxis and 1.0 is the bottom  
 Property Gets or sets the ID of the Y-Axis which this Annotation is measured against  
Top
Public Events
 NameDescription
 EventOccurs when current SciChart.Charting.Visuals.Annotations.AnnotationBase is dragged or moved  
 Event Occurs when a Drag or move operation ends  
 Event Occurs when a Drag or move operation starts  
 EventOccurs when the IsHidden property is changed  
 EventOccurs when SciChart.Charting.Visuals.Annotations.IAnnotation becomes selected.  
 EventOccurs when SciChart.Charting.Visuals.Annotations.IAnnotation becomes unselected.  
Top
See Also