AnnotationBase Class

LightningChart .NET Help

Annotations base class.

Inheritance Hierarchy

Namespace: Arction.WinForms.Charting.Annotations
Assembly: Arction.WinForms.Charting.LightningChart (in Arction.WinForms.Charting.LightningChart.dll) Version: 10.3.1

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	Allow anchor move by user. Anchor is centerpoint of rotation and start point of arrow.
	AllowDragging	Gets or sets whether dragging by user is allowed. (Inherited from DraggableObject.)
	AllowResize	Allow resizing by user.
	AllowRotate	Allow rotation by user.
	AllowTargetMove	Allow user to move target.
	AllowUserInteraction	Gets or sets whether allow user interaction. (Inherited from UserInteractiveObject.)
	Anchor	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	Arrow end aspect ratio (width / height).
	ArrowLineStyle	Arrow line style.
	ArrowStyleBegin	Lead arrow style, in the beginning of line.
	ArrowStyleEnd	Lead arrow style, in Target location.
	AutoSizePadding	Padding between text and borders when automatic size is used.
	BorderLineStyle	Border line style.
	BorderVisible	Defines if border is visible.
	CornerRoundRadius	Corner rounding radius, in pixels.
	Fill	Fill.
	Highlight	Gets or sets highlight style. Item can be highlighted by user interactive device or by code. (Inherited from HighlightingItemBase.)
	LayerGrouping	Text is rendered on layers.
	LocationCoordinateSystem	Location coordinate system selection.
	LocationRelativeOffset	Location offset in pixels, relative to location.
	LocationScreenCoords	Location as screen coordinates in pixels.
	NibStyle	Nib style. Appearance of the mouse-interactive nibs.
	RotateAngle	Rotation angle, in degrees. The rotation is done around the element's center of rotation.
	Selected	Defines if annotation is in 'Selected' state, allowing resizing, rotating and anchor adjustment.
	Shadow	Shadow beneath the object.
	SizeScreenCoords	Size as screen coordinates.
	Style	Style selects the main layout of annotation.
	TargetCoordinateSystem	Target coordinate system selection.
	TargetScreenCoords	Target as screen coordinates. Target is the point that the arrow or call-out tip points to.
	Text	Annotation text.
	TextStyle	Text style. Appearance of the text.
	Visible	Defines if annotation is visible.

Top

Methods

	Name	Description
	ChangeOrder	Change object position in list of annotations.
	Dispose	Release all resources used by this instance. (Inherited from ChartNode.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	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.
	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.
	MouseClick	Mouse button has been clicked. (Inherited from UserInteractiveObject.)
	MouseDoubleClick	Mouse button has been doubleclicked. (Inherited from UserInteractiveObject.)
	MouseDown	Mouse button has been pressed down. (Inherited from UserInteractiveObject.)
	MouseOverOff	Mouse has been moved outside of object. (Inherited from UserInteractiveObject.)
	MouseOverOn	Mouse has been moved over object. (Inherited from UserInteractiveObject.)
	MouseUp	Mouse button has been released. (Inherited from UserInteractiveObject.)
	RotatedByUser	Annotation has been rotated by user.

Top

Fields

	Name	Description
	Tag	Tag. Freely assignable object. (Inherited from UserInteractiveObjectInt.)

Top

Reference

Arction.WinForms.Charting.Annotations Namespace