Options
All
  • Public
  • Public/Protected
  • All
Menu

The base class for DataSeries in SciChart's JavaScript 3D Charts

remarks

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

constructor

  • Creates an instance of the BaseDataSeries3D

    Parameters

    • webAssemblyContext: TSciChart3D

      the {@link TSciChart3D | SciChart WebAssembly Context} containing native methods and access to our underlying WebGL2 rendering engine

    • Optional options: IBaseDataSeries3DOptions

      optional parameters of type IBaseDataSeries3DOptions to configure the series

    Returns BaseDataSeries3D

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

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 DataSeries3D in the x-range

    inheritdoc

    Returns NumberRange

yRange

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

    inheritdoc

    Returns NumberRange

zRange

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

    inheritdoc

    Returns NumberRange

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

notifyDataChanged

  • notifyDataChanged(): void
  • Call this method to notify subscribers of dataChanged that the data has changed and 3D JavaScript Chart needs redrawing

    Returns void

resetModified

  • resetModified(): void
  • Resets the modified flag.

    Returns void

Generated using TypeDoc