Table of Contents

Class BlockSeriesBase

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

Base class for block series.

public abstract class BlockSeriesBase : SeriesBaseXY, IChartNode, IDisposable, IHighlightingItem
Inheritance
BlockSeriesBase
Implements
Derived
Inherited Members

Constructors

BlockSeriesBase()

Constructor.

public BlockSeriesBase()

BlockSeriesBase(ViewXY, AxisX, AxisY)

Constructor.

public BlockSeriesBase(ViewXY owner, AxisX axisX, AxisY axisY)

Parameters

owner ViewXY
param owner M:LightningChartLib.WinForms.Charting.SeriesXY.BlockSeriesBase.#ctor(LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY,LightningChartLib.WinForms.Charting.Axes.AxisX,LightningChartLib.WinForms.Charting.Axes.AxisY)
axisX AxisX
param axisX M:LightningChartLib.WinForms.Charting.SeriesXY.BlockSeriesBase.#ctor(LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY,LightningChartLib.WinForms.Charting.Axes.AxisX,LightningChartLib.WinForms.Charting.Axes.AxisY)
axisY AxisY
param axisY M:LightningChartLib.WinForms.Charting.SeriesXY.BlockSeriesBase.#ctor(LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY,LightningChartLib.WinForms.Charting.Axes.AxisX,LightningChartLib.WinForms.Charting.Axes.AxisY)

Properties

Color

Gets and sets line color.

public Color Color { get; set; }

Property Value

Color

CursorTrackEnabled

DataCursor tracking enabled.

public bool CursorTrackEnabled { get; set; }

Property Value

bool

OffsetY

Offset y value. This is added to each data value when rendering.

public double OffsetY { get; set; }

Property Value

double

ScrollModePointsKeepLevel

Tells how often the source data is cleared when using X axis scroll mode. Valid range is 1...100. 1 frees the source data after every 1/10 scroll page. Use this when there's not much memory available. 100 frees the source data after every 100/10 = 10 pages. One need to set ViewXY.DropOldSeriesData to true to enable this functionality.

public int ScrollModePointsKeepLevel { get; set; }

Property Value

int

SeriesEventMarkers

Series event markers.

public SeriesEventMarkerList SeriesEventMarkers { get; set; }

Property Value

SeriesEventMarkerList

Title

Series title

public SeriesTitle Title { get; set; }

Property Value

SeriesTitle

Width

Gets and sets width of line.

public double Width { get; set; }

Property Value

double

Methods

Clear()

Clear all data.

public override void Clear()

Construct()

Create members.

protected override void Construct()

CreateTitle()

Create title.

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.

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

Get minimum and maximum Y value withing given X range.

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

GetTitleText()

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

Returns

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

GetXMinMax(out double, out double)

Get minimum X and maximum X of series X values

public virtual bool GetXMinMax(out double xMin, out double xMax)

Parameters

xMin double

X minimum.

xMax double

X maximum.

Returns

bool

True if minimum X and maximum X was obtained successfully.

InvalidateData()

Series data has been modified directly by it's array. Use this method to notify chart that this series needs a refresh.

public override void InvalidateData()

IsPositionOver(int, int, bool)

Is position over series.

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

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.

SolveNearestSampleByCoord(int, int, out double, out double, out int)

Solve nearest sample to given X and Y screen coordinate [in DIPs].

public bool SolveNearestSampleByCoord(int xCoordinate, int yCoordinate, out double nearestSampleXValue, out double nearestSampleYValue, out int nearestIndex)

Parameters

xCoordinate int

X screen coordinate [in DIPs].

yCoordinate int

Y screen coordinate [in DIPs].

nearestSampleXValue double

Nearest sample X.

nearestSampleYValue double

Nearest sample Y.

nearestIndex int

Nearest sample index in the SampleSingle or SamplesDouble array.

Returns

bool

True if successfully solved.

SolveNearestSampleByValue(double, double, out double, out double, out int)

Solve nearest sample to given X and Y value.

public virtual bool SolveNearestSampleByValue(double xValue, double yValue, out double nearestSampleXValue, out double nearestSampleYValue, out int nearestIndex)

Parameters

xValue double

X value.

yValue double

Y value.

nearestSampleXValue double

Nearest sample X.

nearestSampleYValue double

Nearest sample Y.

nearestIndex int

Nearest sample index in the SampleSingle or SamplesDouble array.

Returns

bool

True if successfully solved.

Remarks

The distance of given X and Y values and each sample is compared in screen coordinates.

SolveYValueAtXValue(double)

Solve y value at x value.

public virtual LineSeriesValueSolveResult SolveYValueAtXValue(double x)

Parameters

x double

Data x value.

Returns

LineSeriesValueSolveResult

Solve result.