• Intuitive plotting routines with matplotlib like syntax (see Plotting).

  • Plotting tools built for interactivity (see Widgets).

Plotting API Reference#

Plotting module API reference. These plotting modules are the basis for all plotting functionality in PyVista.

BasePlotter(*args, **kwargs)

Base plotting class.

Plotter(*args, **kwargs)

Plotting object to display vtk meshes or numpy arrays.

Renderer(parent[, border, border_color, ...])

Renderer class.

Property([theme, interpolation, color, ...])

Wrap vtkProperty and expose it pythonically.


Wrap the VTK class vtkVolumeProperty.


Wrapper class for VTK volume.

Actor([mapper, prop, name])

Wrap vtkActor.

DataSetMapper([dataset, theme])

Wrap _vtk.vtkDataSetMapper.

LookupTable([cmap, n_values, flip, values, ...])

Scalar to RGBA mapping table.

Composite Plotting Reference#

These classes are used when plotting pyvista.MultiBlock datasets.

CompositePolyDataMapper(dataset[, theme, ...])

Composite PolyData mapper.

CompositeAttributes(mapper, dataset)

Block attributes.

BlockAttributes(block, attr)

Block attributes used to set the attributes of a block.

Charts API#

Charts API reference. These dedicated classes can be used to embed charts in plotting windows. Note that full charts functionality requires a VTK version of at least 9.3. Most components work fine in older versions though.

Widget API#

The pyvista.Plotter class inherits all of the widget methods described by the pyvista.WidgetHelper class. For additional details, see the Widgets examples.

Convenience Functions#

These functions provide a simplified interface to the various plotting routines in PyVista.