3D API Reference

Complete API documentation for the 3D rendering module.

Architecture

Velo Plot 3D uses specialized renderer classes that manage their own WebGL2 context, camera, and interaction. This provides maximum performance for complex visualizations like surface meshes or high-density point clouds.

Core Renderers

Area3DRenderer

Renders filled 3D areas (curtain effect) with lighting and tooltips.

import { Area3DRenderer } from 'velo-plot/plugins/3d';

const renderer = new Area3DRenderer({
  canvas: document.getElementById('my-canvas'),
  showAxes: true,
  opacity: 0.8
});

Waterfall3DRenderer

Specialized for cascading spectral results or time-series profiles.

import { Waterfall3DRenderer } from 'velo-plot/plugins/3d';

Specialized Renderer Classes

Class	Type	Description
Waterfall3DRenderer	'waterfall'	Cascading spectral results
VectorField3DRenderer	'quiver'	Directional 3D vector fields
PointCloud3DRenderer	'pointcloud'	High-density 3D markers
Voxel3DRenderer	'voxel'	Volumetric intensity grids
Ribbon3DRenderer	'ribbon'	Lit extruded path ribbons
SurfaceBar3DRenderer	'column'	Instanced 3D histogram

Series Renderers

Class	Type	Description
SurfaceMesh3D	'surface'	Grid-based height map
PointLine3D	'pointline'	Connected points
Scatter3D	'scatter'	Clusters / Points
Area3D	'area'	Filled area under line
Heatmap3D	'heatmap'	Colored grid on plane
Impulse3D	'impulse'	Vertical stems

Camera & Controls

Class	Description
OrbitCamera	Spherical coordinate camera
OrbitController	Mouse/touch interaction handler

Math Utilities

Module	Description
Mat4	4x4 matrix operations
Vec3	3D vector operations

Types

See Types Reference for all TypeScript interfaces.

Quick Links

• Bubble3DRenderer
• Axes3D
• OrbitController
• OrbitCamera
• Series Types
• Math Utilities

Known limitations

• Bundle entry — pick velo-plot, velo-plot/trading, velo-plot/scientific, or velo-plot/full. See Bundle Architecture.
• WebGPU renderer (renderer: 'webgpu') requires an extended bundle entry and is experimental — use WebGL (default) for production.
• SVG — exportSVG() and renderer: 'svg' require an extended bundle. LaTeX labels and contour overlays are partial; 3D is not supported in SVG. See SVG examples.
• See Plugin status registry for plugin maturity (complete, partial, experimental).