WPF Charting Documentation - SciChart WPF Charts SDK v5.x
BaseAnnotationViewModel Class Members
Properties  Methods  Events


The following tables list the members exposed by BaseAnnotationViewModel.

Protected Constructors
Public Properties
 NameDescription
Public PropertyAnnotationCanvasGets or sets the AnnotationCanvas to place the annotation on. The default is Annotations.AnnotationCanvas.AboveChart  
Public PropertyCanEditTextGets or sets whether text can be edited on this SciChart.Charting.Visuals.Annotations.AnnotationBase. Supported by Text or label annotations only  
Public PropertyCoordinateModeGets 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  
Public PropertyDragDeltaCommand  
Public PropertyDragDirectionsLimits 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  
Public PropertyDragEndedCommand  
Public PropertyDragStartedCommand  
Public PropertyForeground  
Public PropertyIsEditableGets or sets whether the Annotation is editable via user interaction  
Public PropertyIsHiddenGets or sets whether the Annotation is hidden when drawn  
Public PropertyIsHiddenChangedCommand  
Public PropertyIsSelectedGets or sets whether the Annotation is selected  
Public PropertyResizeDirectionsLimits 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  
Public PropertySelectedCommand  
Public PropertyStyleKeyGets or Sets the style key which will be used to fetch the style and apply it to the corresponding RenderableSeries. (Inherited from SciChart.Charting.Model.ChartSeries.BaseSciChartElementViewModel)
Public PropertyTooltip  
Public PropertyUnselectedCommand  
Public PropertyViewTypeGets the View Type which this ViewModel will be associated with. (Inherited from SciChart.Charting.Model.ChartSeries.BaseSciChartElementViewModel)
Public PropertyX1Gets 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.  
Public PropertyX2Gets 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.  
Public PropertyXAxisIdGets or sets the ID of the X-Axis which this Annotation is measured against  
Public PropertyY1Gets 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  
Public PropertyY2Gets 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  
Public PropertyYAxisIdGets or sets the ID of the Y-Axis which this Annotation is measured against  
Top
Public Methods
 NameDescription
Public MethodToStringReturns a string that represents the current object. (Inherited from SciChart.Charting.Model.ChartSeries.BaseSciChartElementViewModel)
Top
Protected Methods
 NameDescription
Protected MethodOnPropertyChangedThis method is called by the Set accessor of each property. (Inherited from SciChart.Charting.Model.ChartSeries.BaseSciChartElementViewModel)
Protected MethodSetValue<T>This method is used to set property value and raise PropertyChanged event handler (Inherited from SciChart.Charting.Model.ChartSeries.BaseSciChartElementViewModel)
Top
Extension Methods
 NameDescription
Public Extension MethodToEnumerable<T>Yields a single item, converting it to System.Collections.IEnumerable.
Public Extension MethodToStringArray2D<T>
Top
Public Events
 NameDescription
Public EventDragDelta  
Public EventDragEnded  
Public EventDragStarted  
Public EventIsHiddenChanged  
Public EventPropertyChangedOccurs when a property value changes. (Inherited from SciChart.Charting.Model.ChartSeries.BaseSciChartElementViewModel)
Public EventSelected  
Public EventUnselected  
Top
See Also

Reference

BaseAnnotationViewModel Class
SciChart.Charting.Model.ChartSeries Namespace

 

 


SCICHART ® is a Registered Trademark in the UK, US and EU. Copyright SciChart Ltd 2011-2018.

Send Feedback