Table of Contents

Class LineCollection

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

Line collection. Just a bunch of lines, going from point A to B. This is not a polyline.

public class LineCollection : SeriesBaseXY, IChartNode, IDisposable, IHighlightingItem
Inheritance
LineCollection
Implements
Inherited Members

Constructors

LineCollection()

Constructor.

public LineCollection()

LineCollection(ViewXY, AxisX, AxisY)

Constructor.

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

Behind

LineCollection will be drawn behind bars.

public bool Behind { get; set; }

Property Value

bool

CursorTrackEnabled

Cursor tracking enabled.

public bool CursorTrackEnabled { get; set; }

Property Value

bool

LineStyle

Line style.

public LineStyle LineStyle { get; set; }

Property Value

LineStyle

Lines

Array of line segments. Note that you need to call InvalidateData method if you modify the array's items directly for the changes to affect the drawing. Calling InvalidateData is not necessary if the whole array is set.

public SegmentLine[] Lines { get; set; }

Property Value

SegmentLine[]

Statistics

Statistics of the series

public LineSeriesStat Statistics { get; }

Property Value

LineSeriesStat

Title

Series title

public SeriesTitle Title { get; set; }

Property Value

SeriesTitle

Methods

Clear()

Clear all data.

public override void Clear()

Construct()

Create members.

protected override void Construct()

CreateTitle()

summary M:LightningChartLib.WinForms.Charting.SeriesXY.LineCollection.CreateTitle 
protected override void CreateTitle()

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.

GetSegmentsAtPoint(double, double, bool)

Get segment indexes for segments under point.

public IntList GetSegmentsAtPoint(double x, double y, bool useDIP = true)

Parameters

x double

x-coordinate.

y double

y-coordinate.

useDIP bool

Use dips instead of pixels.

Returns

IntList
returns M:LightningChartLib.WinForms.Charting.SeriesXY.LineCollection.GetSegmentsAtPoint(System.Double,System.Double,System.Boolean)

GetTitleText()

summary M:LightningChartLib.WinForms.Charting.SeriesXY.LineCollection.GetTitleText 
public override string GetTitleText()

Returns

string
returns M:LightningChartLib.WinForms.Charting.SeriesXY.LineCollection.GetTitleText

InvalidateData()

Series data has been modified directly by it's array. Use this method to notify chart that this series needs a refresh. If this is not called after data has been changed the lines are not drawn correctly.

public override void InvalidateData()

IsPositionOver(int, int, bool)

Is position over series.

public override bool IsPositionOver(int x, int y, bool useDIP = false)

Parameters

x int

X coordinate.

y int

Y coordinate.

useDIP bool

Use DIP instead of pixels as parameters

Returns

bool

true if position is over series. Else false.

LoadFromCSV(string, SeparatorCSV)

Loads series data from a CSV file.

public override 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.

OnDeserialized(StreamingContext)

OnDeserialized is called just after the object has been deserialized

[OnDeserialized]
protected void OnDeserialized(StreamingContext context)

Parameters

context StreamingContext

Context

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

ToString()

Item to string.

public override string ToString()

Returns

string
returns M:LightningChartLib.WinForms.Charting.SeriesXY.LineCollection.ToString