Options
All
  • Public
  • Public/Protected
  • All
Menu

Class XyzDataSeries3D

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

XyzDataSeries3D is a DataSeries for holding X, Y, Z data in SciChart's JavaScript 3D Charts

remarks

The XyzDataSeries3D is primarily used with our JavaScript Scatter & Bubble Chart, which draws a variable-sized bubble or shape at each X,Y,Z value

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

See derived types of BaseDataSeries3D to find out what data-series are available. See derived types of IRenderableSeries3D to find out what 3D JavaScript Chart types are available.

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

Protected metadata

metadata: IPointMetadata3D[]

Readonly type

type: EDataSeriesType3D = EDataSeriesType3D.Xyz3D

Protected webAssemblyContext

webAssemblyContext: TSciChart3D

The SciChart WebAssembly Context containing native methods and access to our WebGL2 Engine

Protected xValues

xValues: SCRTDoubleVector

Protected yValues

yValues: SCRTDoubleVector

Protected zValues

zValues: SCRTDoubleVector

Accessors

capacity

  • get capacity(): number
  • set capacity(value: number): void

  • Gets or sets the capacity of data-points in the DataSeries

    Returns number

  • Gets or sets the capacity of data-points in the DataSeries

    Parameters

    • value: number

    Returns void

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

yRange

zRange

Methods

append

  • Appends a single X, Y, Z point to the XyzDataSeries3D

    remarks

    For best performance on drawing large datasets, use the appendRange method

    Any changes of the DataSeries will trigger a redraw on the parent SciChart3DSurface

    Parameters

    Returns void

appendRange

clear

  • clear(): void

  • Clears the entire DataSeries.

    remarks

    Note this does not free memory, WebAssembly/Native memory is released by calling delete, after which the DataSeries is no longer usable.

    Any changes of the DataSeries will trigger a redraw on the parent SciChart3DSurface

    Returns void

count

  • count(): number

  • Gets the count of data-points in the DataSeries

    Returns number

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

getMetadataValues

getNativeXValues

  • getNativeXValues(): SCRTDoubleVector

  • Gets a native / WebAssembly vector of X-values in the DataSeries

    Returns SCRTDoubleVector

getNativeYValues

  • getNativeYValues(): SCRTDoubleVector

  • Gets a native / WebAssembly vector of Y-values in the DataSeries

    Returns SCRTDoubleVector

getNativeZValues

  • getNativeZValues(): SCRTDoubleVector

  • Gets a native / WebAssembly vector of Z-values in the DataSeries

    Returns SCRTDoubleVector

Protected getOptions

insert

  • insert(startIndex: number, x: number, y: number, z: number, metadata?: IPointMetadata3D): void

  • Inserts a single X,Y,Z value at the start index

    remarks

    For best performance on drawing large datasets, use the insertRange method

    Any changes of the DataSeries will trigger a redraw on the parent SciChart3DSurface

    Parameters

    • startIndex: number

      the index to insert at

    • x: number

      the Xvalue

    • y: number

      the YValue

    • z: number

      the ZValue

    • Optional metadata: IPointMetadata3D

      Optional metadata value

    Returns void

insertRange

  • Inserts a range of X,Y,Z values at the startIndex

    remarks

    Any changes of the DataSeries will trigger a redraw on the parent SciChart3DSurface

    Parameters

    Returns void

notifyDataChanged

  • notifyDataChanged(): void

removeAt

  • removeAt(index: number): void

  • Removes a single X,Y,Z value at the specified index

    remarks

    Any changes of the DataSeries will trigger a redraw on the parent SciChart3DSurface

    Parameters

    • index: number

      the index to remove at

    Returns void

removeRange

  • removeRange(startIndex: number, count: number): void

  • Removes a range of X,Y,Z values at the specified index

    remarks

    Any changes of the DataSeries will trigger a redraw on the parent SciChart3DSurface

    Parameters

    • startIndex: number

      the start index to remove at

    • count: number

      the number of points to remove

    Returns void

reserve

  • reserve(size: number): void

  • Reserves memory for the specified number of data-points

    Parameters

    • size: number

      The number of data-points to reserve memory for

    Returns void

resetModified

  • resetModified(): void

setMetadata

  • Sets metadata for all points without changing X, Y, Z values

    remarks

    Any changes of the DataSeries will trigger a redraw on the parent SciChart3DSurface

    Parameters

    • metadatas: IPointMetadata3D[]

      The array of new metadata values. Must have the same length as the current data series

    Returns void

setMetadataAt

  • Sets metadata for a single point at the specified index without changing X, Y, Z values

    remarks

    Any changes of the DataSeries will trigger a redraw on the parent SciChart3DSurface

    Parameters

    • index: number

      The index of the point to update

    • metadata: IPointMetadata3D

      The new metadata value

    Returns void

toJSON

update

  • update(index: number, x: number, y: number, z: number, metadata?: IPointMetadata3D): void

  • Updates a single X, Y, Z-value by index

    remarks

    Any changes of the DataSeries will trigger a redraw on the parent SciChart3DSurface

    Parameters

    • index: number

      the index to update

    • x: number

      The new X value

    • y: number

      The new Y value

    • z: number

      The new Z value

    • Optional metadata: IPointMetadata3D

    Returns void

Generated using TypeDoc