Table of Contents

Class SeriesBaseXY

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

Base class for all series

[TypeConverter(typeof(ExpandableObjectConverter))]
public abstract class SeriesBaseXY : HighlightingItemBase, IChartNode, IDisposable, IHighlightingItem
Inheritance
SeriesBaseXY
Implements
Derived
Inherited Members

Constructors

SeriesBaseXY()

Constructor

protected SeriesBaseXY()

SeriesBaseXY(IChartNode)

Constructor

protected SeriesBaseXY(IChartNode owner)

Parameters

owner IChartNode
param owner M:LightningChartLib.WinForms.Charting.SeriesXY.SeriesBaseXY.#ctor(LightningChartLib.WinForms.Charting.IChartNode)

Properties

AllowUserInteraction

Allow series reacting to user interaction device movement. Device hit testing with objects cause CPU overhead when the device is moved. If user interaction is not absolute necessary directly within chart and if you want to maximize the performance, set this false.

public bool AllowUserInteraction { get; set; }

Property Value

bool

AssignXAxisIndex

Index of X axis assigned to this series. Give -1 when you don't want to assign it yet to any X axis.

public int AssignXAxisIndex { get; set; }

Property Value

int

AssignYAxisIndex

Index of Y axis assigned to this series. Give -1 when you don't want to assign it yet to any Y axis.

public int AssignYAxisIndex { get; set; }

Property Value

int

AssignableXAxes

List of assignable X axes

public string[] AssignableXAxes { get; }

Property Value

string[]

AssignableYAxes

List of assignable Y axes

public string[] AssignableYAxes { get; }

Property Value

string[]

ClipAreas

Clip areas. Can be used to clip rendering of series data on axis x or y range.

public ClipAreaList ClipAreas { get; set; }

Property Value

ClipAreaList

DisableDragToAnotherAxis

Disable dragging from Y axis to another Y axis or from chart to another chart.
Set this true if you want to zoom in the series area, and keep other user interactive device interactivity features available.

public bool DisableDragToAnotherAxis { get; set; }

Property Value

bool

IncludeInAutoFit

Include series values in automatic fit.

public bool IncludeInAutoFit { get; set; }

Property Value

bool

LegendBoxIndex

Legendbox index.

public int LegendBoxIndex { get; set; }

Property Value

int

LegendBoxOrderIndex

Series index in LegendBox

public int LegendBoxOrderIndex { get; set; }

Property Value

int

LimitYToStackSegment

Limit Y draw range to segment area when y-axes are stacked.

public bool LimitYToStackSegment { get; set; }

Property Value

bool

OwnerView

Owner view.

[Browsable(false)]
public ViewXY OwnerView { get; }

Property Value

ViewXY

ShowInLegendBox

Enlists the series title text in Legend box of the chart

public bool ShowInLegendBox { get; set; }

Property Value

bool

Visible

Is the series visible

public bool Visible { get; set; }

Property Value

bool

ZIndex

Series Z-Index

public int ZIndex { get; set; }

Property Value

int

Methods

Clear()

Clear the series

public abstract void Clear()

Construct()

Create members.

protected virtual void Construct()

CreateTitle()

Create Title for series.

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

GetClipAreas()

Get clipping areas.

public ClipAreaList GetClipAreas()

Returns

ClipAreaList

Array reference to ClipAreas. If you modify the array, notify the chart with SetClipAreas method.

GetTitleText()

Get title text.

public virtual string GetTitleText()

Returns

string

Title text.

InvalidateData()

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

public virtual void InvalidateData()

IsPositionOver(int, int, bool)

Is mouse over item.

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

Parameters

x int

mouse x-coordinate

y int

mouse y-coordinate

useDIP bool

Use DIP instead of pixels as parameters

Returns

bool

false if mouse is not inside graph, true otherwise

LoadFromCSV(string, SeparatorCSV)

Loads series data from a CSV file.

public virtual bool LoadFromCSV(string fileName, SeparatorCSV separator)

Parameters

fileName string

Full path to the CSV file.

separator SeparatorCSV

Value separator that is used in the CSV file.

Returns

bool
returns M:LightningChartLib.WinForms.Charting.SeriesXY.SeriesBaseXY.LoadFromCSV(System.String,LightningChartLib.WinForms.Charting.SeparatorCSV)

SaveToCSV(string, SeparatorCSV)

Saves series data into CSV file

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

SetClipAreas(ClipAreaList)

Set clipping areas. Give null to disable all clip areas.

public void SetClipAreas(ClipAreaList clipAreas)

Parameters

clipAreas ClipAreaList
param clipAreas M:LightningChartLib.WinForms.Charting.SeriesXY.SeriesBaseXY.SetClipAreas(LightningChartLib.WinForms.Charting.ClipAreaList)

ToString()

Item to string.

public override string ToString()

Returns

string
returns M:LightningChartLib.WinForms.Charting.SeriesXY.SeriesBaseXY.ToString

Events

BeforeSeriesRendering

Occurs just before the rendering of the series takes place.

public event SeriesBaseXY.BeforeSeriesRenderingEventHandler BeforeSeriesRendering

Event Type

SeriesBaseXY.BeforeSeriesRenderingEventHandler

Operators

implicit operator LegendBoxObject(SeriesBaseXY)

Get item as LegendBoxMouseObject.

public static implicit operator LegendBoxObject(SeriesBaseXY s)

Parameters

s SeriesBaseXY

related object

Returns

LegendBoxObject
returns M:LightningChartLib.WinForms.Charting.SeriesXY.SeriesBaseXY.op_Implicit(LightningChartLib.WinForms.Charting.SeriesXY.SeriesBaseXY)~LightningChartLib.WinForms.Charting.Views.LegendBoxObject