Table of Contents

Class PointLineSeriesBase

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

Base class for point line series.

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

Constructors

PointLineSeriesBase()

Creates and initializes a new instance of this class.

public PointLineSeriesBase()

PointLineSeriesBase(ViewXY)

Creates and initializes a new instance of this class.

public PointLineSeriesBase(ViewXY owner)

Parameters

owner ViewXY
param owner M:LightningChartLib.WinForms.Charting.SeriesXY.PointLineSeriesBase.#ctor(LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY)

Properties

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

LineStyle

Line style

public virtual LineStyle LineStyle { get; set; }

Property Value

LineStyle

LineVisible

Is line visible or not

public virtual bool LineVisible { get; set; }

Property Value

bool

PointCount

Point count stored in the Points array

public int PointCount { get; }

Property Value

int

PointStyle

Point style

public virtual PointShapeStyle PointStyle { get; set; }

Property Value

PointShapeStyle

PointsOptimization

Points rendering optimization

public PointsRenderOptimization PointsOptimization { get; set; }

Property Value

PointsRenderOptimization

PointsVisible

Are points visible or not

public virtual bool PointsVisible { get; set; }

Property Value

bool

SeriesEventMarkers

Series event markers

public SeriesEventMarkerList SeriesEventMarkers { get; set; }

Property Value

SeriesEventMarkerList

Statistics

Statistics of the series

public LineSeriesStat Statistics { get; }

Property Value

LineSeriesStat

Title

Series title

public SeriesTitle Title { get; set; }

Property Value

SeriesTitle

UsePalette

Use palette for line coloring.

public bool UsePalette { get; set; }

Property Value

bool

ValueRangePalette

Color palette for Y value range.

public ValueRangePalette ValueRangePalette { get; set; }

Property Value

ValueRangePalette

Methods

Clear()

Clear the series data

public override void Clear()

Construct()

Create members.

protected override void Construct()

CreateLineStyle()

Create line style.

protected virtual void CreateLineStyle()

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 within 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.

GetMinMaxFromXRangeIgnoreValue(out double, out double, double, double, double)

This is similar to GetMinMaxFromXRange, but tailored for Series with DataBreaking. Get minimum and maximum Y value within given X range, but Ignore some values (gap defining value).

public virtual bool GetMinMaxFromXRangeIgnoreValue(out double yMin, out double yMax, double xRangeMin, double xRangeMax, double dIgnoreValue)

Parameters

yMin double

Minimum Y value.

yMax double

Maximum Y value.

xRangeMin double

X range start.

xRangeMax double

X range end.

dIgnoreValue double

Gap defining.

Returns

bool

True if values were successfully detected.

GetTitleText()

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

Returns

string
returns M:LightningChartLib.WinForms.Charting.SeriesXY.PointLineSeriesBase.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.

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.

ItemListChanged(object, ListChangedEventArgs)

Render chart if item list changed.

protected virtual void ItemListChanged(object sender, ListChangedEventArgs e)

Parameters

sender object
param sender M:LightningChartLib.WinForms.Charting.SeriesXY.PointLineSeriesBase.ItemListChanged(System.Object,System.ComponentModel.ListChangedEventArgs)
e ListChangedEventArgs
param e M:LightningChartLib.WinForms.Charting.SeriesXY.PointLineSeriesBase.ItemListChanged(System.Object,System.ComponentModel.ListChangedEventArgs)

OnDeserialized(StreamingContext)

OnDeserialized is called just after the object has been deserialized

[OnDeserialized]
protected void OnDeserialized(StreamingContext context)

Parameters

context StreamingContext

Context

SetProperCursor()

Set proper drag cursor. Default is hand.

public override void SetProperCursor()

Events

CustomLinePointColoringAndShaping

Custom line coloring and line coordinates event. Event handler must give color for each data point received in the handler. The coordinates can be adjusted as well and new line points can be inserted.

public event PointLineSeriesBase.CustomLinePointColoringAndShapingEventHandler CustomLinePointColoringAndShaping

Event Type

PointLineSeriesBase.CustomLinePointColoringAndShapingEventHandler