Table of Contents

Class SeriesBase3D

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

Base class for all 3D series.

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

Constructors

SeriesBase3D()

LightningChartLib.WinForms.Charting.Series3D.SeriesBase3D 
public SeriesBase3D()

SeriesBase3D(View3D, Axis3DBinding, Axis3DBinding, Axis3DBinding)

Constructor

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

Parameters

owner View3D
param owner M:LightningChartLib.WinForms.Charting.Series3D.SeriesBase3D.#ctor(LightningChartLib.WinForms.Charting.Views.View3D.View3D,LightningChartLib.WinForms.Charting.Axis3DBinding,LightningChartLib.WinForms.Charting.Axis3DBinding,LightningChartLib.WinForms.Charting.Axis3DBinding)
xAxis Axis3DBinding
param xAxis M:LightningChartLib.WinForms.Charting.Series3D.SeriesBase3D.#ctor(LightningChartLib.WinForms.Charting.Views.View3D.View3D,LightningChartLib.WinForms.Charting.Axis3DBinding,LightningChartLib.WinForms.Charting.Axis3DBinding,LightningChartLib.WinForms.Charting.Axis3DBinding)
yAxis Axis3DBinding
param yAxis M:LightningChartLib.WinForms.Charting.Series3D.SeriesBase3D.#ctor(LightningChartLib.WinForms.Charting.Views.View3D.View3D,LightningChartLib.WinForms.Charting.Axis3DBinding,LightningChartLib.WinForms.Charting.Axis3DBinding,LightningChartLib.WinForms.Charting.Axis3DBinding)
zAxis Axis3DBinding
param zAxis M:LightningChartLib.WinForms.Charting.Series3D.SeriesBase3D.#ctor(LightningChartLib.WinForms.Charting.Views.View3D.View3D,LightningChartLib.WinForms.Charting.Axis3DBinding,LightningChartLib.WinForms.Charting.Axis3DBinding,LightningChartLib.WinForms.Charting.Axis3DBinding)

Properties

CursorTrackEnabled

Cursor tracking enabled.

public bool CursorTrackEnabled { get; set; }

Property Value

bool

IncludeInAutoFit

Include in autofit.

public bool IncludeInAutoFit { get; set; }

Property Value

bool

LegendBoxOrderIndex

Series index in LegendBox.

public int LegendBoxOrderIndex { get; set; }

Property Value

int

Material

Series material

public Material3D Material { get; set; }

Property Value

Material3D

OwnerView

Owner view

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

Property Value

View3D

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

XAxisBinding

X axis binding

public Axis3DBinding XAxisBinding { get; set; }

Property Value

Axis3DBinding

YAxisBinding

Y axis binding

public Axis3DBinding YAxisBinding { get; set; }

Property Value

Axis3DBinding

ZAxisBinding

Z axis binding

public Axis3DBinding ZAxisBinding { get; set; }

Property Value

Axis3DBinding

Methods

Clear()

Clear the series

public abstract void Clear()

CreateMaterial()

Create material.

protected virtual void CreateMaterial()

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.

GetMinMaxValues(out PointDouble3D, out PointDouble3D)

Get series minimum and maximum data values.

public virtual bool GetMinMaxValues(out PointDouble3D pMin, out PointDouble3D pMax)

Parameters

pMin PointDouble3D

Minimum data values

pMax PointDouble3D

Maximum data values

Returns

bool

true if data exists, false otherwise

GetTitleText()

Get series title text.

public virtual string GetTitleText()

Returns

string

Title text.

GetXAxis()

Get X axis object to which this series is bound to

public Axis3DBase GetXAxis()

Returns

Axis3DBase

Axis

GetYAxis()

Get Y axis object to which this series is bound to

public Axis3DBase GetYAxis()

Returns

Axis3DBase

Axis

GetZAxis()

Get Z axis object to which this series is bound to

public Axis3DBase GetZAxis()

Returns

Axis3DBase

Axis

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

LoadFromCSV(string, SeparatorCSV)

Loads series data from a CSV file.

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

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

ToString()

Item to string.

public override string ToString()

Returns

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

Operators

implicit operator LegendBoxObject(SeriesBase3D)

Get item as LegendBoxMouseObject.

public static implicit operator LegendBoxObject(SeriesBase3D s)

Parameters

s SeriesBase3D

related object

Returns

LegendBoxObject
returns M:LightningChartLib.WinForms.Charting.Series3D.SeriesBase3D.op_Implicit(LightningChartLib.WinForms.Charting.Series3D.SeriesBase3D)~LightningChartLib.WinForms.Charting.Views.LegendBoxObject