Plotting

Plotting#

  • 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.

Actor(*args, **kwargs)

Wrap vtkActor.

Axes(*args, **kwargs)

PyVista wrapper for the VTK Axes class.

AxesActor(*args, **kwargs)

Axes actor wrapper for vtkAxesActor.

AxesAssembly(*args, **kwargs)

Assembly of arrow-style axes parts.

AxesAssemblySymmetric(*args, **kwargs)

Symmetric assembly of arrow-style axes parts.

CameraPosition(*args, **kwargs)

Container to hold camera location attributes.

CornerAnnotation(*args, **kwargs)

Text annotation in four corners.

CubeAxesActor(*args, **kwargs)

Wrap vtkCubeAxesActor.

DataSetMapper(*args, **kwargs)

Wrap vtkDataSetMapper.

Follower(*args, **kwargs)

Wrap vtkFollower.

Label(*args, **kwargs)

2D label actor with a 3D position coordinate.

LookupTable(*args, **kwargs)

Scalar to RGBA mapping table.

PlanesAssembly(*args, **kwargs)

Assembly of orthogonal planes.

Plotter(*args, **kwargs)

Plotting object to display vtk meshes or numpy arrays.

Prop3D(*args, **kwargs)

Prop3D wrapper for vtkProp3D.

Property(*args, **kwargs)

Wrap vtkProperty and expose it pythonically.

Renderer(*args, **kwargs)

Renderer class.

RenderWindowInteractor(*args, **kwargs)

Wrap vtkRenderWindowInteractor.

Text(*args, **kwargs)

Define text by default theme.

TextProperty(*args, **kwargs)

Define text's property.

Timer(*args, **kwargs)

Timer class.

plotting.mapper._BaseMapper(*args, **kwargs)

Base Mapper with methods common to other mappers.

plotting.opts.InterpolationType(*values)

Lighting interpolation types.

plotting.opts.RepresentationType(*values)

Types of representations the models can have.

plotting.opts.ElementType(*values)

Types of elemental geometries.

plotting.volume.Volume(*args, **kwargs)

Wrapper class for VTK volume.

plotting.volume_property.VolumeProperty(...)

Wrap the VTK class vtkVolumeProperty.

Composite Plotting Reference#

These classes are used when plotting pyvista.MultiBlock datasets.

CompositePolyDataMapper(*args, **kwargs)

Composite PolyData mapper.

CompositeAttributes(*args, **kwargs)

Block attributes.

BlockAttributes(*args, **kwargs)

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.plotting.widgets.WidgetHelper class. For additional details, see the Widgets examples.

plotting.widgets.WidgetHelper(*args, **kwargs)

An internal class to manage widgets.

plotting.widgets.AffineWidget3D(*args, **kwargs)

3D affine transform widget.

Picking API#

The pyvista.Plotter class inherits all of the picking methods described by the pyvista.plotting.picking.PickingHelper class.

plotting.picking.PickingHelper(*args, **kwargs)

Internal container class to contain picking helper methods.

Interactor Style API#

An interactor style sets mouse and key bindings to interact with the plot. Most often methods like pyvista.Plotter.enable_trackball_style() would be used, but this API can be used as a starting point for customizing the interaction styles.

plotting.render_window_interactor.InteractorStyleCaptureMixin(...)

A mixin for subclasses of vtkInteractorStyle with capturing ability.

plotting.render_window_interactor.InteractorStyleImage(...)

Image interactor style.

plotting.render_window_interactor.InteractorStyleJoystickActor(...)

Joystick actor interactor style.

plotting.render_window_interactor.InteractorStyleJoystickCamera(...)

Joystick camera interactor style.

plotting.render_window_interactor.InteractorStyleRubberBand2D(...)

Rubber band 2D interactor style.

plotting.render_window_interactor.InteractorStyleRubberBandPick(...)

Rubber band pick interactor style.

plotting.render_window_interactor.InteractorStyleTrackballActor(...)

Trackball actor interactor style.

plotting.render_window_interactor.InteractorStyleTrackballCamera(...)

Trackball camera interactor style.

plotting.render_window_interactor.InteractorStyleTerrain(...)

Terrain interactor style.

plotting.render_window_interactor.InteractorStyleZoom(...)

Rubber band zoom interactor style.

VTK Algorithm Utilities#

These functions create VTK algorithm pipeline nodes for use with PyVista’s pipeline-based rendering. They are useful for advanced users who need fine-grained control over the VTK pipeline.

plotting.utilities.active_scalars_algorithm(...)

Add a filter that sets the active scalars.

plotting.utilities.add_ids_algorithm(inp[, ...])

Add a filter that adds point and/or cell IDs.

plotting.utilities.algorithm_to_mesh_handler(...)

Handle vtkAlgorithm where mesh objects are expected.

plotting.utilities.callback_algorithm(inp, ...)

Add a filter that delegates to a user-supplied callable.

plotting.utilities.cell_data_to_point_data_algorithm(inp)

Add a filter that converts cell data to point data.

plotting.utilities.crinkle_algorithm(clip, ...)

Add a filter that crinkles a clip.

plotting.utilities.decimation_algorithm(inp, ...)

Decimate the input data to the target reduction.

plotting.utilities.extract_surface_algorithm(inp)

Add vtkDataSetSurfaceFilter to pipeline.

plotting.utilities.outline_algorithm(inp[, ...])

Add vtkOutlineFilter to pipeline.

plotting.utilities.point_data_to_cell_data_algorithm(inp)

Add a filter that converts point data to cell data.

plotting.utilities.pointset_to_polydata_algorithm(inp)

Add a filter that casts PointSet to PolyData.

plotting.utilities.set_algorithm_input(alg, inp)

Set the input to a vtkAlgorithm.

plotting.utilities.smooth_shading_algorithm(inp)

Add a filter that computes point normals for smooth shading.

plotting.utilities.source_algorithm(generator)

Create a source algorithm that generates data from a callable.

plotting.utilities.triangulate_algorithm(inp)

Triangulate the input data.

Convenience Functions#

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

Contents