Options
All
  • Public
  • Public/Protected
  • All
Menu

Defines a 3D scatter-series or 3D Bubble chart type in the SciChart's High Performance Real-time JavaScript 3D Charts

remarks

To add a 3D scatter series to a SciChart3DSurface you need to declare both the ScatterRenderableSeries3D and a XyzDataSeries3D. Simplified code sample below:

const sciChart3DSurface: SciChart3DSurface;
const wasmContext: TSciChart3D;
// Create and fill the dataseries
const dataSeries = new XyzDataSeries3D(wasmContext);
dataSeries.append(1,2,3);
dataSeries.append(3,4,5);
// Create the renderableSeries
const scatterSeries = new ScatterRenderableSeries3D(wasmContext);
scatterSeries.dataSeries = dataSeries;
scatterSeries.pointMarker = new SpherePointMarker3D(wasmContext, {
    size: 3,
    fill: "#FF0000"
});
// append to the SciChartSurface
sciChart3DSurface.renderableSeries.add(scatterSeries);

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly id

id: string

A unique Id for the IRenderableSeries3D

invalidateParentCallback

invalidateParentCallback: () => void

A callback function which notifies the parent SciChart3DSurface that data or properties have changed and the 3D Scene needs redrawing

Type declaration

    • (): void
    • Returns void

Protected pointMarkerProperty

pointMarkerProperty: BasePointMarker3D

Readonly type

type: ESeriesType3D = ESeriesType3D.ScatterRenderableSeries3D

Gets the Series type. See ESeriesType3D for a list of values

Protected Readonly webAssemblyContext

webAssemblyContext: TSciChart3D

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

Accessors

dataSeries

isVisible

  • get isVisible(): boolean
  • set isVisible(isVisible: boolean): void

opacity

  • get opacity(): number
  • set opacity(opacity: number): void
  • Gets or sets an optional Opacity from 0.0 (fully transparent) - 1.0 (fully opaque)

    inheritdoc

    Returns number

  • Gets or sets an optional Opacity from 0.0 (fully transparent) - 1.0 (fully opaque)

    inheritdoc

    Parameters

    • opacity: number

    Returns void

paletteProvider

parentSurface

pointMarker

sceneEntity

shininess

  • get shininess(): number
  • set shininess(shininess: number): void
  • Gets or sets an optional Shininess factor, passed to 3D rendering shaders to make shiny objects

    inheritdoc

    Returns number

  • Gets or sets an optional Shininess factor, passed to 3D rendering shaders to make shiny objects

    inheritdoc

    Parameters

    • shininess: number

    Returns void

stroke

  • get stroke(): string
  • set stroke(stroke: string): void
  • Gets or sets the stroke color as an HTML Color code

    inheritdoc

    Returns string

  • Gets or sets the stroke color as an HTML Color code

    inheritdoc

    Parameters

    • stroke: string

    Returns void

Methods

applyTheme

Protected attachPointMarker

Protected dataSeriesDataChanged

  • dataSeriesDataChanged(): void
  • Is being called when the data for the underlying DataSeries changes

    Returns void

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

Protected detachPointMarker

Protected enrichHitTest

hitTest

  • Performs a HitTest operation on the series, returning the SeriesInfo3D containing the enriched Hit-Test result. This contains information about the hit-test operation such as the values of the data under the mouse and location of the data under the mouse in 3D world coordinates. This may be used for tooltips, selection or inspection of the 3d scene through mouse-clicks

    Parameters

    • screenPoint: Point

      The screen point (X,Y pixel coordinate in 2D space)

    Returns SeriesInfo3D

Protected notifyPropertyChanged

  • notifyPropertyChanged(propertyName: string): void

onAttach

onDetach

  • onDetach(): void

onDpiChanged

Protected setSceneEntity

Generated using TypeDoc