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

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

remarks

A RenderableSeries 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

Implemented by

Index

Properties

dataSeries

dataSeries: BaseDataSeries3D

The DataSeries which provides a datasource for this BaseRenderableSeries3D to draw

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

isVisible

isVisible: boolean

Gets or sets whether the BaseDataSeries3D is visible or not

opacity

opacity: number

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

paletteProvider

paletteProvider: IPaletteProvider3D

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

parentSurface

parentSurface: SciChart3DSurface

Used internally - Gets or sets the parent SciChart3DSurface

pointMarker

pointMarker: 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

Readonly sceneEntity

sceneEntity: IBaseSceneEntity

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

shininess

shininess: number

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

stroke

stroke: string

Gets or sets the stroke color as an HTML Color code

Readonly type

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

Methods

applyTheme

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

onAttach

onDetach

  • onDetach(): void

Protected 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

Generated using TypeDoc