Creates an instance of a SurfaceMeshRenderableSeries3D
The SciChart 3D WebAssembly Context containing native methods and access to our WebGL2 Engine and WebAssembly numerical methods
A unique Id for the IRenderableSeries3D
A callback function which notifies the parent SciChart3DSurface that data or properties have changed and the 3D Scene needs redrawing
The SciChart 3D WebAssembly Context containing native methods and access to our WebGL2 WebAssembly Drawing Engine
Gets or sets the cell hardness factor, a number used to calculate lighting effects.
Gets or sets the cell hardness factor, a number used to calculate lighting effects.
Gets or sets the contour interval, a value for the spacing between contour lines.
Gets or sets the contour interval, a value for the spacing between contour lines.
Gets or sets the contour offset, a value for the offsetting contour lines
Gets or sets the contour offset, a value for the offsetting contour lines
Gets or sets the contour stroke as an HTML Color Code
Gets or sets the contour stroke as an HTML Color Code
Gets or sets the stroke thickness of contour lines on the SurfaceMeshRenderableSeries3D
Gets or sets the stroke thickness of contour lines on the SurfaceMeshRenderableSeries3D
The DataSeries which provides a datasource for this BaseRenderableSeries3D to draw
The DataSeries which provides a datasource for this BaseRenderableSeries3D to draw
Gets or sets the EDrawMeshAs, whether the mesh is drawn as wireframe, solid, with or without contours etc...
Gets or sets the EDrawMeshAs, whether the mesh is drawn as wireframe, solid, with or without contours etc...
When true, draws a skirt from the edge of the mesh to zero (solid walls on the left, right, top, bottom side)
When true, draws a skirt from the edge of the mesh to zero (solid walls on the left, right, top, bottom side)
Gets or sets the height scale factor for the SurfaceMeshRenderableSeries3D.
Gets or sets the height scale factor for the SurfaceMeshRenderableSeries3D.
Gets or sets the highlight factor, a number used to calculate lighting effects.
Gets or sets the highlight factor, a number used to calculate lighting effects.
Gets or sets whether the BaseDataSeries3D is visible or not
Gets or sets whether the BaseDataSeries3D is visible or not
Gets or sets the lighting factor, a number used to calculate lighting effects.
Gets or sets the lighting factor, a number used to calculate lighting effects.
Gets or sets the maximum value in the SurfaceMeshRenderableSeries3D.dataSeries that we want to map to colours in the SurfaceMeshRenderableSeries3D.meshColorPalette
Gets or sets the maximum value in the SurfaceMeshRenderableSeries3D.dataSeries that we want to map to colours in the SurfaceMeshRenderableSeries3D.meshColorPalette
Gets or sets the MeshColorPalette, which defines how values in the SurfaceMeshRenderableSeries3D.dataSeries map to colours
Gets or sets the MeshColorPalette, which defines how values in the SurfaceMeshRenderableSeries3D.dataSeries map to colours
Gets or sets the EMeshPaletteMode, which defines how heightmaps are treated.
Gets or sets the EMeshPaletteMode, which defines how heightmaps are treated.
Gets or sets the EMeshResolution, the amount of oversampling when creating a mesh.
Gets or sets the EMeshResolution, the amount of oversampling when creating a mesh.
Gets or sets the minimum value in the SurfaceMeshRenderableSeries3D.dataSeries that we want to map to colours in the SurfaceMeshRenderableSeries3D.meshColorPalette
Gets or sets the minimum value in the SurfaceMeshRenderableSeries3D.dataSeries that we want to map to colours in the SurfaceMeshRenderableSeries3D.meshColorPalette
Gets or sets an optional Opacity from 0.0 (fully transparent) - 1.0 (fully opaque)
Gets or sets an optional Opacity from 0.0 (fully transparent) - 1.0 (fully opaque)
Gets or sets an optional IPaletteProvider3D - a PaletteProvider class which allows for per-point data-point coloring on some 3D BaseRenderableSeries3D types.
Gets or sets an optional IPaletteProvider3D - a PaletteProvider class which allows for per-point data-point coloring on some 3D BaseRenderableSeries3D types.
Used internally - Gets or sets the parent SciChart3DSurface
Used internally - Gets or sets the parent SciChart3DSurface
A 3D Point Marker which is used to draw an optional 3D point-marker at each Xyz data-point. Applicable to some series types only
A 3D Point Marker which is used to draw an optional 3D point-marker at each Xyz data-point. Applicable to some series types only
Used internally - Gets the 3D Scene Entity which renders the geometry in the 3D Scene
Gets or sets an optional Shininess factor, passed to 3D rendering shaders to make shiny objects
Gets or sets an optional Shininess factor, passed to 3D rendering shaders to make shiny objects
Gets or sets the stroke color as an HTML Color code
Gets or sets the stroke color as an HTML Color code
Gets or sets the stroke thickness of mesh wireframe lines on the SurfaceMeshRenderableSeries3D
Gets or sets the stroke thickness of mesh wireframe lines on the SurfaceMeshRenderableSeries3D
Gets the Series type. See ESeriesType3D for a list of values
Gets or sets a Y-offset or height-offset in world coordinates.
Gets or sets a Y-offset or height-offset in world coordinates.
Applies a theme (defined by IThemeProvider) to the current element
The theme data to apply
Is being called when the data for the underlying DataSeries changes
Deletes native (WebAssembly) memory used by this type, after which it cannot be used.
Performs a HitTest operation on the series, returning the SeriesInfo3D containing the enriched Hit-Test result. This contains information about the hit-test operation such as the values of the data under the mouse and location of the data under the mouse in 3D world coordinates. This may be used for tooltips, selection or inspection of the 3d scene through mouse-clicks
The screen point (X,Y pixel coordinate in 2D space)
Notifies listeners to invalidateParentCallback that a property has changed
Called when the IRenderableSeries3D is attached to a SciChart3DSurface
the parent SciChart3DSurface
Called when the IRenderableSeries3D is detached from a SciChart3DSurface
Called when the Dpi changes in the browser. This could be due to user zooming the browser, or changing DPI settings in Windows, or moving the browser containing SciChart to another monitor
The TDpiChangedEventArgs containing info about the Dpi Changed event
Used internally - sets the 3D Scene Entity
Generated using TypeDoc
A JavaScript 3D Surface Mesh or Surface Plot chart type rendering a 2-dimensional array of data as color and height values SciChart's High Performance Real-time JavaScript 3D Chart Library
Surface meshes are a 3D representation of 2-dimensional arrays of data, rendered as a height-map with optional colors on the chart. The SurfaceMeshRenderableSeries3D assumes the cells are equal size, and spaced along the X,Z axis according to properties on the UniformGridDataSeries3D.
For a code sample how to initialize a surface mesh, see below
// Create an empty 2D array using the helper function zeroArray2D const heightMapArray: number[][] = zeroArray2D([height, width]); // todo: fill the zValues 2d array with values // Create a UniformGridDataSeries3D passing in height values const dataSeries = new UniformGridDataSeries3D(wasmContext, { yValues: heightmapArray, xStep: 1, zStep: 1, dataSeriesName: "Uniform Surface Mesh" }); // Create a color map with gradient colors const colorMap = new GradientColorPalette(wasmContext, { gradientStops: [ { offset: 1, color: "#8B0000" }, { offset: 0.9, color: "#FF0000" }, { offset: 0.7, color: "#FF0000" }, { offset: 0.5, color: "#ADFF2F" }, { offset: 0.3, color: "#00FFFF" }, { offset: 0.1, color: "#0000FF" }, { offset: 0, color: "#1D2C6B" } ] }); // Create a SurfaceMeshRenderableSeries3D const series = new SurfaceMeshRenderableSeries3D(wasmContext, { dataSeries, minimum: 0, maximum: 0.5, opacity: 0.9, cellHardnessFactor: 1.0, shininess: 0, lightingFactor: 0.8, highlight: 1.0, stroke: "rgba(24,139,34,0.5)", strokeThickness: 2.0, contourStroke: "rgba(24,139,34,0.5)", contourInterval: 2, contourOffset: 0, contourStrokeThickness: 2, drawSkirt: false, drawMeshAs: EDrawMeshAs.SOLID_WIREFRAME, meshColorPalette: colorMap, isVisible: true }); // Add the Surface Mesh to the chart sciChart3DSurface.renderableSeries.add(series);