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

Defines the base class to a 3D Render Series (or 3D Chart Type) in SciChart's High Performance Real-time JavaScript 3D Charts

remarks

A BaseRenderableSeries3D defines how data should be rendered. e.g. as a 3D Scatter Chart, 3D Point Line Chart etc... This is independent from the DataSeries3D which stores the data to render

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

Protected 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

Abstract type

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
  • Gets or sets whether the BaseDataSeries3D is visible or not

    inheritdoc

    Returns boolean

  • Gets or sets whether the BaseDataSeries3D is visible or not

    inheritdoc

    Parameters

    • isVisible: boolean

    Returns 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

  • Gets or sets an optional IPaletteProvider3D - a PaletteProvider class which allows for per-point data-point coloring on some 3D BaseRenderableSeries3D types.

    inheritdoc

    Returns IPaletteProvider3D

  • Gets or sets an optional IPaletteProvider3D - a PaletteProvider class which allows for per-point data-point coloring on some 3D BaseRenderableSeries3D types.

    inheritdoc

    Parameters

    Returns void

parentSurface

  • Used internally - Gets or sets the parent SciChart3DSurface

    inheritdoc

    Returns SciChart3DSurface

  • Used internally - Gets or sets the parent SciChart3DSurface

    inheritdoc

    Parameters

    Returns void

pointMarker

  • A 3D Point Marker which is used to draw an optional 3D point-marker at each Xyz data-point. Applicable to some series types only

    inheritdoc

    Returns BasePointMarker3D

  • A 3D Point Marker which is used to draw an optional 3D point-marker at each Xyz data-point. Applicable to some series types only

    inheritdoc

    Parameters

    Returns void

sceneEntity

  • Used internally - Gets the 3D Scene Entity which renders the geometry in the 3D Scene

    inheritdoc

    Returns IBaseSceneEntity

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 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 enrichHitTest

  • Parameters

    Returns SeriesInfo3D

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
  • Notifies listeners to invalidateParentCallback that a property has changed

    Parameters

    • propertyName: string

    Returns void

onAttach

onDetach

  • onDetach(): void

onDpiChanged

  • Called when the Dpi changes in the browser. This could be due to user zooming the browser, or changing DPI settings in Windows, or moving the browser containing SciChart to another monitor

    Parameters

    Returns void

Protected setSceneEntity

Generated using TypeDoc