API Reference

This section provides detailed documentation for the pyvista-wasm public API.

Plotting

pyvista_wasm.Plotter

Main plotting interface for pyvista-wasm.

Camera

pyvista_wasm.Camera

Represents a virtual camera in a 3D scene.

Lighting

pyvista_wasm.Light

Light class.

Data

pyvista_wasm.PointData

Dict-like container for point data arrays.

Mesh

pyvista_wasm.PolyData	Base polygonal mesh class.
pyvista_wasm.Arrow	Create an arrow mesh.
pyvista_wasm.Sphere	Create a sphere mesh.
pyvista_wasm.Cube	Create a cube mesh.
pyvista_wasm.Cylinder	Create a cylinder mesh.
pyvista_wasm.Cone	Create a cone mesh.
pyvista_wasm.Plane	Create a plane mesh.
pyvista_wasm.Disc	Create a disc (annular ring) geometric primitive.
pyvista_wasm.Circle	Create a circle defined by a set of points in the XY plane.
pyvista_wasm.Line	Create a line segment between two points.

Text

pyvista_wasm.Text	A text annotation actor for 3D rendering.
pyvista_wasm.TextProperty	Properties for text rendering.

Texture

pyvista_wasm.Texture

Surface texture wrapping an image URL.

Filters

pyvista_wasm.PolyData.clip	Clip the mesh with a plane.
pyvista_wasm.PolyData.contour	Generate contour lines at constant scalar values.
pyvista_wasm.PolyData.shrink	Shrink the cells of a mesh towards their centroid.
pyvista_wasm.PolyData.texture_map_to_plane	Generate texture coordinates by projecting points onto the XY plane.
pyvista_wasm.PolyData.tube	Generate a tube around a line polydata.

Readers

pyvista_wasm.GLTFReader	Reader for glTF (GL Transmission Format) files (.gltf or .glb).
pyvista_wasm.OBJReader	Reader for Wavefront OBJ files (.obj).
pyvista_wasm.PLYReader	Reader for PLY (Polygon File Format) files (.ply).
pyvista_wasm.PolyDataReader	Reader for legacy VTK PolyData files (.vtk).
pyvista_wasm.STLReader	Reader for STL (STereoLithography) files (.stl).

Examples

pyvista_wasm.examples.CubeMap	Cubemap texture holding six face image URLs.
pyvista_wasm.examples.download_bunny	Download the Stanford Bunny dataset.
pyvista_wasm.examples.download_lucy	Download the Lucy Angel dataset.
pyvista_wasm.examples.download_cad_model	Download the CAD model dataset.
pyvista_wasm.examples.download_damaged_helmet	Download the damaged helmet glTF example.
pyvista_wasm.examples.download_masonry_texture	Download the masonry texture dataset.
pyvista_wasm.examples.download_sky_box_cube_map	Download the skybox cube map dataset.
pyvista_wasm.examples.download_trumpet	Download the trumpet dataset.