Table of Contents

Class AnnotationPolar

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

Annotation for ViewPolar.

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

Constructors

AnnotationPolar()

Constructor for property grid editor.

public AnnotationPolar()

AnnotationPolar(ViewPolar, AxisPolar)

Constructor.

public AnnotationPolar(ViewPolar owner, AxisPolar axis)

Parameters

owner ViewPolar

Parent.

axis AxisPolar

Polar axis you want to bind.

Properties

AssignPolarAxisIndex

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

public int AssignPolarAxisIndex { get; set; }

Property Value

int

LocationAxisValues

Location as axis values.

public PointPolar LocationAxisValues { get; set; }

Property Value

PointPolar

Remarks

Effective only if LocationCoordinateSystem is 'AxisValues'.

TargetAxisValues

Target as axis values.

public PointPolar TargetAxisValues { get; set; }

Property Value

PointPolar

Methods

AdjustLocationAxisValueByUser(int)

Adjust location axis value when user interactive device moved.

protected override void AdjustLocationAxisValueByUser(int sweepPageIndex)

Parameters

sweepPageIndex int

sweep page index

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()

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

X coordinate

vButtonDownFromTargetRenderCenter PointFloat

Rendering location on button down

MoveValueLocationByUser(float, float, PointFloat)

Move value location.

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

Parameters

x float

X coordinate

y float

X coordinate

pnRenderLocationCoordOnButtonDown PointFloat

Rendering location on button down

SetLocationFromAxisValues(PointFloat)

Sets the annotation location to axis values that match the given screen coordinates.

protected override void SetLocationFromAxisValues(PointFloat Coords)

Parameters

Coords PointFloat
param Coords M:LightningChartLib.WinForms.Charting.Annotations.AnnotationPolar.SetLocationFromAxisValues(LightningChartLib.WinForms.Charting.PointFloat)

Events

LocationAxisValuesChangedByUser

Location axis values coordinates have been changed by user

public event AnnotationPolar.LocationAxisValuesChangedByUserEventHandler LocationAxisValuesChangedByUser

Event Type

AnnotationPolar.LocationAxisValuesChangedByUserEventHandler

Remarks

Effective only if LocationCoordinateSystem is 'AxisValues'.

TargetChangedByUser

Target has been changed by user

public event AnnotationPolar.TargetChangedByUserEventHandler TargetChangedByUser

Event Type

AnnotationPolar.TargetChangedByUserEventHandler