Options
All
  • Public
  • Public/Protected
  • All
Menu
summary

The base class for a Grid (two-dimensional array) DataSeries in SciChart's JavaScript 3D Charts

description

A DataSeries stores the data to render. This is independent from the RenderableSeries which defines how that data should be rendered.

The Grid DataSeries type is used for 3D Charts that have a uniform grid of values, for example SurfaceMeshRenderableSeries3D, which draws a 3D surface-plot or mesh chart with contours.

remarks

See derived type UniformGridDataSeries3D for a concrete implementation

Hierarchy

Implements

Index

Constructors

Protected constructor

Properties

Readonly 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);

Readonly Abstract type

Gets the EDataSeriesType3D type of the DataSeries

Protected webAssemblyContext

webAssemblyContext: TSciChart3D

The {@link TSciChart3D | SciChart WebAssembly Context} containing native methods and access to our WebGL2 Engine

Protected yRangeCached

yRangeCached: NumberRange

Accessors

dataSeriesName

  • get dataSeriesName(): string
  • set dataSeriesName(dataSeriesName: string): void
  • Gets the DataSeries name. This is used in legend controls and tooltips to identify the series

    inheritdoc

    Returns string

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

    inheritdoc

    Parameters

    • dataSeriesName: string

    Returns void

isModified

  • get isModified(): boolean
  • Determines whether the Data Series has been modified since last resetModified() call.

    Returns boolean

xRange

  • Gets the total extends of the GridDataSeries3D in the x-range

    Returns NumberRange

xSize

  • get 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

    Returns number

yRange

  • Gets the total extends of the GridDataSeries3D in the y-range

    Returns NumberRange

zRange

  • Gets the total extends of the GridDataSeries3D in the z-range

    Returns NumberRange

zSize

  • get 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

    Returns number

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

getIsDeleted

  • getIsDeleted(): boolean
  • Returns true if this DataSeries has been deleted and native memory destroyed

    Returns boolean

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[][]

notifyDataChanged

  • notifyDataChanged(): void

resetModified

  • resetModified(): void

setYValue

  • setYValue(yIndex: number, xIndex: number, zValue: number): void
  • Sets the YValue at the specific Z,X index where Z must be within 0-zSize and X must be within 0-xSize

    Parameters

    • yIndex: number
    • xIndex: number

      the x-index from 0 to xSize

    • zValue: number

    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