Table of Contents

Class SeriesBasePolar

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

Base class for all polar series.

public abstract class SeriesBasePolar : SeriesBaseRound, IChartNode, IHighlightingItem, IDisposable
Inheritance
SeriesBasePolar
Implements
Derived
Inherited Members

Constructors

SeriesBasePolar()

Constructor for Form designer list editor.

protected SeriesBasePolar()

SeriesBasePolar(ViewPolar, AxisPolar)

Constructor

protected SeriesBasePolar(ViewPolar owner, AxisPolar axisPolar)

Parameters

owner ViewPolar
param owner M:LightningChartLib.WinForms.Charting.SeriesPolar.SeriesBasePolar.#ctor(LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolar,LightningChartLib.WinForms.Charting.Axes.AxisPolar)
axisPolar AxisPolar
param axisPolar M:LightningChartLib.WinForms.Charting.SeriesPolar.SeriesBasePolar.#ctor(LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolar,LightningChartLib.WinForms.Charting.Axes.AxisPolar)

Properties

AssignPolarAxisIndex

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

public int AssignPolarAxisIndex { get; set; }

Property Value

int

AssignablePolarAxes

List of assignable axes.

public string[] AssignablePolarAxes { get; }

Property Value

string[]

CenterClipping

Defines how the series should be clipped at the center of the graph.

public CenterClipping CenterClipping { get; set; }

Property Value

CenterClipping

Points

Series points

public PolarSeriesPoint[] Points { get; set; }

Property Value

PolarSeriesPoint[]

Methods

AddPoints(PolarSeriesPoint[], bool)

Add points to end of series

public int AddPoints(PolarSeriesPoint[] points, bool invalidateChart)

Parameters

points PolarSeriesPoint[]

Points

invalidateChart bool

Update chart after adding. Updating will raise CPU load, so you maybe don't want to use this with every call if points are added many times per second.

Returns

int

Point count after adding

Clear()

Clear all points

public virtual void Clear()

GetMinMaxFromAngleRange(out double, out double, double, double)

Get minimum and maximum amplitude values within given angle range

public override bool GetMinMaxFromAngleRange(out double minAmplitude, out double maxAmplitude, double minAngle, double maxAngle)

Parameters

minAmplitude double

Minimum amplitude value

maxAmplitude double

Maximum amplitude value

minAngle double

Angle range start

maxAngle double

Angle range end

Returns

bool

True if values were successfully detected

GetMinMaxFromXRange(out double, out double, double, double)

Get min and max amplitude value withing given angle range [Obsolete. Using GetMinMaxFromAngleRange instead recommended]

public override bool GetMinMaxFromXRange(out double yMin, out double yMax, double xRangeMin, double xRangeMax)

Parameters

yMin double

Minimum amplitude value

yMax double

Maximum amplitude value

xRangeMin double

Angle range start

xRangeMax double

Angle range end

Returns

bool

True if values were successfully detected

IsCustomLinePointColorsAndShapingSubscribedTo()

Check if the event CustomLinePointColoringAndShaping is subscribed

protected virtual bool IsCustomLinePointColorsAndShapingSubscribedTo()

Returns

bool
returns M:LightningChartLib.WinForms.Charting.SeriesPolar.SeriesBasePolar.IsCustomLinePointColorsAndShapingSubscribedTo

LoadFromCSV(string, SeparatorCSV)

Loads series data from a CSV file.

public virtual bool LoadFromCSV(string file, SeparatorCSV separator)

Parameters

file string

CSV file name. If file does not exist, LoadFromCSV returns false.

separator SeparatorCSV

Value and floating point number separator.

Returns

bool

True if import succeeds. Otherwise false.

SaveToCSV(string, SeparatorCSV)

Saves series data into CSV file

public virtual bool SaveToCSV(string file, SeparatorCSV separator)

Parameters

file string

Target file. If file already exists, it will be overwritten.

separator SeparatorCSV

Value and floating point number separator definition

Returns

bool

True if export is successful

SolveNearestDataPointByCoord(double, double, out double, out double)

Tries to find the closest point of the series to the given coordinates [input in PX].

public bool SolveNearestDataPointByCoord(double xCoordinate, double yCoordinate, out double nearestAngleValue, out double nearestAmplitudeValue)

Parameters

xCoordinate double

X screen coordinate (as PX) to find the nearest series point from.

yCoordinate double

Y screen coordinate (as PX) to find the nearest series point from.

nearestAngleValue double

Angle value of the found point.

nearestAmplitudeValue double

Amplitude value of the found point.

Returns

bool

True if nearest point was found, false otherwise.