Table of Contents

Class BarSeries3D

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

3D Bar series.

public class BarSeries3D : SeriesBase3D, IChartNode, IDisposable, IHighlightingItem
Inheritance
BarSeries3D
Implements
Inherited Members

Constructors

BarSeries3D()

Constructor for Form designer list editor.

public BarSeries3D()

BarSeries3D(View3D, Axis3DBinding, Axis3DBinding, Axis3DBinding)

Constructor.

public BarSeries3D(View3D owner, Axis3DBinding xAxis, Axis3DBinding yAxis, Axis3DBinding zAxis)

Parameters

owner View3D

Parent.

xAxis Axis3DBinding

X-axis you want to bind.

yAxis Axis3DBinding

Y-axis you want to bind.

zAxis Axis3DBinding

Z-axis you want to bind.

Properties

BarDepth

Bar depth.

public double BarDepth { get; set; }

Property Value

double

BarWidth

Bar width.

public double BarWidth { get; set; }

Property Value

double

BaseLevel

Base level.

public double BaseLevel { get; set; }

Property Value

double

CornerPercentage

Corner percentage on rounded cylinder and beveled styles.

public double CornerPercentage { get; set; }

Property Value

double

DetailLevel

Detail level on some draw styles.

public int DetailLevel { get; set; }

Property Value

int

Shape

Bar shape.

public BarShape3D Shape { get; set; }

Property Value

BarShape3D

Title

Series title.

public SeriesTitle3DBar Title { get; set; }

Property Value

SeriesTitle3DBar

ValueCount

Value count stored in the Values array.

public int ValueCount { get; }

Property Value

int

ValueLabelSettings

Series value text display properties.

public ValueTitle3DBar ValueLabelSettings { get; set; }

Property Value

ValueTitle3DBar

Values

Values array.

public BarSeriesValue3D[] Values { get; set; }

Property Value

BarSeriesValue3D[]

Methods

AddValue(double, double, double, string, bool)

Add value to end of Values array.

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

Parameters

xValue double

X value.

yValue double

Y value.

zValue double

Z value.

text string

Text.

invalidateChart bool

Refresh chart after value adding.

Returns

int

New value index.

AddValues(BarSeriesValue3D[], bool)

Add values to end of series.

public int AddValues(BarSeriesValue3D[] values, bool invalidateChart)

Parameters

values BarSeriesValue3D[]

Values.

invalidateChart bool

Update chart after adding. Updating will raise CPU load, so you maybe don't want to use this with every call if points are added many times per second.

Returns

int

Value count after adding.

Clear()

Clear series.

public override void Clear()

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.

GetBarInfoOnUserInteractiveDeviceLocation(out int, out double, out double, out double)

Get info of bar over which the user interactive device is over.

public bool GetBarInfoOnUserInteractiveDeviceLocation(out int barValueIndex, out double xValue, out double yValue, out double zValue)

Parameters

barValueIndex int

Bar value index.

xValue double

Bar X value.

yValue double

Bar Y value.

zValue double

Bar Z value.

Returns

bool

True if info found, false otherwise.

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.Series3D.BarSeries3D.GetTitleText 
public override string GetTitleText()

Returns

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

GetZValue(int)

Get Z value by given index.

public double GetZValue(int valueIndex)

Parameters

valueIndex int

Value index.

Returns

double

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

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 export is successful.

ToString()

Item to string.

public override string ToString()

Returns

string
returns M:LightningChartLib.WinForms.Charting.Series3D.BarSeries3D.ToString

ValueToString(object, SupplyCustomValueStringEventArgs)

Event callback caller.

protected void ValueToString(object sender, SupplyCustomValueStringEventArgs e)

Parameters

sender object
param sender M:LightningChartLib.WinForms.Charting.Series3D.BarSeries3D.ValueToString(System.Object,LightningChartLib.WinForms.Charting.Series3D.SupplyCustomValueStringEventArgs)
e SupplyCustomValueStringEventArgs

Event.

Events

SupplyCustomValueString

The event for formatting a value to a custom string.

public event BarSeries3D.SupplyCustomValueStringEventHandler SupplyCustomValueString

Event Type

BarSeries3D.SupplyCustomValueStringEventHandler