Table of Contents

Class BarSeries

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

Bar series. Bars series present the data as vertical column(s).

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

Constructors

BarSeries()

Constructor for Form designer list editor.

public BarSeries()

BarSeries(ViewXY, AxisX, AxisY)

Constructor.

public BarSeries(ViewXY ownerView, AxisX axisX, AxisY axisY)

Parameters

ownerView ViewXY

Parent.

axisX AxisX

X-axis you want to bind.

axisY AxisY

Y-axis you want to bind.

Properties

BarThickness

Bar width in pixels

public int BarThickness { get; set; }

Property Value

int

BaseLevel

Base level value.

public double BaseLevel { get; set; }

Property Value

double

BorderColor

Border color

public Color BorderColor { get; set; }

Property Value

Color

BorderWidth

Border width

public double BorderWidth { get; set; }

Property Value

double

CursorTrackEnabled

Cursor tracking enabled.

public bool CursorTrackEnabled { get; set; }

Property Value

bool

Fill

Fill

public Fill Fill { get; set; }

Property Value

Fill

LabelStyle

Bar labels style

public BarLabelsStyle LabelStyle { get; set; }

Property Value

BarLabelsStyle

Shadow

Shadow below the bar

public Shadow Shadow { get; set; }

Property Value

Shadow

Title

Series title

public SeriesTitle Title { get; set; }

Property Value

SeriesTitle

Values

Series values

public BarSeriesValue[] Values { get; set; }

Property Value

BarSeriesValue[]

ValuesCount

Values count stored in the Values array.

public int ValuesCount { get; }

Property Value

int

Methods

AddValue(double, double, string, bool)

Add value to end of Values array

public int AddValue(double xValue, double yValue, string text, bool invalidateChart)

Parameters

xValue double

X value

yValue double

Y value

text string

Text

invalidateChart bool

Refresh chart after value adding

Returns

int

New value index

Clear()

Clear all points

public override void Clear()

Construct()

Create members.

protected override void Construct()

CreateTitle()

summary M:LightningChartLib.WinForms.Charting.SeriesXY.BarSeries.CreateTitle 
protected override void CreateTitle()

DeleteValue(int, bool)

Delete a value by given index.

public bool DeleteValue(int valueIndex, bool invalidateChart)

Parameters

valueIndex int

Index of value to be deleted.

invalidateChart bool

Refresh chart after value deleting.

Returns

bool

False if invalid index is given, otherwise true.

DeleteValuesBeforeX(double)

Delete values having smaller X value than given value.

public void DeleteValuesBeforeX(double xValue)

Parameters

xValue double

X value.

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.

GetBarRectangles()

Get rendered bar rectangles of all data items of this series.

public RectangleXY[] GetBarRectangles()

Returns

RectangleXY[]
returns M:LightningChartLib.WinForms.Charting.SeriesXY.BarSeries.GetBarRectangles

Remarks

Only available when the chart has been rendered.

GetText(int)

Get Text by given index.

public string GetText(int valueIndex)

Parameters

valueIndex int

Value index.

Returns

string

Text value. If invalid index is given, returns "".

GetTitleText()

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

Returns

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

GetXValue(int)

Get X value by given index.

public double GetXValue(int valueIndex)

Parameters

valueIndex int

Value index.

Returns

double

X value. If invalid index is given, returns 0.

GetYValue(int)

Get Y value by given index.

public double GetYValue(int valueIndex)

Parameters

valueIndex int

Value index.

Returns

double

Y value. If invalid index is given, returns 0.

InvalidateData()

Notify series that data has been changed and refresh is required.

public override void InvalidateData()

IsPositionOver(int, int, bool)

Is position over item.

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 is over item, false otherwise

IsPositionOver(int, int, out int, bool)

Is position over item.

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

Parameters

x int

x-coordinate

y int

y-coordinate

valueIndex int

Index of value the position is over of

useDIP bool

Use DIP instead of pixels as parameters

Returns

bool

True if position is over item, false otherwise

LoadFromCSV(string, SeparatorCSV)

Loads series data from a CSV file.

public override bool LoadFromCSV(string file, SeparatorCSV separator)

Parameters

file string

CSV file. If file does not exist, LoadFromCSV returns false.

separator SeparatorCSV

Value and floating point number separator.

Returns

bool

True if import succeeds. Otherwise false.

OnDeserialized(StreamingContext)

OnDeserialized is called just after the object has been deserialized

[OnDeserialized]
protected void OnDeserialized(StreamingContext context)

Parameters

context StreamingContext

Context

SaveToCSV(string, SeparatorCSV)

Saves series data into CSV file.

public override 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 save is successful

SetValue(int, double, double, string, bool)

Set value by given index

public bool SetValue(int valueIndex, double xValue, double yValue, string text, bool invalidateChart)

Parameters

valueIndex int

Index of value to be set

xValue double

X value

yValue double

Y value

text string

Text

invalidateChart bool

Refresh chart after value setting

Returns

bool

False if invalid index is given, else true

SortData(bool)

Sort data values ascending or descending. Makes big values to be drawn closest to axis zero if sort by ascending.

public void SortData(bool ascending)

Parameters

ascending bool

If true, sort ascending else descending.

ToString()

Item to string.

public override string ToString()

Returns

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

Events

OldDataDropped

Occurs when old data points have been dropped.

public event BarSeries.OldDataDroppedEventHandler OldDataDropped

Event Type

BarSeries.OldDataDroppedEventHandler