AnnotationBase Class

LightningChart .NET Help

Annotations base class.

Inheritance Hierarchy

DependencyObject
  LightningChartLib.UWP.ChartingMVVMChartNode
    LightningChartLib.UWP.ChartingMVVMUserInteractiveObjectInt
      LightningChartLib.UWP.ChartingMVVMUserInteractiveObject
        LightningChartLib.UWP.ChartingMVVMHighlightingItemBase
          LightningChartLib.UWP.ChartingMVVMDraggableObject
            LightningChartLib.UWP.ChartingMVVM.AnnotationsAnnotationBase
              LightningChartLib.UWP.ChartingMVVM.AnnotationsAnnotation3DBase
              LightningChartLib.UWP.ChartingMVVM.AnnotationsAnnotationRound
              LightningChartLib.UWP.ChartingMVVM.AnnotationsAnnotationXY

Namespace: LightningChartLib.UWP.ChartingMVVM.Annotations
Assembly: LightningChart.UWP.ChartingMVVM (in LightningChart.UWP.ChartingMVVM.dll) Version: 11.0.1
XMLNS for XAML: Not mapped to an xmlns.

Syntax

C++

Copy

[SerializableAttribute]
[TypeConverterAttribute(typeof(GeneralTypeConverter))]
public abstract class AnnotationBase : DraggableObject

<SerializableAttribute>
<TypeConverterAttribute(GetType(GeneralTypeConverter))>
Public MustInherit Class AnnotationBase
	Inherits DraggableObject

[SerializableAttribute]
[TypeConverterAttribute(typeof(GeneralTypeConverter))]
public ref class AnnotationBase abstract : public DraggableObject

The AnnotationBase type exposes the following members.

Constructors

	Name	Description
	AnnotationBase	Constructor.

Top

Properties

	Name	Description
	AllowAnchorAdjust	Gets or sets if allows anchor move by user. Anchor is centerpoint of rotation and start point of arrow. This is a dependency property.
	AllowDragging	Gets or sets if allow dragging by user. This is a dependency property. (Inherited from DraggableObject)
	AllowResize	Gets or sets if allows resizing by user. This is a dependency property.
	AllowRotate	Gets or sets if rotation is allowed by user. This is a dependency property.
	AllowTargetMove	Gets or sets if allows target move by user. This is a dependency property.
	AllowUserInteraction	Gets or sets if user interaction is allowed. This is a dependency property. (Inherited from UserInteractiveObject)
	Anchor	Gets or sets anchor. This is a dependency property. Rotation uses this point as a center point. Tells where to place the anchored point within the control area. For X-dimension, value 0 represents left coordinate of the object and 1 right coordinate. For Y-dimension, value 0 represents top coordinate of the object and 1 bottom coordinate. To define anchor point outside the object area, define values outside range 0...1.
	ArrowEndAspectRatio	Gets or sets arrow end aspect ratio (width / height). This is a dependency property.
	ArrowLineStyle	Gets or sets arrow line style. This is a dependency property.
	ArrowStyleBegin	Gets or sets lead arrow style, in the beginning of line. This is a dependency property.
	ArrowStyleEnd	Gets or sets lead arrow style, in Target location. This is a dependency property.
	AutoSizePadding	Gets or sets padding between text and borders when automatic size is used. This is a dependency property.
	BorderLineStyle	Gets or sets border line style. This is a dependency property.
	BorderVisible	Gets or sets if border is visible. This is a dependency property.
	CornerRoundRadius	Gets or sets corner rounding radius, in pixels. This is a dependency property.
	Fill	Gets or sets fill. This is a dependency property.
	Highlight	Gets or sets highlight style. Item can be highlighted by user interactive device or by code. This is a dependency property. (Inherited from HighlightingItemBase)
	LayerGrouping	Gets or sets if text is rendered on layers. This is a dependency property.
	LocationCoordinateSystem	Gets or sets location coordinate system. This is a dependency property.
	LocationRelativeOffset	Gets or sets location offset in pixels, relative to location. This is a dependency property.
	LocationScreenCoords	Gets or sets location as screen coordinates in pixels. This is a dependency property.
	NibStyle	Gets and sets nib style. Appearance of the user-interactive nibs. This is a dependency property.
	RotateAngle	Gets or sets rotation angle, in degrees. The rotation is done around the element's center of rotation. This is a dependency property.
	Selected	Gets or sets if annotation is in 'Selected' state, allowing resizing, rotating and anchor adjustment. This is a dependency property.
	Shadow	Gets or sets shadow beneath the object. This is a dependency property.
	SizeScreenCoords	Gets or sets size as screen coordinates. This is a dependency property.
	Style	Gets and sets style of the main layout of annotation. This is a dependency property.
	TargetCoordinateSystem	Gets or sets target coordinate system. This is a dependency property.
	TargetScreenCoords	Gets or sets screen coordinates. Target is the point that the arrow or callout tip points to. This is a dependency property.
	Text	Gets or sets annotation text. This is a dependency property.
	TextStyle	Gets or sets text style. Appearance of the text. This is a dependency property.
	Visible	Gets and sets annotation visible state. This is a dependency property.

Top

Methods

	Name	Description
	ChangeOrder	Change object position in list of annotations.
	Dispose	Release all resources used by this instance. (Inherited from ChartNode)
	IsHighlighted	returns true if the object is highlighted. (Inherited from HighlightingItemBase)
	IsPositionOver	Is position over Annotation. (Overrides UserInteractiveObjectIsPositionOver(Int32, Int32, Boolean))
	RemoveHighlight	Removes forced highlighting. (Inherited from HighlightingItemBase)
	ResetLocation	Reset location, if moved by mouse. (Inherited from DraggableObject)
	SetHighlight	Highlights the object. This is a kind of "forced" highlight, and the object might be highlighted even if the highlighting type (defined by Highlight property) is set to None. How the highlighting happens, if any, depends on object. Most objects use the defined type by default, and fall back to Simple highlighting if None is set. (Inherited from HighlightingItemBase)
	SetProperCursor	Set proper cursor. Default for dragging is hand and for resize SizeAll. (Overrides DraggableObjectSetProperCursor)
	ToString	Description of class. (Overrides HighlightingItemBaseToString)

Top

Events

	Name	Description
	AnchorAdjustedByUser	Anchor has been adjusted by user.
	DoubleTapped	Item has been doubletapped. (Inherited from UserInteractiveObject)
	DraggedByUser	Dragged by user. (Inherited from DraggableObject)
	HighlightedStateChanged	Event telling that highlighted state has changed. Contains information of the new state. (Inherited from HighlightingItemBase)
	LocationRelativeOffsetChangedByUser	Location relative screen coordinate offset has been changed by user.
	LocationScreenCoordinatesChangedByUser	Location screen coordinates have been changed by user.
	PointerEntered	Pointer has been moved over object. (Inherited from UserInteractiveObject)
	PointerExited	Pointer has been moved outside of object. (Inherited from UserInteractiveObject)
	PointerPressed	Pointer has been pressed down. (Inherited from UserInteractiveObject)
	PointerReleased	Pointer has been released. (Inherited from UserInteractiveObject)
	RotatedByUser	Annotation has been rotated by user.
	Tapped	Item has been tapped. (Inherited from UserInteractiveObject)
	ValueChangedInternallyEvent	Value has changed internally by chart or by user manipulation of chart object. (Inherited from ChartNode)

Top

Fields

	Name	Description
	AllowAnchorAdjustProperty	Identifies the AllowAnchorAdjust dependency property.
	AllowRotateProperty	Identifies the AllowRotate dependency property.
	AllowTargetMoveProperty	Identifies the AllowTargetMove dependency property.
	AnchorProperty	Identifies the Anchor dependency property.
	ArrowEndAspectRatioProperty	Identifies the ArrowEndAspectRatio dependency property.
	ArrowLineStyleProperty	Identifies the ArrowLineStyle dependency property.
	ArrowStyleBeginProperty	Identifies the ArrowStyleBegin dependency property.
	ArrowStyleEndProperty	Identifies the ArrowStyleEnd dependency property.
	AutoSizePaddingProperty	Identifies the AutoSizePadding dependency property.
	BorderLineStyleProperty	Identifies the BorderLineStyle dependency property.
	BorderVisibleProperty	Identifies the BorderVisible dependency property.
	CornerRoundRadiusProperty	Identifies the CornerRoundRadius dependency property.
	FillProperty	Identifies the Fill dependency property.
	LayerGroupingProperty	Identifies the LayerGrouping dependency property.
	LocationCoordinateSystemProperty	Identifies the LocationCoordinateSystem dependency property.
	LocationRelativeOffsetProperty	Identifies the LocationRelativeOffset dependency property.
	LocationScreenCoordsProperty	Identifies the LocationScreenCoords dependency property.
	NibStyleProperty	Identifies the NibStyle dependency property.
	RotateAngleProperty	Identifies the RotateAngle dependency property.
	SelectedProperty	Identifies the Selected dependency property.
	ShadowProperty	Identifies the Shadow dependency property.
	SizeScreenCoordsProperty	Identifies the SizeScreenCoords dependency property.
	StyleProperty	Identifies the Style dependency property.
	Tag	Tag. Freely assignable object. (Inherited from UserInteractiveObjectInt)
	TargetCoordinateSystemProperty	Identifies the TargetCoordinateSystem dependency property.
	TargetScreenCoordsProperty	Identifies the TargetCoordinateSystem dependency property.
	TextProperty	Identifies the Text dependency property.
	TextStyleProperty	Identifies the TextStyle dependency property.
	VisibleProperty	Identifies the Visible dependency property.

Top

Reference

LightningChartLib.UWP.ChartingMVVM.Annotations Namespace