Table of Contents

Class AxisPolarBase

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

Base class for polar axes.

[TypeConverter(typeof(ExpandableObjectConverter))]
public class AxisPolarBase : AxisRoundBase, IChartNode, IDisposable, IHighlightingItem
Inheritance
AxisPolarBase
Implements
Derived
Inherited Members

Constructors

AxisPolarBase()

Constructor.

public AxisPolarBase()

AxisPolarBase(ViewPolarBase)

Constructor

protected AxisPolarBase(ViewPolarBase owner)

Parameters

owner ViewPolarBase
param owner M:LightningChartLib.WinForms.Charting.Axes.AxisPolarBase.#ctor(LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolarBase)

Properties

AllowScrolling

Allow axis scrolling by user. Drag from axis line.

public bool AllowScrolling { get; set; }

Property Value

bool

AmplitudeAxisAngle

Amplitude axis angle.

public double AmplitudeAxisAngle { get; set; }

Property Value

double

AmplitudeAxisAngleType

Amplitude axis placement angle decider (with respect to mathematical origin i.e, absolute or user defined origin i.e, relative).

public AxisAngleType AmplitudeAxisAngleType { get; set; }

Property Value

AxisAngleType

AmplitudeAxisLineVisible

Show amplitude axis.

public bool AmplitudeAxisLineVisible { get; set; }

Property Value

bool

AmplitudeLabelsAngle

Offset of the axis labels angle in degrees.

public double AmplitudeLabelsAngle { get; set; }

Property Value

double

Remarks

Note that AxisAngleDrawn can be read to get the default angle of the labels in Polar. In smith the axis is always at 0 angle.

AmplitudeLabelsVisible

Amplitude labels visible.

public bool AmplitudeLabelsVisible { get; set; }

Property Value

bool

AmplitudeReversed

Amplitude Axis direction is reversed. If false, amplitudes increase from center to edge, if true, they increase from edge to center. Does not affect the angular axis in any way.

public bool AmplitudeReversed { get; set; }

Property Value

bool

AngleOrigin

Axis' angle offset from original estimate. Multiple polar axes added equally spaced on a circle starting from East direction.

public double AngleOrigin { get; set; }

Property Value

double

AngularReversed

Axis angle direction is reversed. If false, angles increase counter clockwise, if true, they increase towards clockwise direction. Does not affect the amplitude axis in any way.

public bool AngularReversed { get; set; }

Property Value

bool

AngularTicksVisible

Defines if the angular axis ticks are shown or not.

public bool AngularTicksVisible { get; set; }

Property Value

bool

DragSnapToDiv

Axis scrolling or scaling snaps to divisions.

public bool DragSnapToDiv { get; set; }

Property Value

bool

InnerCircleRadiusPercentage

Inner circle radius as percentage of full circle.

public int InnerCircleRadiusPercentage { get; set; }

Property Value

int

KeepDivCountOnRangeChange

When true, keeps division count instead of division magnitude, when axis min or max is changed. When false, keeps division magnitude instead of count.

public bool KeepDivCountOnRangeChange { get; set; }

Property Value

bool

MajorDiv

Major tick interval (units / div).

public double MajorDiv { get; set; }

Property Value

double

MajorDivCount

Major division count.

public int MajorDivCount { get; set; }

Property Value

int

MajorDivTickStyle

Major division ticks style.

public AxisTickStyleRound MajorDivTickStyle { get; set; }

Property Value

AxisTickStyleRound

MajorGrid

Grid at major divisions.

public GridOptionsRound MajorGrid { get; set; }

Property Value

GridOptionsRound

MarginInner

Inner margin between this and the next axis (the one inside this one). Note that this does nothing if there is no axis inside this one.

public int MarginInner { get; set; }

Property Value

int

MaxAmplitude

Maximum axis amplitude value.

public double MaxAmplitude { get; set; }

Property Value

double

MinAmplitude

Minimum axis amplitude value.

public double MinAmplitude { get; set; }

Property Value

double

MinorDivCount

Minor division count. The count of divisions inside a major division.

public int MinorDivCount { get; set; }

Property Value

int

MinorDivTickStyle

Minor division ticks style.

public AxisTickStyleRound MinorDivTickStyle { get; set; }

Property Value

AxisTickStyleRound

MinorGrid

Grid at minor divisions.

public GridOptionsRound MinorGrid { get; set; }

Property Value

GridOptionsRound

UsePreviousAxisDiameter

Defines if the axis shares the same space with the previous axis in the view's axis collection. If the OuterMargin, font size, TickMark location and other angular axis position affecting settings are the same as with the previous axis, the axis lines are aligned.

public bool UsePreviousAxisDiameter { get; set; }

Property Value

bool

Methods

Construct()

Create members.

protected override void Construct()

CoordToValue(PointFloat, bool)

Coordinate to value converter.

public PointPolar CoordToValue(PointFloat Coord, bool UseDip = true)

Parameters

Coord PointFloat

Screen coordinate to convert into polar value

UseDip bool

Flag useDip

Returns

PointPolar

Polar value matching the given screen coordinates.

CoordToValue(int, int, out double, out double, bool)

Coordinate to value.

public void CoordToValue(int x, int y, out double angle, out double amplitude, bool UseDip = true)

Parameters

x int

x-coordinate

y int

y-coordinate

angle double

Angle as degrees.

amplitude double

Value as axis units.

UseDip bool

Flag useDip

CreateLabelsFont()

Create font for labels

protected override void CreateLabelsFont()

CreateMajorGrid()

Create major grid

protected void CreateMajorGrid()

CreateMinorGrid()

Create minor grid

protected void CreateMinorGrid()

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.

OnDeserialized(StreamingContext)

OnDeserialized is called just after the object has been deserialized

[OnDeserialized]
protected void OnDeserialized(StreamingContext context)

Parameters

context StreamingContext

Context

SetProperCursor()

Set proper cursor.

public override void SetProperCursor()

SetRange(double, double)

Set axis range.

public void SetRange(double minimum, double maximum)

Parameters

minimum double

Minimum axis value

maximum double

Maximum value

ToString()

Item to string.

public override string ToString()

Returns

string
returns M:LightningChartLib.WinForms.Charting.Axes.AxisPolarBase.ToString

ValueToCoord(IPointPolar, bool)

Value to coordinates.

public PointFloat ValueToCoord(IPointPolar point, bool useDip = true)

Parameters

point IPointPolar

Polar axis values to convert into screen coordinates. Angle in the point is in relation to normal 0 angle, not the current axis drawing angle.

useDip bool

Flag useDip

Returns

PointFloat

Screen coordinates matching the requested polar axis values.

ValueToCoord(IPointRound, bool)

Value to coordinates.

public override PointFloat ValueToCoord(IPointRound Point, bool UseDip = true)

Parameters

Point IPointRound
param Point M:LightningChartLib.WinForms.Charting.Axes.AxisPolarBase.ValueToCoord(LightningChartLib.WinForms.Charting.IPointRound,System.Boolean)
UseDip bool

Flag useDip

Returns

PointFloat
returns M:LightningChartLib.WinForms.Charting.Axes.AxisPolarBase.ValueToCoord(LightningChartLib.WinForms.Charting.IPointRound,System.Boolean)

ValueToCoordDouble(double, double, bool)

Value to coordinates.

public PointFloat ValueToCoordDouble(double angle, double amplitude, bool UseDip = true)

Parameters

angle double
param angle M:LightningChartLib.WinForms.Charting.Axes.AxisPolarBase.ValueToCoordDouble(System.Double,System.Double,System.Boolean)
amplitude double
param amplitude M:LightningChartLib.WinForms.Charting.Axes.AxisPolarBase.ValueToCoordDouble(System.Double,System.Double,System.Boolean)
UseDip bool

Flag useDip

Returns

PointFloat
returns M:LightningChartLib.WinForms.Charting.Axes.AxisPolarBase.ValueToCoordDouble(System.Double,System.Double,System.Boolean)

ValueToString(SupplyCustomAmplitudeStringEventArgs)

Convert value to string.

protected void ValueToString(SupplyCustomAmplitudeStringEventArgs args)

Parameters

args SupplyCustomAmplitudeStringEventArgs

Arguments

Events

RangeChanged

Range has changed (Minimum or Maximum value)

public event AxisPolarBase.RangeChangedEventHandler RangeChanged

Event Type

AxisPolarBase.RangeChangedEventHandler

SupplyCustomAmplitudeString

Event to format amplitude as a custom string.

public event AxisPolarBase.SupplyCustomAmplitudeStringEventHandler SupplyCustomAmplitudeString

Event Type

AxisPolarBase.SupplyCustomAmplitudeStringEventHandler