Table of Contents

Class IntensitySeriesBase

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

Base class for intensity series classes.

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

Constructors

IntensitySeriesBase()

Constructor.

public IntensitySeriesBase()

IntensitySeriesBase(IChartNode)

Constructor.

public IntensitySeriesBase(IChartNode owner)

Parameters

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

Properties

ContourLineLabels

Contour Line Label's properties. Property tree: if enabled; format, font and color of text. Default state is disabled;

public ContourLineLabels ContourLineLabels { get; set; }

Property Value

ContourLineLabels

ContourLineStyle

Line style.

public virtual LineStyle ContourLineStyle { get; set; }

Property Value

LineStyle

ContourLineType

Contour line style.

public ContourLineTypeXY ContourLineType { get; set; }

Property Value

ContourLineTypeXY

CursorTrackEnabled

Enable DataCursor tracking.

public bool CursorTrackEnabled { get; set; }

Property Value

bool

Data

Intensity point data.

public IntensityPoint[,] Data { get; set; }

Property Value

IntensityPoint[,]

FastContourZoneRange

Data value range for fast contour zones. The fast contour zone is a contour line equivalent.

public double FastContourZoneRange { get; set; }

Property Value

double

Fill

Fill.

public IntensityFillStyle Fill { get; set; }

Property Value

IntensityFillStyle

FullInterpolation

Render with full interpolation. If only half interpolation is used, it can give performance increment with large intensity series.

public bool FullInterpolation { get; set; }

Property Value

bool

InitialValue

Initial value for data Y. Clears the series. It is applied when creating or resizing Data array.

public double InitialValue { get; set; }

Property Value

double

LegendBoxUnits

Intensity series units, shown in legend box. Use this for intensity data units, not Y-axis units.

public string LegendBoxUnits { get; set; }

Property Value

string

LegendBoxValueType

Value type: time, numeric or coordinates. Affects legend box value formatting.

public AxisValueType LegendBoxValueType { get; set; }

Property Value

AxisValueType

LegendBoxValuesFormat

Numeric format for showing legend box value labels.

public string LegendBoxValuesFormat { get; set; }

Property Value

string

Optimization

Optimization selection for the series usage. Use StaticData if data does not changed frequently, allowing faster updates when other objects in the chart are updating.
DynamicData selection is better when the data is changed many times / second.

public IntensitySeriesOptimization Optimization { get; set; }

Property Value

IntensitySeriesOptimization

ShowNodes

Show nodes.

public bool ShowNodes { get; set; }

Property Value

bool

SizeX

Grid size in X dimension (Data array columns).

public int SizeX { get; set; }

Property Value

int

SizeY

Grid size in Y dimension (Data array rows).

public int SizeY { get; set; }

Property Value

int

Stencil

Stencil.

public IntensitySeriesStencil Stencil { get; set; }

Property Value

IntensitySeriesStencil

Title

Series title.

public SeriesTitle Title { get; set; }

Property Value

SeriesTitle

ToneColor

Surface tone color.

public Color ToneColor { get; set; }

Property Value

Color

TraceCell

Tracing the surface cell is enabled.

public bool TraceCell { get; set; }

Property Value

bool

ValueRangePalette

Color palette for Y value information.

public ValueRangePalette ValueRangePalette { get; set; }

Property Value

ValueRangePalette

VisibleCursorData

Determine DataCursor ResultTable visible data.

public IntensitySeriesCursorData VisibleCursorData { get; set; }

Property Value

IntensitySeriesCursorData

WireframeLineStyle

Wireframe line style.

public LineStyle WireframeLineStyle { get; set; }

Property Value

LineStyle

WireframeType

Wireframe type.

public SurfaceWireframeType WireframeType { get; set; }

Property Value

SurfaceWireframeType

Methods

CheckSurfaceSizeForGPU(int, int)

Check if the given surface size can be used with the GPU. GPU index buffer capacity is verified.

public bool CheckSurfaceSizeForGPU(int gridSizeX, int gridSizeZ)

Parameters

gridSizeX int

X size.

gridSizeZ int

Z size.

Returns

bool

True if index buffer size on the GPU is sufficient, else false.

Clear()

Clears the series. Initializes Data with InitialValues. Sets the data point colors to BaseColor.

public override void Clear()

Construct()

Create members.

protected override void Construct()

CreateNewDataArray(int, int)

Create new data array.

public virtual void CreateNewDataArray(int sizeX, int sizeY)

Parameters

sizeX int

X size.

sizeY int

Y size.

CreateTitle()

summary M:LightningChartLib.WinForms.Charting.SeriesXY.IntensitySeriesBase.CreateTitle 
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.

DisposeStaticBuffers(int)

Free all vertex and index buffer data

protected void DisposeStaticBuffers(int sweepPageIndex)

Parameters

sweepPageIndex int
param sweepPageIndex M:LightningChartLib.WinForms.Charting.SeriesXY.IntensitySeriesBase.DisposeStaticBuffers(System.Int32)

GetContourRoutes(out List<List<PointDouble2D[]>>, out List<double>, out List<Color>)

Get Contour to the List of levels, which is List of polylines/routes. The contour lines are rebuild with current palette steps' value and color.

public void GetContourRoutes(out List<List<PointDouble2D[]>> listContourRoutes, out List<double> lContourLevelValues, out List<Color> lContourLevelColors)

Parameters

listContourRoutes List<List<PointDouble2D[]>>

The List of list of polylines for each contour step value.

lContourLevelValues List<double>

The list of contour's step values.

lContourLevelColors List<Color>

The list of contour's step colors.

GetDataColor(int, int)

Get Data array color

public Color GetDataColor(int columnIndex, int rowIndex)

Parameters

columnIndex int

Column index of Data array

rowIndex int

Row index of Data array

Returns

Color

Color. If invalid index is given, returns Color.Black.

GetDataColor(int, int, out Color)

Get Data array color.

public bool GetDataColor(int columnIndex, int rowIndex, out Color color)

Parameters

columnIndex int

Column index of Data array

rowIndex int

Row index of Data array

color Color

Color.

Returns

bool

True, if valid indexes. If invalid index is given, false and returns Color.Black.

GetDataValue(int, int)

Get Data array value.

public double GetDataValue(int columnIndex, int rowIndex)

Parameters

columnIndex int

Column index of Data array.

rowIndex int

Row index of Data array.

Returns

double

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

GetDataValue(int, int, out double)

Get Data array value.

public bool GetDataValue(int columnIndex, int rowIndex, out double value)

Parameters

columnIndex int

Column index of Data array.

rowIndex int

Row index of Data array.

value double

Y value. In case of error, 0.

Returns

bool

True, if valid indexes, false otherwise.

GetDataXValue(int, int)

Get Data array X value.

public double GetDataXValue(int columnIndex, int rowIndex)

Parameters

columnIndex int

Column index of Data array.

rowIndex int

Row index of Data array.

Returns

double

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

GetDataXValue(int, int, out double)

Get Data array X value.

public bool GetDataXValue(int columnIndex, int rowIndex, out double value)

Parameters

columnIndex int

Column index of Data array.

rowIndex int

Row index of Data array.

value double

X value. In case of error, 0.

Returns

bool

True, if valid indexes, false otherwise.

GetDataYValue(int, int)

Get Data array Y value.

public double GetDataYValue(int columnIndex, int rowIndex)

Parameters

columnIndex int

Column index of Data array.

rowIndex int

Row index of Data array.

Returns

double

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

GetDataYValue(int, int, out double)

Get Data array Y value.

public bool GetDataYValue(int columnIndex, int rowIndex, out double value)

Parameters

columnIndex int

Column index of Data array.

rowIndex int

Row index of Data array.

value double

Y value. In case of error, 0.

Returns

bool

True, if valid indexes, false otherwise.

GetFastValuesData()

Get fast values data.

public double[][] GetFastValuesData()

Returns

double[][]
returns M:LightningChartLib.WinForms.Charting.SeriesXY.IntensitySeriesBase.GetFastValuesData

GetMinimumsAndMaximums(out double, out double, out double, out double, out double, out double)

Get minimums and maximums of Series X, Y and data Values.

public virtual bool GetMinimumsAndMaximums(out double minX, out double maxX, out double minY, out double maxY, out double minValue, out double maxValue)

Parameters

minX double

Minimum X.

maxX double

Maximum X.

minY double

Minimum Y.

maxY double

Maximum Y.

minValue double

Minimum data value.

maxValue double

Maximum data value.

Returns

bool

True if data could be analyzed and output values are valid, otherwise false.

GetTitleText()

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

Returns

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

InvalidateColorsOnly()

Invalidate colors only. Use this together with Optimization = DynamicValuesData. Does not update the geometry to the GPU when not needed, allowing significantly faster rendering.

public void InvalidateColorsOnly()

InvalidateData()

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

public override void InvalidateData()

InvalidateStencil()

Invalidate stencil data.

public void InvalidateStencil()

InvalidateValuesDataOnly()

Invalidate values data only. Use this together with Optimization = DynamicValuesData. Does not update the geometry to the GPU when not needed, allowing significantly faster rendering.

public void InvalidateValuesDataOnly()

IsCoordinateOverCell(int, int, out int, out int, bool)

Check if coordinate is over cell in the series.

public bool IsCoordinateOverCell(int x, int y, out int hitColumn, out int hitRow, bool useDIP = true)

Parameters

x int

X-coordinate.

y int

Y-coordinate.

hitColumn int

Returned column index.

hitRow int

Returned row index.

useDIP bool

Use DIP instead of pixels as parameters.

Returns

bool

True, if coordinate is over some cell, false otherwise.

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 override bool LoadFromCSV(string file, SeparatorCSV separator)

Parameters

file string

CSV file name. 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

RefreshRenderingData(double, double, int, float, float)

Rebuilds rendering data. Expert's method for allowing multi-threaded application to pre-build rendering data before rendering stage. Rendering stage must always be synchronized to main thread, but this call can be called parallel for every series of this type.

public void RefreshRenderingData(double xAxisMin, double xAxisMax, int sweepPageIndex, float graphSegmentTop, float graphSegmentHeight)

Parameters

xAxisMin double

X-axis minimum.

xAxisMax double

X-axis maximum.

sweepPageIndex int

X-axis sweeping page index (set 0 if sweeping is not used).

graphSegmentTop float

Graph segment top.

graphSegmentHeight float

Graph segment height.

SaveToCSV(string, SeparatorCSV)

Saves series data into a 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

SetColorsData(int[][], IntensityGridValuesDataOrder)

Sets colors. Doesn't update the Data array contents itself. Very handy to make the chart render fast when the colors are being changed frequently, especially with IntensityGridSeries' PixelRendering mode enabled.

public bool SetColorsData(int[][] colorsArgb, IntensityGridValuesDataOrder order)

Parameters

colorsArgb int[][]

Data. The alignment must be M x N, all rows must be of equal length.

order IntensityGridValuesDataOrder

Jagged array order dimensions order. Is first array dimension columns and second dimension rows, or vice versa.

Returns

bool

Success status.

Remarks

Only works when Fill = FromSurfacePoints.

SetDataValue(int, int, double, double, double, Color)

summary M:LightningChartLib.WinForms.Charting.SeriesXY.IntensitySeriesBase.SetDataValue(System.Int32,System.Int32,System.Double,System.Double,System.Double,System.Drawing.Color) 
public bool SetDataValue(int columnIndex, int rowIndex, double x, double y, double value, Color color)

Parameters

columnIndex int
param columnIndex M:LightningChartLib.WinForms.Charting.SeriesXY.IntensitySeriesBase.SetDataValue(System.Int32,System.Int32,System.Double,System.Double,System.Double,System.Drawing.Color)
rowIndex int
param rowIndex M:LightningChartLib.WinForms.Charting.SeriesXY.IntensitySeriesBase.SetDataValue(System.Int32,System.Int32,System.Double,System.Double,System.Double,System.Drawing.Color)
x double
param x M:LightningChartLib.WinForms.Charting.SeriesXY.IntensitySeriesBase.SetDataValue(System.Int32,System.Int32,System.Double,System.Double,System.Double,System.Drawing.Color)
y double
param y M:LightningChartLib.WinForms.Charting.SeriesXY.IntensitySeriesBase.SetDataValue(System.Int32,System.Int32,System.Double,System.Double,System.Double,System.Drawing.Color)
value double
param value M:LightningChartLib.WinForms.Charting.SeriesXY.IntensitySeriesBase.SetDataValue(System.Int32,System.Int32,System.Double,System.Double,System.Double,System.Drawing.Color)
color Color
param color M:LightningChartLib.WinForms.Charting.SeriesXY.IntensitySeriesBase.SetDataValue(System.Int32,System.Int32,System.Double,System.Double,System.Double,System.Drawing.Color)

Returns

bool
returns M:LightningChartLib.WinForms.Charting.SeriesXY.IntensitySeriesBase.SetDataValue(System.Int32,System.Int32,System.Double,System.Double,System.Double,System.Drawing.Color)

SetHeightDataFromBitmap(double, double, double, double, double, double, Bitmap, BitmapAntialiasOptions)

Create data based on bitmap file contents. Data array will have dimensions of the bitmap Width X Height. Use options to reduce resolution and smooth it if needed. Height data of is calculated for each pixel from R, G, and B sum. 0 (black) will have the minimum value, and maximum value is obtained from 3*255 (white). If bitmap has alpha value of 0, the data is set to -INF, and the value is not drawn.

public bool SetHeightDataFromBitmap(double xMin, double xMax, double yMin, double yMax, double intensityMin, double intensityMax, Bitmap bitmapIn, BitmapAntialiasOptions options)

Parameters

xMin double

Minimum X.

xMax double

Maximum X.

yMin double

Minimum Y.

yMax double

Maximum Y.

intensityMin double

Minimum intensity.

intensityMax double

Maximum intensity.

bitmapIn Bitmap

Input bitmap.

options BitmapAntialiasOptions

Bitmap resolution decrement and smoothing options. Give null to use pure bitmap data only.

Returns

bool

True if data was successfully filled, else false.

SetSize(int, int)

Set grid size, both X and Y at same time. If you already have a large existing data, using this method is faster than setting SizeX and SizeY separately.

public void SetSize(int sizeX, int sizeY)

Parameters

sizeX int

X size.

sizeY int

Y size.

SetValuesData(double[][], IntensityGridValuesDataOrder)

Sets values. Doesn't update the Data array contents itself. Very handy to make the chart render fast when the data is being changed frequently, especially with IntensityGridSeries' PixelRendering mode enabled.

public bool SetValuesData(double[][] data, IntensityGridValuesDataOrder order)

Parameters

data double[][]

Data. The alignment must be M x N, all rows must be of equal length.

order IntensityGridValuesDataOrder

Jagged array order dimensions order. Is first array dimension columns and second dimension rows, or vice versa.

Returns

bool

Success status.

Remarks

If SetColors method is used too, the data array dimensions and order must be same than with SetValuesData.

SetValuesData(float[][], IntensityGridValuesDataOrder)

Sets values. Doesn't update the Data array contents itself. Very handy to make the chart render fast when the data is being changed frequently, especially with IntensityGridSeries' PixelRendering mode enabled.

public bool SetValuesData(float[][] data, IntensityGridValuesDataOrder order)

Parameters

data float[][]

Data. The alignment must be M x N, all rows must be of equal length.

order IntensityGridValuesDataOrder

Jagged array order dimensions order. Is first array dimension columns and second dimension rows, or vice versa.

Returns

bool

Success status.

Remarks

If SetColors method is used too, the data array dimensions and order must be same than with SetValuesData.

Events

TraceCellChanged

Tracing has been moved to over different intensity series cell.

public virtual event IntensitySeriesBase.TraceCellChangedHandler TraceCellChanged

Event Type

IntensitySeriesBase.TraceCellChangedHandler