Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RenderableSeriesSceneEntityState

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

State object for a 3D RenderableSeriesSceneEntity that contains a set of boolean flags and other state types (e.g. TAxisCubeState) that determine whether underlying graphics resources of the Scene Entity are up-to-date and reflect the current state of its properties and the date it visualizes.

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

  • new RenderableSeriesSceneEntityState(isInitialStateProperty?: boolean, isDataSeriesModifiedProperty?: boolean, isRenderableSeriesPropertyChangedProperty?: boolean, isAxisCubeStateChangedProperty?: boolean, axisCubeState?: TAxisCubeState): RenderableSeriesSceneEntityState

  • Parameters

    • Default value isInitialStateProperty: boolean = true
    • Default value isDataSeriesModifiedProperty: boolean = true
    • Default value isRenderableSeriesPropertyChangedProperty: boolean = true
    • Default value isAxisCubeStateChangedProperty: boolean = true
    • Default value axisCubeState: TAxisCubeState = {xVisibleMin: 0,xVisibleMax: 0,yVisibleMin: 0,yVisibleMax: 0,zVisibleMin: 0,zVisibleMax: 0,xWorldDimension: 0,yWorldDimension: 0,zWorldDimension: 0}

    Returns RenderableSeriesSceneEntityState

Accessors

isAxisCubeStateChanged

  • get isAxisCubeStateChanged(): boolean

  • Gets whether an Axis Cube state has been changed since last update.

    Returns boolean

isDataSeriesModified

  • get isDataSeriesModified(): boolean

  • Gets whether the Data Series has been modified since last update.

    Returns boolean

isInitialState

  • get isInitialState(): boolean

  • Gets whether the Scene Entity is in the initial state, meaning all the underlying resources must be (re-)created.

    Returns boolean

isRenderableSeriesPropertyChanged

  • get isRenderableSeriesPropertyChanged(): boolean

  • Gets whether a property of the Renderable Series has been changed since last update.

    Returns boolean

Methods

reset

  • Resets all the state changed flags and saves the current state of Rederable Series and state of other objects in the Render Pass (e.g. Axis Cube).

    Parameters

    Returns void

setInitialState

  • setInitialState(): void

  • Sets whether the Scene Entity is in the initial state, meaning all the underlying resources must be (re-)created.

    Returns void

setRenderableSeriesPropertyChanged

  • setRenderableSeriesPropertyChanged(): void

  • Sets whether a property of the Renderable Series has been changed.

    Returns void

validate

  • Checks if a state of the Renderable Series and a state of other objects in the Render Pass (e.g. Axis Cube) has been changed. Sets corresponding flags, if any.

    Parameters

    Returns boolean

Generated using TypeDoc