Table of Contents

Class PointLineSeries3D

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

3D Point line series. Allows drawing a line with points, or just line, or just points.

public class PointLineSeries3D : SeriesBase3D, IChartNode, IDisposable, IHighlightingItem
Inheritance
PointLineSeries3D
Implements
Inherited Members

Constructors

PointLineSeries3D()

Constructor mainly for visual designer.

public PointLineSeries3D()

PointLineSeries3D(View3D, Axis3DBinding, Axis3DBinding, Axis3DBinding)

Constructor.

public PointLineSeries3D(View3D owner, Axis3DBinding xAxis, Axis3DBinding yAxis, Axis3DBinding zAxis)

Parameters

owner View3D

Parent.

xAxis Axis3DBinding

X-axis you want to bind.

yAxis Axis3DBinding

Y-axis you want to bind.

zAxis Axis3DBinding

Z-axis you want to bind.

Properties

ClosedLine

Connects end and start point by drawing line between them.

public bool ClosedLine { get; set; }

Property Value

bool

DataBreaking

Data breaking options. Defines, if gaps are enabled on series data and by which value. Default state is disabled and default gap value is Double.NaN;

public DataBreakingOptions DataBreaking { get; set; }

Property Value

DataBreakingOptions

IndividualPointColors

Each point can have different color.

public bool IndividualPointColors { get; set; }

Property Value

bool

IndividualPointSizes

Each point can have different size.

public bool IndividualPointSizes { get; set; }

Property Value

bool

LastHitTestIndex

Get last data index at hit coordinates. Return -1 if did not hit.

public int LastHitTestIndex { get; }

Property Value

int

LineStyle

Line style

public LineStyle3D LineStyle { get; set; }

Property Value

LineStyle3D

LineVisible

Is line visible or not

public bool LineVisible { get; set; }

Property Value

bool

MultiColorLine

Draw lines with color gradients between points.

public bool MultiColorLine { get; set; }

Property Value

bool

PointCount

Point count stored in the Points array

public int PointCount { get; set; }

Property Value

int

PointStyle

Point style settings

public PointStyle3D PointStyle { get; set; }

Property Value

PointStyle3D

Points

Points array.

public SeriesPoint3D[] Points { get; set; }

Property Value

SeriesPoint3D[]

PointsCompact

Compact points array.

public SeriesPointCompact3D[] PointsCompact { get; set; }

Property Value

SeriesPointCompact3D[]

PointsCompactColored

Colored compact points array.

public SeriesPointCompactColored3D[] PointsCompactColored { get; set; }

Property Value

SeriesPointCompactColored3D[]

PointsOptimization

Point rendering optimization.

public PointsRenderOptimization3D PointsOptimization { get; set; }

Property Value

PointsRenderOptimization3D

PointsType

Series points type

public PointsType3D PointsType { get; set; }

Property Value

PointsType3D

PointsVisible

Are points visible or not

public bool PointsVisible { get; set; }

Property Value

bool

Title

Series title

public SeriesTitle3D Title { get; set; }

Property Value

SeriesTitle3D

Methods

AddPoints(SeriesPoint3D[], bool)

Add SeriesPoint3D points to end of series.

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

Parameters

points SeriesPoint3D[]

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

Count of points in the Points array.

AddPoints(SeriesPointCompact3D[], bool)

Add SeriesPointCompact3D points to end of series.

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

Parameters

points SeriesPointCompact3D[]

Points.

invalidateChart bool
param invalidateChart M:LightningChartLib.WinForms.Charting.Series3D.PointLineSeries3D.AddPoints(LightningChartLib.WinForms.Charting.SeriesPointCompact3D[],System.Boolean)

Returns

int

Count of points in the PointsCompact array.

AddPoints(SeriesPointCompactColored3D[], bool)

Add SeriesPointCompactColored3D points to end of series.

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

Parameters

points SeriesPointCompactColored3D[]
param points M:LightningChartLib.WinForms.Charting.Series3D.PointLineSeries3D.AddPoints(LightningChartLib.WinForms.Charting.SeriesPointCompactColored3D[],System.Boolean)
invalidateChart bool
param invalidateChart M:LightningChartLib.WinForms.Charting.Series3D.PointLineSeries3D.AddPoints(LightningChartLib.WinForms.Charting.SeriesPointCompactColored3D[],System.Boolean)

Returns

int

Count of points in PointsCompactColored array.

Clear()

Clear all points

public override void Clear()

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.

GetTitleText()

summary M:LightningChartLib.WinForms.Charting.Series3D.PointLineSeries3D.GetTitleText 
public override string GetTitleText()

Returns

string
returns M:LightningChartLib.WinForms.Charting.Series3D.PointLineSeries3D.GetTitleText

IsPositionOver(int, int, out int, out bool, out bool, bool)

Additional method to check if position is over, solves also index of the nearest point or line segment if it hits it.

public bool IsPositionOver(int x, int y, out int index, out bool overLine, out bool overPoint, bool useDIP = false)

Parameters

x int

X screen coordinate.

y int

Y screen coordinate.

index int

Index of nearest point or line segment.

overLine bool

Is the mouse over line.

overPoint bool

Is the mouse over a point.

useDIP bool

Use DIP instead of pixels for coordinates.

Returns

bool
returns M:LightningChartLib.WinForms.Charting.Series3D.PointLineSeries3D.IsPositionOver(System.Int32,System.Int32,System.Int32@,System.Boolean@,System.Boolean@,System.Boolean)

LoadFromCSV(string, SeparatorCSV)

Loads series data from a CSV file. Note that this loads only points with set point type (PointsType property).

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. Note that this saves only points with set point type (PointsType property).

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 export is successful.

ToString()

Item to string.

public override string ToString()

Returns

string
returns M:LightningChartLib.WinForms.Charting.Series3D.PointLineSeries3D.ToString