Table of Contents

Class HighLowSeriesBase

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

HighLow series.

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

Constructors

HighLowSeriesBase()

Constructor for Form designer list editor.

public HighLowSeriesBase()

HighLowSeriesBase(ViewXY, AxisX, AxisY)

Constructor.

public HighLowSeriesBase(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. You can give null if X-axis binding is used.

Properties

Antialias

Anti-alias area draw.

public bool Antialias { get; set; }

Property Value

bool

ContinuousOverScaleBreak

Draws a connecting area over ExcludeRange gap, if this flag is set.

public bool ContinuousOverScaleBreak { get; set; }

Property Value

bool

CursorTrackEnabled

Cursor tracking enabled.

public bool CursorTrackEnabled { get; set; }

Property Value

bool

DeceedColor

Deceed fill.

public Color DeceedColor { get; set; }

Property Value

Color

DeceedLimit

Deceed limit (value "of below").

public double DeceedLimit { get; set; }

Property Value

double

ExceedColor

Exceed fill.

public Color ExceedColor { get; set; }

Property Value

Color

ExceedLimit

Exceed limit.

public double ExceedLimit { get; set; }

Property Value

double

Fill

Normal fill.

public Fill Fill { get; set; }

Property Value

Fill

IndividualPointColoring

Selects how to use the individual point colors. Sets which PointStyle color is replaced with PointColor.

public PointColoringTarget IndividualPointColoring { get; set; }

Property Value

PointColoringTarget

ScrollModePointsKeepLevel

Tells how often the draw data is cleared when using X-axis scroll mode. Valid range is 1...100 1 frees the draw data and the reconstructs the draw data after every 1/10 scroll page. Use this when there's not much memory available. 100 frees the draw data and the reconstructs the draw data after every 100/10 = 10 pages. Use this when smooth scroll with high FPS is important. Reserves some extra memory.

public int ScrollModePointsKeepLevel { get; set; }

Property Value

int

ScrollingStabilizing

Stabilize scrolling mode by rounding shifting to nearest integer pixel position. Reduces wobbling of the scrolling waveform, but may show as slight X-dimensional distortion. Only applies when XAxis ScrollMode = Scrolling.ScrollMode

public bool ScrollingStabilizing { get; set; }

Property Value

bool

SimpleHighlightColor

Simple highlight color when user interactive device is over.

public Color SimpleHighlightColor { get; set; }

Property Value

Color

UseLimits

Use limits.

public bool UseLimits { get; set; }

Property Value

bool

Methods

Clear()

Clear all draw data.

public override void Clear()

Construct()

Create members.

protected override void Construct()

CreateFill()

Create fill.

protected virtual void CreateFill()

CreateLineStyle()

Create line style.

protected override void CreateLineStyle()

CreateReversedFill()

Create reverse fill.

protected virtual void CreateReversedFill()

CreateTitle()

Create title.

protected override void CreateTitle()

DeletePointsBeforeX(double)

Delete points having smaller X value than given value

public void DeletePointsBeforeX(double xValue)

Parameters

xValue double
param xValue M:LightningChartLib.WinForms.Charting.SeriesXY.HighLowSeriesBase.DeletePointsBeforeX(System.Double)

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.

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

Get min and max Y value within given X range.

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

Parameters

yMin double

Minimum Y value.

yMax double

Maximum Y value.

xRangeMin double

X range start.

xRangeMax double

X range end.

ignoreZeros bool

Ignore zeros.

Returns

bool

True if values were successfully detected.

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

xMin double

X min

xMax double

X max

Returns

bool

True if minimum X and maximum X was obtained successfully

InvalidateData()

Invalidate data array. Statistics and draw data are recalculated.

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.

SeekVisibleRangeStartPointIndex(double, int)

Seek visible range first series point index (actually one point before that)

protected int SeekVisibleRangeStartPointIndex(double startXValue, int currentRangeStartPointIndex)

Parameters

startXValue double

Start x value

currentRangeStartPointIndex int

Sweep page index

Returns

int

Start point index. If unable to find start point, returns -1

Remarks

Always make sure m_points are locked before calling this method

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

x float

X-coordinate in pixels or DIP.

useDIP bool

Use DIP instead of pixels as parameters.

Returns

LineSeriesCoordinateSolveResult

Solve result.

SolveYValueAtXValue(double)

Solve y-value or range on given x-value.

public LineSeriesValueSolveResult SolveYValueAtXValue(double x)

Parameters

x double

x-value

Returns

LineSeriesValueSolveResult

Solve status.

Events

OldDataDropped

Occurs when old data points have been dropped.

public event HighLowSeriesBase.OldDataDroppedEventHandler OldDataDropped

Event Type

HighLowSeriesBase.OldDataDroppedEventHandler