Class LiteLineSeries
- Namespace
- LightningChartLib.WinForms.Charting.SeriesXY
- Assembly
- LightningChart.WinForms.Charting.NET4.dll
Lite line series. Uses arrays of points as input data: double[N,2]. Can be only used with Linear axis and DirectX11 engine.
public class LiteLineSeries : BlockSeriesBase<double[,]>, IChartNode, IDisposable, IHighlightingItem, ILevelTriggable, ISingleLineSeriesSolveResultReturningSeries, IRealtimeShiftable, ITrackable
- Inheritance
-
LiteLineSeries
- Implements
- Inherited Members
Constructors
LiteLineSeries()
Constructor.
public LiteLineSeries()
LiteLineSeries(ViewXY, AxisX, AxisY)
Constructor.
public LiteLineSeries(ViewXY owner, AxisX axisX, AxisY axisY)
Parameters
Properties
this[int]
Get point at index.
public PointDouble2D this[int index] { get; }
Parameters
indexintIndex to point.
Property Value
- PointDouble2D
Point at index.
LimitYToStackSegment
Line rendering limit on y-axis.
public LimitYToSegment LimitYToStackSegment { get; set; }
Property Value
PointCount
Added point count.
public int PointCount { get; }
Property Value
Points
Series points.
public double[][,] Points { set; }
Property Value
- double[][,]
Methods
AddPoints(double[,], bool)
Add points to end of series, [N,2] format, where [i,0] is x and [i,1] is y.
public int AddPoints(double[,] data, bool invalidateChart)
Parameters
datadouble[,]Data array.
invalidateChartboolUpdate chart after adding data. Updating will raise CPU load, which is why usage of this method is not recommended with every call if points are added many times per second.
Returns
- int
Series sample count after adding.
Construct()
Construct some properties.
protected override void Construct()
DeletePointsBeforeX(double, bool)
Delete all blocks where the last point in the block has smaller X value than the given value. Note, the block is formed when AddPoints method is called.
public void DeletePointsBeforeX(double xValue, bool compactMemory = true)
Parameters
GetMinMaxFromXRange(out double, out double, double, double, bool)
Get minimum and maximum Y value withing given X range.
public override bool GetMinMaxFromXRange(out double yMin, out double yMax, double xRangeMin, double xRangeMax, bool ignoreZeros)
Parameters
yMindoubleMinimum Y value.
yMaxdoubleMaximum Y value.
xRangeMindoubleX range start.
xRangeMaxdoubleX range end.
ignoreZerosboolIgnore zeros.
Returns
- bool
True if values were successfully detected.
GetPointAtIndex(int)
Get point at index.
public PointDouble2D GetPointAtIndex(int index)
Parameters
indexintIndex to point.
Returns
- PointDouble2D
Point at index.
GetXMinMax(out double, out double)
Get minimum X and maximum X of series X values
public override bool GetXMinMax(out double xMin, out double xMax)
Parameters
Returns
- bool
True if minimum X and maximum X was obtained successfully.
SeekTriggerPos(out double, double, double, double, TriggeringEdge)
Detect triggering position from series data.
public bool SeekTriggerPos(out double trigPosX, double trigLevel, double seekStartX, double seekEndX, TriggeringEdge edge)
Parameters
trigPosXdoubleOutput triggered X position.
trigLeveldoubleTrigger level Y value.
seekStartXdoubleMinimum X value that is investigated.
seekEndXdoubleMaximum X value that is investigated.
edgeTriggeringEdgeTriggering edge.
Returns
- bool
True if trigger position was detected, otherwise false.
SolveYCoordAtXCoord(float, bool)
Find nearest series point of given X-coordinate and get corresponding Y-coordinate.
public LineSeriesCoordinateSolveResult SolveYCoordAtXCoord(float x, bool useDIP = false)
Parameters
Returns
- LineSeriesCoordinateSolveResult
Solve result.
SolveYValueAtXValue(double)
Solve Y value on given X value. Returned value will be interpolated, if X is between sequential points X values.
public override LineSeriesValueSolveResult SolveYValueAtXValue(double x)
Parameters
xdoubleX value.
Returns
- LineSeriesValueSolveResult
Solve status. NearestX will be double.NaN if point is not in the data range.
Events
OldDataDropped
Occurs when old data samples have been dropped.
public event LiteLineSeries.OldDataDroppedEventHandler OldDataDropped