Table of Contents

Class AreaSeries

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

Area series.

[TypeConverter(typeof(ExpandableObjectConverter))]
public class AreaSeries : HighLowSeriesBase, IChartNode, IDisposable, IHighlightingItem, ITrackable, IRealtimeShiftable, ISingleLineSeriesSolveResultReturningSeries
Inheritance
AreaSeries
Implements
Inherited Members

Constructors

AreaSeries()

Constructor for Form designer list editor

public AreaSeries()

AreaSeries(ViewXY, AxisX, AxisY)

Constructor.

public AreaSeries(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

BaseValue

Base value

public double BaseValue { get; set; }

Property Value

double

PointStyle

Points style.

public override PointShapeStyle PointStyle { get; set; }

Property Value

PointShapeStyle

Points

Area series points array, to store data at once.

public AreaSeriesPoint[] Points { get; set; }

Property Value

AreaSeriesPoint[]

Remarks

Use GetPoint method read one point value instead of reading the whole Points array, for performance reasons.

PointsVisible

Points visible.

public override bool PointsVisible { get; set; }

Property Value

bool

Methods

AddValues(AreaSeriesPoint[])

Add values.

public int AddValues(AreaSeriesPoint[] values)

Parameters

values AreaSeriesPoint[]

Values array.

Returns

int

Total point count after adding.

Clear()

Clear all data.

public override void Clear()

Construct()

Create members.

protected override void Construct()

CreatePointStyleHigh()

Create high point style.

protected virtual void CreatePointStyleHigh()

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.

GetPoint(int, out AreaSeriesPoint)

Get point by given index.

public bool GetPoint(int index, out AreaSeriesPoint point)

Parameters

index int

Index of point to get.

point AreaSeriesPoint

Point.

Returns

bool

False if invalid index is given, otherwise true.

GetPoint(int, out double, out double)

Get point by given index.

public bool GetPoint(int index, out double xValue, out double yValue)

Parameters

index int

Index of point to get.

xValue double

X value.

yValue double

Y value.

Returns

bool

False if invalid index is given, otherwise true.

LoadFromCSV(string, SeparatorCSV)

Loads series data from a CSV file.

public override bool LoadFromCSV(string file, SeparatorCSV separator)

Parameters

file string

CSV file. 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 override 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 save is successful