Interface SurfaceGridSeries3DOptions

Interface for readonly configuration of SurfaceGridSeries3D.

Required properties:

  • columns: Amount of cells along X axis.
  • rows: Amount of cells along Z axis.

Optional properties:

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

  • dataOrder: Specifies interpretation order for Height and Intensity data.
  • start: Specifies location of first cell on X and Z axes.
  • step: Specifies step between cells on X and Z axes.
  • end: Specifies location of last cell on X and Z axes.

Example usage:

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

See also addSurfaceScrollingGridSeries.

Hierarchy

  • SurfaceGridSeries3DOptions

Properties

columns dataOrder? end? rows start? step?

Properties

columns

columns: number

Amount of cells along X axis.

Required!

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 dataOrder

dataOrder?: "columns" | "rows"

Specifies interpretation order for Height and Intensity data when using invalidateHeightMap or invalidateIntensityValues.

'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 end

end?: PointXZ

Specifies location of last cell on X and Z axes.

Optional.

end has priority over step.

rows

rows: number

Amount of cells along Z axis.

Required!

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 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 }, unless end is specified.

Settings

Member Visibility

Theme