Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SeriesInfo3D

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

SeriesInfo3D is a data-structure which provides enriched information about a hit-test operation in SciChart 3D. It's derived by calling BaseRenderableSeries3D.hitTest. There is a class hierachy for SeriesInfo3D which is a different class depending on series type, e.g. 3D Scatter series has XyzSeriesInfo3D, 3D Surface mesh series has SurfaceMeshSeriesInfo3D etc.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

dataSeriesName

dataSeriesName: string

The name of the associated DataSeries

dataSeriesType

dataSeriesType: EDataSeriesType3D

Data series type

Protected hitTestInfo

hitTestInfo: HitTestInfo3D

hitWorldCoords

hitWorldCoords: Vector3

When isHit is true, this is the Vector3 3D World Coordinates of the data-point that was hit

isEmpty

isEmpty: boolean = false

When true, the SeriesInfo3D is empty

isHit

isHit: boolean

When true, the result of the hit-test operation is hit (mouse over data-point)

renderableSeries

renderableSeries: IRenderableSeries3D

The associated RenderableSeries

xValue

xValue: number

When isHit is true, this is the X-value of the data-point in the XyzDataSeries3D that was hit

yValue

yValue: number

When isHit is true, this is the Y-value of the data-point in the XyzDataSeries3D that was hit

zValue

zValue: number

When isHit is true, this is the Z-value of the data-point in the XyzDataSeries3D that was hit

Methods

equals

  • Parameters

    Returns boolean

Static empty

  • The default empty HitTestInfo3D instance

    Returns SeriesInfo3D

Static isEqual

  • Parameters

    Returns boolean

Generated using TypeDoc