1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
.. _plotting-api-index:
Plotting
========
* Intuitive plotting routines with `matplotlib`_ like syntax (see :ref:`plotting`).
* Plotting tools built for interactivity (see :ref:`widgets`).
.. toctree::
:maxdepth: 2
plotting
qt_plotting
theme
trame
.. _matplotlib: https://matplotlib.org/
Plotting API Reference
----------------------
Plotting module API reference. These plotting modules are the basis for
all plotting functionality in PyVista.
.. currentmodule:: pyvista
.. autosummary::
:toctree: _autosummary
Actor
Axes
AxesActor
AxesAssembly
AxesAssemblySymmetric
CameraPosition
CornerAnnotation
CubeAxesActor
DataSetMapper
Follower
Label
LookupTable
PlanesAssembly
Plotter
Prop3D
Property
Renderer
RenderWindowInteractor
Text
TextProperty
Timer
plotting.mapper._BaseMapper
plotting.opts.InterpolationType
plotting.opts.RepresentationType
plotting.opts.ElementType
plotting.volume.Volume
plotting.volume_property.VolumeProperty
Composite Plotting Reference
----------------------------
These classes are used when plotting :class:`pyvista.MultiBlock` datasets.
.. autosummary::
:toctree: _autosummary
CompositePolyDataMapper
CompositeAttributes
BlockAttributes
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.
.. toctree::
:maxdepth: 2
charts/index
Widget API
----------
The :class:`pyvista.Plotter` class inherits all of the widget
methods described by the :class:`pyvista.plotting.widgets.WidgetHelper`
class. For additional details, see the
:ref:`widgets` examples.
.. autosummary::
:toctree: _autosummary
plotting.widgets.WidgetHelper
plotting.widgets.AffineWidget3D
Picking API
-----------
The :class:`pyvista.Plotter` class inherits all of the picking
methods described by the :class:`pyvista.plotting.picking.PickingHelper`
class.
.. autosummary::
:toctree: _autosummary
plotting.picking.PickingHelper
Interactor Style API
--------------------
An interactor style sets mouse and key bindings to interact with
the plot. Most often methods like :func:`pyvista.Plotter.enable_trackball_style`
would be used, but this API can be used as a starting point for customizing the
interaction styles.
.. autosummary::
:toctree: _autosummary
plotting.render_window_interactor.InteractorStyleCaptureMixin
plotting.render_window_interactor.InteractorStyleImage
plotting.render_window_interactor.InteractorStyleJoystickActor
plotting.render_window_interactor.InteractorStyleJoystickCamera
plotting.render_window_interactor.InteractorStyleRubberBand2D
plotting.render_window_interactor.InteractorStyleRubberBandPick
plotting.render_window_interactor.InteractorStyleTrackballActor
plotting.render_window_interactor.InteractorStyleTrackballCamera
plotting.render_window_interactor.InteractorStyleTerrain
plotting.render_window_interactor.InteractorStyleZoom
Convenience Functions
~~~~~~~~~~~~~~~~~~~~~
These functions provide a simplified interface to the various plotting
routines in PyVista.
.. toctree::
:maxdepth: 2
conv_func
|
