Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SurfaceScrollingGridSeries3DOptions

Interface for readonly configuration of SurfaceScrollingGridSeries3D.

Required properties:

Optional properties:

All or any of these can be omitted or set to undefined, in which case a default value is used.

Example usage:

 // Example 1, create surface grid series with minimum configuration.
 const surfaceGrid = Chart3D.addSurfaceScrollingGridSeries({
     columns: 100,
     rows: 50,
 })

See also Chart3D.addSurfaceGridSeries.

Index

Properties

columns

columns : number

Amount of cells along X axis.

Required!

If SurfaceScrollingGridSeries3DOptions.scrollDimension is 'columns', then this will specify the amount of cells to keep before the oldest sample is shifted out.

Surface grid data amount is specified as columns * rows.

Larger data sets require more memory (RAM) to work. With nearly any setup, tens of millions data points can easily be reached and with good setups even billion (1 000 000 000) data points have been properly visualized.

rows

rows : number

Amount of cells along Z axis.

Required!

If SurfaceScrollingGridSeries3DOptions.scrollDimension is 'rows', then this will specify the amount of cells to keep before the oldest sample is shifted out.

Surface grid data amount is specified as columns * rows.

Larger data sets require more memory (RAM) to work. With nearly any setup, tens of millions data points can easily be reached and with good setups even billion (1 000 000 000) data points have been properly visualized.

Optional scrollDimension

scrollDimension : "columns" | "rows"

Select scrolling dimension, as well as how to interpret grid matrix values supplied by user.

If columns is selected, then there will be no limit on how many columns can be pushed to the series, but rows amount will be static.

If rows is selected, then there will be no limit on how many rows can be pushed to the series, but columns amount will be static.

Data order:

'columns' -> Supply lists of "columns"

 const intensityValues = [
     [
         0, // Intensity value column = 0, row = 0
         0, // Intensity value column = 0, row = 1
         0, // Intensity value column = 0, row = n
     ],
     [
         0, // Intensity value column = 1, row = 0
         0, // Intensity value column = 1, row = 1
         0, // Intensity value column = 1, row = n
     ],
 ]

'rows' -> Supply lists of "rows"

 const intensityValues = [
     [
         0, // Intensity value row = 0, column = 0
         0, // Intensity value row = 0, column = 1
         0, // Intensity value row = 0, column = n
     ],
     [
         0, // Intensity value row = 1, column = 0
         0, // Intensity value row = 1, column = 1
         0, // Intensity value row = 1, column = n
     ],
 ]

Optional, defaults to 'columns'.

Optional start

start : PointXZ

Specifies location of first cell on X and Z axes.

Optional, defaults to { x: 0, z: 0 }

Optional step

step : PointXZ

Specifies step between cells on X and Z axes.

Optional, defaults to { x: 1, y: 1 }.