Table of Contents

Class AnnotationXY

Namespace
LightningChartLib.WinForms.Charting.Annotations
Assembly
LightningChart.WinForms.Charting.NET4.dll

Annotation for ViewXY.

[TypeConverter(typeof(ExpandableObjectConverter))]
public class AnnotationXY : AnnotationBase, IChartNode, IDisposable, IHighlightingItem
Inheritance
AnnotationXY
Implements
Inherited Members

Constructors

AnnotationXY()

Constructor for Form designer list editor.

public AnnotationXY()

AnnotationXY(ViewXY, AxisX, AxisY)

Constructor.

public AnnotationXY(ViewXY owner, AxisX axisX, AxisY axisY)

Parameters

owner ViewXY

Parent.

axisX AxisX

X-axis you want to bind.

axisY AxisY

Y-axis you want to bind.

Properties

AssignXAxisIndex

Index of X-axis assigned to this series. Give -1 when you don't want to assign it yet to any X-axis.

public int AssignXAxisIndex { get; set; }

Property Value

int

AssignYAxisIndex

Index of Y-axis assigned to this series. Give -1 when you don't want to assign it yet to any Y-axis.

public int AssignYAxisIndex { get; set; }

Property Value

int

AxisValuesBoundaries

Main box boundaries in axis values.

public BoundsDoubleXY AxisValuesBoundaries { get; set; }

Property Value

BoundsDoubleXY

Behind

Annotation is drawn behind series or marker if enabled.

public bool Behind { get; set; }

Property Value

bool

ClipInsideGraph

If set, limits the annotation in graph area.

Note that ClipOnScaleBreak affects the clipping as well.

public bool ClipInsideGraph { get; set; }

Property Value

bool

ClipOnScaleBreak

Defines if annotation is clipped at X-axis breaks.

Note that when true, the annotation is clipped at the start/end X-axis even if there are not breaks defined.

public bool ClipOnScaleBreak { get; set; }

Property Value

bool

ClipWhenSweeping

The annotation doesn’t show up in the sweeping gap area when enabled. Applies only when X-axis ScrollMode is Sweeping.

public bool ClipWhenSweeping { get; set; }

Property Value

bool

KeepVisible

Keep annotation always visible, inside graph area.

public bool KeepVisible { get; set; }

Property Value

bool

LocationAxisValues

Location as axis values.

public PointDoubleXY LocationAxisValues { get; set; }

Property Value

PointDoubleXY

Remarks

Effective only if LocationCoordinateSystem is 'AxisValues'.

RenderBehindAxes

Render annotation behind X-axes.

public bool RenderBehindAxes { get; set; }

Property Value

bool

Sizing

Annotation sizing type.

public AnnotationXYSizing Sizing { get; set; }

Property Value

AnnotationXYSizing

TargetAxisValues

Target as axis values. Target is the point that the arrow or call-out tip points to.

public PointDoubleXY TargetAxisValues { get; set; }

Property Value

PointDoubleXY

Methods

AdjustLocationAxisValueByUser(int)

Adjust location axis value when user interactive device moved.

protected override void AdjustLocationAxisValueByUser(int sweepPageIndex)

Parameters

sweepPageIndex int

sweep page index

DetectPositionOverSweepPageIndex(int)

Detect sweep page at position.

protected override int DetectPositionOverSweepPageIndex(int x)

Parameters

x int

x coordinate

Returns

int
returns M:LightningChartLib.WinForms.Charting.Annotations.AnnotationXY.DetectPositionOverSweepPageIndex(System.Int32)

Dispose(bool)

Clean up any resources being used.

protected override void Dispose(bool disposing)

Parameters

disposing bool

True if managed resources should be disposed, otherwise false.

HandleUserOverResizeNib()

Handle mouse over resize nib.

protected override void HandleUserOverResizeNib()

HandleUserOverTargetNib()

Handle mouse over target nib.

protected override void HandleUserOverTargetNib()

MoveTargetLocationByUser(float, float, PointFloat)

Move target by user.

protected override void MoveTargetLocationByUser(float x, float y, PointFloat vButtonDownFromTargetRenderCenter)

Parameters

x float

x coordinate

y float

y coordinate

vButtonDownFromTargetRenderCenter PointFloat

render location on button down

MoveValueLocationByUser(float, float, PointFloat)

Move value location by user.

protected override void MoveValueLocationByUser(float x, float y, PointFloat pnRenderLocationCoordOnButtonDown)

Parameters

x float

x coordinate

y float

y coordinate

pnRenderLocationCoordOnButtonDown PointFloat

render location on user interactive device button down

ToString()

Converts class description to string.

public override string ToString()

Returns

string

Class description as a string.

Events

LocationAxisValuesChangedByUser

Location axis values coordinates have been changed by user

public event AnnotationXY.LocationAxisValuesChangedByUserEventHandler LocationAxisValuesChangedByUser

Event Type

AnnotationXY.LocationAxisValuesChangedByUserEventHandler

Remarks

Effective only if LocationCoordinateSystem is 'AxisValues'.

ResizedByUser

Annotation has been resized by user.

public event AnnotationXY.ResizedByUserEventHandler ResizedByUser

Event Type

AnnotationXY.ResizedByUserEventHandler

TargetChangedByUser

Target has been changed by user

public event AnnotationXY.TargetChangedByUserEventHandler TargetChangedByUser

Event Type

AnnotationXY.TargetChangedByUserEventHandler