SurfaceMeshSeries3D | LightningChart® JS API Documentation

Class for visualization of a 3D surface mesh inside a Chart3D.

The series behaves exactly like SurfaceGridSeries3D, a grid defined between two XZ locations, but on top of this, it allows the user to map each cell of the grid into any arbitrary XYZ location.

Supports colouring cells by a look up table (LUT) based on user set values as well as geometry Y coordinates.

SurfaceGridSeries3D are created with Chart3D.addSurfaceSeries.

Properties

Readonly theme

theme : Theme

Theme

Methods

attach

attach(entry: LegendBoxEntry, disposeOnClick: boolean): this

Attach object to an legendBox entry

Parameters
- entry: LegendBoxEntry
  
  Object which has to be attached
- disposeOnClick: boolean
  
  Flag that indicates whether the Attachable should be disposed/restored, when its respective Entry is clicked.
Returns this

Series itself for fluent interface

dispose

dispose(): this

Tell the owning chart to remove this component.

Returns this

Object itself.

getFillStyle

getFillStyle(): FillStyle

Get fill style of Intensity Heatmap Series.
- SolidFill: apply single solid color.
- IndividualPointFill: apply individual color per data-point.
  - lookUpProperty = 'value': Pick colors based on values set using addRow, addColumn or invalidateValuesOnly.
  - lookUpProperty = 'y': Pick colors based on geometry Y coordinates.
- emptyFill: no color, empty rendering.
Returns FillStyle

FillStyle.

getHighlightOnHover

getHighlightOnHover(): boolean

Get boolean flag for whether object should highlight on mouse hover

Returns boolean

Boolean for if object should highlight on mouse hover or not.

getHighlighted

getHighlighted(): boolean

Returns boolean

the state of highlighted flag

getIsUnderMouse

getIsUnderMouse(): boolean

Get boolean flag for whether object is currently under mouse or not

Returns boolean

Boolean for is object under mouse currently

getMouseInteractions

getMouseInteractions(): boolean

Get mouse interactions enabled or disabled. Disabled mouse-interactions will naturally prevent mouse-driven highlighting from ever happening.

Returns boolean

Mouse interactions state

getName

getName(): string

Get the name of the Component.

Returns string

The name of the Component.

getWireframeStyle

getWireframeStyle(): FillStyle

Get style of wireframe.

Wireframe is a line grid that highlights the edges of each cell of the 3D surface.

Returns FillStyle

FillStyle.

getXMax

getXMax(): number | undefined

Returns number | undefined

Max X value of the series

getXMin

getXMin(): number | undefined

Returns number | undefined

Min X value of the series

getYMax

getYMax(): number | undefined

Returns number | undefined

Max Y value of the series

getYMin

getYMin(): number | undefined

Returns number | undefined

Min Y value of the series

getZMax

getZMax(): number | undefined

Returns number | undefined

Max Z value of the series

getZMin

getZMin(): number | undefined

Returns number | undefined

Min Z value of the series

invalidateColorsOnly

invalidateColorsOnly(colors: Matrix<Color>, range?: GridRangeOptions): this
invalidateColorsOnly(callback: UpdateColorCallback, range?: GridRangeOptions): this

Treat the data of the matrix as ColorValue-based type of points. ColorValue-based data is represented in format { ...color: Color } for IndividualPointFill style.

Invalidates only the color without update the geometry data, providing significantly faster rendering of dynamically changed colors.

Parameters
- colors: Matrix<Color>
  
  Matrix of new colors. The resolution of the IntensityShape should be valid.
- range: GridRangeOptions
  
  Optional configuration object to specify the range of the grid to be invalidated.
Returns this

Series itself for fluent interface.
Treat the data of the matrix as ColorValue-based type of points. ColorValue-based date is represented in format { ...color: Color } for IndividualPointFill style.

Invalidates only the color without update the geometry data, providing significantly faster rendering of dynamically changed colors.

Example usage:
```
  // Fill each surface cell with a color for demonstration purposes.
  SurfaceSeries3D
      .invalidateColorsOnly( ( row, column ) => ColorHSV( row * column ) )
```
Parameters
- callback: UpdateColorCallback
  
  Callback function to map through the input to modify the matrix colors. The resolution of the IntensityShape should be valid.
- range: GridRangeOptions
  
  Optional configuration object to specify the range of the grid to be invalidated.
Returns this

Series itself for fluent interface.

invalidateGeometryOnly

invalidateGeometryOnly(vertices: Matrix<Point3D>, range?: GridRangeOptions): this
invalidateGeometryOnly(vertices: UpdateGeometryCallback<Point3D>, range?: GridRangeOptions): this

Treat the data of the matrix as any of the Point3D-based type of points. Point3D-based data is represented in format { x: number, y: number, z: number } to modify the geometry only.

Invalidates only the geometry coordinates without update the intensity or color data, providing significantly faster rendering of dynamically changed geometry.

Parameters
- vertices: Matrix<Point3D>
  
  Matrix of new vertices. The resolution of the IntensityMesh should be valid.
- range: GridRangeOptions
  
  Optional configuration object to specify the range of the grid to be invalidated.
Returns this

Series itself for fluent interface.
Treat the data of the matrix as any of the Point-based type of points. Point-based data is represented in format { x: number, y: number } to modify the geometry only.

Invalidates only the geometry coordinates without update the intensity or color data, providing significantly faster rendering of dynamically changed geometry.

Example usage:
```
 const resolution = 20
 SurfaceMeshSeries3D
     .invalidateGeometryOnly( ( row, column, prev ) => {
         const angle = 2 * Math.PI * row / ( resolution - 1 )
         const radius = 2 + Math.cos( column * .resolution )
         return {
             x: Math.cos( angle ) * radius,
             y: column,
             z: Math.sin( angle ) * radius
         }
     } )
```
Parameters
- vertices: UpdateGeometryCallback<Point3D>
- range: GridRangeOptions
  
  Optional configuration object to specify the range of the grid to be invalidated.
Returns this

Series itself for fluent interface.

invalidateValuesOnly

invalidateValuesOnly(values: Matrix<number>, range?: GridRangeOptions): this
invalidateValuesOnly(callback: UpdateValueCallback, range?: GridRangeOptions): this

Treat the data of the matrix as IntensityValue-based type of points. IntensityValue-based data is represented in format { ...intensity: number } for PalettedFill style.

Invalidates only the intensity values without update the geometry data, providing significantly faster rendering of dynamically changed intensity.

Parameters
- values: Matrix<number>
  
  Matrix of new intensity values.
- range: GridRangeOptions
  
  Optional configuration object to specify the range of the grid to be invalidated.
Returns this

Series itself for fluent interface.
Treat the data of the matrix as IntensityValue-based type of points. IntensityValue-based data is represented in format { ...intensity: number } for PalettedFill style.

Invalidates only the intensity values without update the geometry data, providing significantly faster rendering of dynamically changed intensity.

Example usage:
```
  // Fill each surface cell with a value for demonstration purposes.
  SurfaceSeries3D
      .invalidateValuesOnly( ( row, column ) => row + column )
```
Parameters
- callback: UpdateValueCallback
  
  Callback function to map through the input to modify the matrix of intensity values. The resolution of the IntensityShape should be valid.
- range: GridRangeOptions
  
  Optional configuration object to specify the range of the grid to be invalidated.
Returns this

Series itself for fluent interface.

isDisposed

isDisposed(): boolean

Returns boolean

TODO: True for enabled and false for disabled

offHighlight

offHighlight(token: Token): boolean

Unsubscribe from Highlight object event. This is called whenever an object is highlighted

Parameters
- token: Token
  
  Token that was received when subscribing to the event.
Returns boolean

True if the unsubscription was successful.

offMouseClick

offMouseClick(token: Token): boolean

Remove event listener from Mouse Click Event

Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

True if the listener is successfully removed and false if it is not found

offMouseDoubleClick

offMouseDoubleClick(token: Token): boolean

Remove event listener from Mouse Double Click Event

Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

True if the listener is successfully removed and false if it is not found

offMouseDown

offMouseDown(token: Token): boolean

Remove event listener from Mouse Down Event

Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

True if the listener is successfully removed and false if it is not found

offMouseDrag

offMouseDrag(token: Token): boolean

Remove event listener from Mouse Drag Event

Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

True if the listener is successfully removed and false if it is not found

offMouseDragStart

offMouseDragStart(token: Token): boolean

Remove event listener from Mouse Drag Start Event

Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

True if the listener is successfully removed and false if it is not found

offMouseDragStop

offMouseDragStop(token: Token): boolean

Remove event listener from Mouse Drag Stop Event

Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

True if the listener is successfully removed and false if it is not found

offMouseEnter

offMouseEnter(token: Token): boolean

Remove event listener from Mouse Enter Event

Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

True if the listener is successfully removed and false if it is not found

offMouseLeave

offMouseLeave(token: Token): boolean

Remove event listener from Mouse Leave Event

Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

True if the listener is successfully removed and false if it is not found

offMouseMove

offMouseMove(token: Token): boolean

Remove event listener from Mouse Move Event

Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

True if the listener is successfully removed and false if it is not found

offMouseUp

offMouseUp(token: Token): boolean

Remove event listener from Mouse Up Event

Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

True if the listener is successfully removed and false if it is not found

offMouseWheel

offMouseWheel(token: Token): boolean

Remove event listener from Mouse Wheel Event

Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

True if the listener is successfully removed and false if it is not found

offTouchEnd

offTouchEnd(token: Token): boolean

Remove event listener from Touch End Event

Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

True if the listener is successfully removed and false if it is not found

offTouchMove

offTouchMove(token: Token): boolean

Remove event listener from Touch Move Event

Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

True if the listener is successfully removed and false if it is not found

offTouchStart

offTouchStart(token: Token): boolean

Remove event listener from Touch Start Event

Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

True if the listener is successfully removed and false if it is not found

onHighlight

onHighlight(handler: function): Token

Subscribe to highlight object event. This is called whenever an object is highlighted.

Parameters
- handler: function
  
  Function that is called when event is triggered.
  - - Parameters
      - isHighlighted: boolean
      Returns void
Returns Token

Token that can be used to unsubscribe from the event.

onMouseClick

onMouseClick(clbk: MouseEventHandler<this>): Token

Add event listener to Mouse Click Event

Parameters
- clbk: MouseEventHandler<this>
  
  Event listener for Mouse Click Event
Returns Token

Token of the event listener

onMouseDoubleClick

onMouseDoubleClick(clbk: MouseEventHandler<this>): Token

Add event listener to Mouse Double Click Event

Parameters
- clbk: MouseEventHandler<this>
  
  Event listener for Mouse Double Click Event
Returns Token

Token of the event listener

onMouseDown

onMouseDown(clbk: MouseEventHandler<this>): Token

Add event listener to Mouse Down Event

Parameters
- clbk: MouseEventHandler<this>
  
  Event listener for Mouse Down Event
Returns Token

Token of the event listener

onMouseDrag

onMouseDrag(clbk: MouseDragEventHandler<this>): Token

Subscribe to Mouse Drag event

Parameters
- clbk: MouseDragEventHandler<this>
Returns Token

onMouseDragStart

onMouseDragStart(clbk: MouseDragStartEventHandler<this>): Token

Subscribe to Mouse Drag Start event

Parameters
- clbk: MouseDragStartEventHandler<this>
Returns Token

onMouseDragStop

onMouseDragStop(clbk: MouseDragStopEventHandler<this>): Token

Subscribe to Mouse Drag Stop event

Parameters
- clbk: MouseDragStopEventHandler<this>
Returns Token

onMouseEnter

onMouseEnter(clbk: MouseEventHandler<this>): Token

Add event listener to Enter Event

Parameters
- clbk: MouseEventHandler<this>
  
  Event listener for Mouse Enter Event
Returns Token

Token of the event listener

onMouseLeave

onMouseLeave(clbk: AbruptMouseEventHandler<this>): Token

Add event listener to Mouse Leave Event

Parameters
- clbk: AbruptMouseEventHandler<this>
  
  Event listener for Mouse Leave Event
Returns Token

Token of the event listener

onMouseMove

onMouseMove(clbk: MouseEventHandler<this>): Token

Add event listener to Mouse Move Event

Parameters
- clbk: MouseEventHandler<this>
  
  Event listener for Mouse Move Event
Returns Token

Token of the event listener

onMouseUp

onMouseUp(clbk: MouseEventHandler<this>): Token

Add event listener to Mouse Up Event

Parameters
- clbk: MouseEventHandler<this>
  
  Event listener for Mouse Up Event
Returns Token

Token of the event listener

onMouseWheel

onMouseWheel(clbk: MouseWheelEventHandler<this>): Token

Subscribe to Mouse Wheel event

Parameters
- clbk: MouseWheelEventHandler<this>
  
  Event handler function
Returns Token

Token of subscription

onTouchEnd

onTouchEnd(clbk: TouchEventHandler<this>): Token

Subscribe to Touch End event

Parameters
- clbk: TouchEventHandler<this>
  
  Event handler function
Returns Token

Token of subscription

onTouchMove

onTouchMove(clbk: TouchEventHandler<this>): Token

Subscribe to Touch Move event

Parameters
- clbk: TouchEventHandler<this>
  
  Event handler function
Returns Token

Token of subscription

onTouchStart

onTouchStart(clbk: TouchEventHandler<this>): Token

Subscribe to Touch Start event

Parameters
- clbk: TouchEventHandler<this>
  
  Event handler function
Returns Token

Token of subscription

reset

reset(options: SurfaceOptions3D): this

Reset the existing intensity shape and apply new settings. The following method removes all the existing data. The shape would be reset to the default state:
- Old Geometry transformations do not valid. The Intensity is a uniform grid.
- Old IntensityValues and/or ColorValues do not valid and exist anymore.
Parameters
- options: SurfaceOptions3D
  
  Major mandotary properties of Intensity.
Returns this

Series itself for fluent interface.

restore

restore(): this

Tell the owning chart to restore this component.

Returns this

Object itself.

setFillStyle

setFillStyle(fillstyle: FillStyle | ImmutableMutator<FillStyle>): this

Set fill style of Intensity Heatmap Series.
- SolidFill: apply single solid color.
- IndividualPointFill: apply individual color per data-point.
- PalettedFill: apply palette using LUT lookup table of colors.
  - lookUpProperty = 'value': Pick colors based on values set using addRow, addColumn or invalidateValuesOnly.
  - lookUpProperty = 'y': Pick colors based on geometry Y coordinates.
- emptyFill: no color, empty rendering.
Parameters
- fillstyle: FillStyle | ImmutableMutator<FillStyle>
  
  Either a FillStyle object or a function, which will be used to create a new FillStyle based on current value.
Returns this

Series itself for fluent interface.

setHighlightOnHover

setHighlightOnHover(state: boolean): this

Set highlight on mouse hover enabled or disabled

Parameters
- state: boolean
  
  True if highlighting on mouse hover, false if no highlight on mouse hover
Returns this

Object itself for fluent interface.

setHighlighted

setHighlighted(highLight: boolean): this

Enable or disable forced highlighting of component

Parameters
- highLight: boolean
  
  True for enabled and false for disabled
Returns this

component itself for fluent interface

setMouseInteractions

setMouseInteractions(state: boolean): this

Set mouse interactions enabled or disabled. Disabling mouse-interactions will naturally prevent mouse-driven highlighting from ever happening.

Parameters
- state: boolean
  
  Specifies state of mouse interactions
Returns this

Object itself for fluent interface

setName

setName(name: string): this

Sets the name of the Component updating attached LegendBox entries

Parameters
- name: string
  
  Name of the Component
Returns this

Object itself

setWireframeStyle

setWireframeStyle(value: FillStyle | ImmutableMutator<FillStyle>): this

Set style of wireframe.

Wireframe is a line grid that highlights the edges of each cell of the 3D surface.

By default, the wireframe is hidden. It can be displayed like so:
```
 surfaceSeries.setWireframeStyle( new SolidFill({ color: ColorRGBA( 0, 0, 0, 100 ) }) )
```
Parameters
- value: FillStyle | ImmutableMutator<FillStyle>
  
  Either a FillStyle object or a function, which will be used to create a new FillStyle based on current value.
Returns this

Series itself for fluent interface.

Index

Properties

Methods

Properties

Readonly theme

Methods

attach

Parameters

entry: LegendBoxEntry

disposeOnClick: boolean

Returns this

dispose

Returns this

getFillStyle

Returns FillStyle

getHighlightOnHover

Returns boolean

getHighlighted

Returns boolean

getIsUnderMouse

Returns boolean

getMouseInteractions

Returns boolean

getName

Returns string

getWireframeStyle

Returns FillStyle

getXMax

Returns number | undefined

getXMin

Returns number | undefined

getYMax

Returns number | undefined

getYMin

Returns number | undefined

getZMax

Returns number | undefined

getZMin

Returns number | undefined

invalidateColorsOnly

Parameters

colors: Matrix<Color>

range: GridRangeOptions

Returns this

Parameters

callback: UpdateColorCallback

range: GridRangeOptions

Returns this

invalidateGeometryOnly

Parameters

vertices: Matrix<Point3D>

range: GridRangeOptions

Returns this

Parameters

vertices: UpdateGeometryCallback<Point3D>

range: GridRangeOptions

Returns this

invalidateValuesOnly

Parameters

values: Matrix<number>

range: GridRangeOptions

Returns this

Parameters

callback: UpdateValueCallback

range: GridRangeOptions

Returns this

isDisposed

Returns boolean

offHighlight

Parameters

token: Token

Returns boolean

offMouseClick

Parameters

token: Token

Returns boolean

offMouseDoubleClick

Parameters

token: Token

Returns boolean