Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UniformGridDataSeries3D

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

The UniformGridDataSeries3D wraps a 2D array of numbers which become the Y-values (heights) in various BaseRenderableSeries3D in SciChart's High Performance JavaScript 3D Charts.

description

The SurfaceMeshRenderableSeries3D requires a 2D array of numbers to map to Y-values (heights).

The xStart, xStep properties define the extents of the data in the X-direction, and yStart, yStep define the extents of the data in the Y-direction.

Y-values may be updated via manipulating the array returned by getYValues, or by setting a new array to setYValues. When manpulating data directly, be sure to call notifyDataChanged to inform SciChart to redraw.

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

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

type

type: EDataSeriesType3D = EDataSeriesType3D.UniformGrid3D

Protected webAssemblyContext

webAssemblyContext: TSciChart3D

The 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

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

xStart

  • get xStart(): number
  • set xStart(xStart: number): void

  • xStart defines the Start point on the XAxis where this grid or mesh will be drawn

    Returns number

  • xStart defines the Start point on the XAxis where this grid or mesh will be drawn

    Parameters

    • xStart: number

    Returns void

xStep

  • get xStep(): number
  • set xStep(xStep: number): void

  • xStep defines Step on the XAxis for each cell in the grid or mesh

    Returns number

  • xStep defines Step on the XAxis for each cell in the grid or mesh

    Parameters

    • xStep: number

    Returns void

yRange

zRange

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

zStart

  • get zStart(): number
  • set zStart(zStart: number): void

  • zStart defines the Start point on the ZAxis where this grid or mesh will be drawn

    Returns number

  • zStart defines the Start point on the ZAxis where this grid or mesh will be drawn

    Parameters

    • zStart: number

    Returns void

zStep

  • get zStep(): number
  • set zStep(zStep: number): void

  • zStep defines Step on the ZAxis for each cell in the grid or mesh

    Returns number

  • zStep defines Step on the ZAxis for each cell in the grid or mesh

    Parameters

    • zStep: number

    Returns void

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

getMetadataAt

  • getMetadataAt(zIndex: number, xIndex: number): any

  • Gets the metadata by Z and X indexes

    Parameters

    • zIndex: number

      The Z index

    • xIndex: number

      The X index

    Returns any

getMetadataHeight

  • getMetadataHeight(): number

getMetadataValues

  • getMetadataValues(): any[][]

  • Gets a js array of {@link any | Metadata values} in the DataSeries

    Returns any[][]

getMetadataWidth

  • getMetadataWidth(): number

Protected getOptions

getX

  • getX(xIndex: number): number
  • inheritdoc

    Parameters

    • xIndex: number

    Returns number

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

getZ

  • getZ(zIndex: number): number
  • inheritdoc

    Parameters

    • zIndex: number

    Returns number

notifyDataChanged

  • notifyDataChanged(): void

resetModified

  • resetModified(): void

Protected setMetadata

  • setMetadata(metadata: any[][]): void

  • Parameters

    • metadata: any[][]

    Returns void

Protected setMetadataAt

  • setMetadataAt(zIndex: number, xIndex: number, metadata: any): void

  • Parameters

    • zIndex: number
    • xIndex: number
    • metadata: any

    Returns void

setYValue

  • setYValue(zIndex: number, xIndex: number, yValue: number, metadata?: any): 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

    • zIndex: number

      the z-index from 0 to zSize

    • xIndex: number

      the x-index from 0 to xSize

    • yValue: number
    • Optional metadata: any

      optional metadata for the data point. The full metadata array must already exist

    Returns void

setYValues

  • setYValues(YValues: NumberArray[], metadata?: any[][]): 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 Direct changes to this array will not be noticed by the chart. Use setYValue or call notifyDataChanged() after an update

    Parameters

    Returns void

toJSON

Protected validateIndexes

  • validateIndexes(zIndex: number, xIndex: number): void

Generated using TypeDoc