Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IGridDataSeries3D

Go to JavaScript Charting Documentation
Go to JavaScript Chart Examples
Go to SciChart.js on Github

Interface to a BaseGridDataSeries3D

Hierarchy

Implemented by

Index

Properties

Methods

Properties

dataChanged

dataChanged: EventHandler<void>

An EventHandler which is raised when the data changes.

remarks

To subscribe to dataChanged, use the following code:

const dataSeries = new XyDataSeries(wasmContext);
const callback = () => {
   // Data has changed
};
dataSeries.dataChanged.subscribe(callback);

To unsubscribe from dataChanged, use the following code:

const dataSeries = new XyDataSeries(wasmContext);
dataSeries.dataChanged.unsubscribe(callback);

dataSeriesName

dataSeriesName: string

Gets the DataSeries name. This is used in legend controls and tooltips to identify the series

Readonly isModified

isModified: boolean

Determines whether the Data Series has been modified since last resetModified() call.

Readonly type

type: EDataSeriesType3D

Gets the EDataSeriesType3D type of the DataSeries

Readonly xRange

xRange: NumberRange

Gets the total extends of the DataSeries3D in the x-range

Readonly xSize

xSize: number

The xSize is the WIDTH or number of elements in each or of the 2-dimensional array, e.g. [[1, 2][3, 4][5, 6]] has a xSize of 2

Readonly yRange

yRange: NumberRange

Gets the total extends of the DataSeries3D in the y-range

Readonly zRange

zRange: NumberRange

Gets the total extends of the DataSeries3D in the z-range

Readonly zSize

zSize: number

The zSize is the HEIGHT or number of rows of the 2-dimensional array, e.g. [[1, 2][3, 4][5, 6]] has a height of 3

Methods

delete

  • delete(): void

  • Deletes native (WebAssembly) memory used by this type, after which it cannot be used.

    remarks

    Call .delete() before finishing with the object to ensure that WebAssmembly memory leaks do not occur.

    All elements within SciChart's High Performance Realtime JavaScript Charts which implement IDeletable must be deleted manually to free native (WebAssembly) memory

    Returns void

getYValue

  • getYValue(zIndex: number, xIndex: number): number

  • Gets the YValue at the specific Z,X index where Z must be within 0-zSize and X must be within 0-xSize

    Parameters

    • zIndex: number

      the z-index from 0 to zSize

    • xIndex: number

      the x-index from 0 to xSize

    Returns number

getYValues

  • getYValues(): number[][]

  • Gets the Y-Values array as a two dimensional array. Output is in the format YValues[z][x] where z is 0 to zSize and X is 0 to xSize.

    Returns number[][]

resetModified

  • resetModified(): void

  • Resets the modified flag.

    Returns void

setYValues

  • setYValues(YValues: number[][]): void

  • Sets a 2D array of YValues. Input is in the format YValues[z][x] where z is 0 to zSize and X is 0 to xSize Note that setting the YValues involves a clone. Once the array has been set you cannot manipulate the input array and expect changes on the chart.

    Parameters

    • YValues: number[][]

    Returns void

Generated using TypeDoc