Typing

Typing#

Type aliases and type variable for annotating code that uses PyVista.

Added in version 0.50: The pyvista.typing module.

Deprecated since version 0.50: Accessing these aliases from pyvista, for example pyvista.VectorLike, is deprecated. Use pyvista.typing.VectorLike instead.

Numeric Array-Like Types#

pyvista.typing.NumberType#

Type variable for numeric data types.

NumberType = TypeVar(NumberType, bound=Union)#

Type: TypeVar

Invariant TypeVar bound to typing.Union[numpy.floating, numpy.integer, numpy.bool, float, int, bool].

pyvista.typing.Number#

Integer or float value.

Number = int | float#

pyvista.typing.ArrayLike#

Any-dimensional array-like object with numerical values.

Includes sequences, nested sequences, and numpy arrays. Scalar values are not included.

ArrayLike = NDArray[~NumberType] | collections.abc.Sequence[~NumberType] | collections.abc.Sequence[NDArray[~NumberType]] | collections.abc.Sequence[collections.abc.Sequence[~NumberType]] | collections.abc.Sequence[collections.abc.Sequence[NDArray[~NumberType]]] | collections.abc.Sequence[collections.abc.Sequence[collections.abc.Sequence[~NumberType]]] | collections.abc.Sequence[collections.abc.Sequence[collections.abc.Sequence[NDArray[~NumberType]]]] | collections.abc.Sequence[collections.abc.Sequence[collections.abc.Sequence[collections.abc.Sequence[~NumberType]]]] | collections.abc.Sequence[collections.abc.Sequence[collections.abc.Sequence[collections.abc.Sequence[NDArray[~NumberType]]]]]#

pyvista.typing.MatrixLike#

Two-dimensional array-like object with numerical values.

Includes singly nested sequences and numpy arrays.

MatrixLike = NDArray[~NumberType] | collections.abc.Sequence[collections.abc.Sequence[~NumberType]] | collections.abc.Sequence[collections.abc.Sequence[NDArray[~NumberType]]]#

pyvista.typing.VectorLike#

One-dimensional array-like object with numerical values.

Includes sequences and numpy arrays.

VectorLike = NDArray[~NumberType] | collections.abc.Sequence[~NumberType] | collections.abc.Sequence[NDArray[~NumberType]]#

VTK Related Types#

pyvista.typing.WrappableType#

Object accepted by pyvista.wrap().

Includes PyVista and VTK data objects, NumPy arrays, trimesh meshes, meshio meshes, and None.

WrappableType = vtkmodules.vtkCommonDataModel.vtkDataObject | ForwardRef('DataObject') | vtkmodules.vtkCommonCore.vtkDataArray | NDArray[float] | ForwardRef('trimesh.Trimesh') | ForwardRef('meshio.Mesh') | None#

pyvista.BoundsTuple#

class BoundsTuple( x_min: float, x_max: float, y_min: float, y_max: float, z_min: float, z_max: float, )[source]#

Tuple of six values representing 3D bounds.

Has the form (x_min, x_max, y_min, y_max, z_min, z_max).

pyvista.typing.CellsLike#

CellsLike = NDArray[int] | collections.abc.Sequence[collections.abc.Sequence[int]] | collections.abc.Sequence[collections.abc.Sequence[NDArray[int]]] | collections.abc.Sequence[int] | collections.abc.Sequence[NDArray[int]]#

pyvista.typing.CellArrayLike#

CellArrayLike = NDArray[int] | collections.abc.Sequence[collections.abc.Sequence[int]] | collections.abc.Sequence[collections.abc.Sequence[NDArray[int]]] | collections.abc.Sequence[int] | collections.abc.Sequence[NDArray[int]] | vtkmodules.vtkCommonDataModel.vtkCellArray#

pyvista.typing.RotationLike#

Array or object representing a spatial rotation.

Includes 3x3 arrays and SciPy Rotation objects.

RotationLike = NDArray[float] | collections.abc.Sequence[collections.abc.Sequence[float]] | collections.abc.Sequence[collections.abc.Sequence[NDArray[float]]] | vtkmodules.vtkCommonMath.vtkMatrix3x3 | scipy.spatial.transform._rotation.Rotation#

pyvista.typing.TransformLike#

Array or object representing a spatial transformation.

Includes 3x3 and 4x4 arrays as well as SciPy Rotation objects.

TransformLike = NDArray[float] | collections.abc.Sequence[collections.abc.Sequence[float]] | collections.abc.Sequence[collections.abc.Sequence[NDArray[float]]] | vtkmodules.vtkCommonMath.vtkMatrix3x3 | scipy.spatial.transform._rotation.Rotation | vtkmodules.vtkCommonMath.vtkMatrix4x4 | vtkmodules.vtkCommonTransforms.vtkTransform#

pyvista.typing.InteractionEventType#

Interaction event mostly used for widgets.

Includes both strings such as 'end', 'start' and 'always' and vtkCommand.EventIds.

InteractionEventType = typing.Literal['end', 'start', 'always'] | vtkmodules.vtkCommonCore.vtkCommand.EventIds#

pyvista.typing.LineStyle#

Named style of a line, shared by the charts and the line filters.

LineStyle#: alias of Literal[‘’, ‘-’, ‘–’, ‘:’, ‘-.’, ‘-..’]

pyvista.typing.CameraPositionOptions#

Any object used to set a Camera.

CameraPositionOptions = typing.Literal['xy', 'xz', 'yz', 'yx', 'zx', 'zy', 'iso'] | NDArray[float] | collections.abc.Sequence[float] | collections.abc.Sequence[NDArray[float]] | collections.abc.Sequence[collections.abc.Sequence[float]] | collections.abc.Sequence[collections.abc.Sequence[NDArray[float]]] | collections.abc.Sequence[NDArray[float] | collections.abc.Sequence[float] | collections.abc.Sequence[NDArray[float]]] | pyvista.plotting.renderer.CameraPosition#

pyvista.typing.JupyterBackendOptions#

Jupyter backend to use.

JupyterBackendOptions#: alias of Literal[‘static’, ‘client’, ‘server’, ‘trame’, ‘html’, ‘none’]

pyvista.typing.MeshValidationFields#

Field options for validate_mesh().

MeshValidationFields = typing.Literal['cell_data_wrong_length', 'point_data_wrong_length'] | typing.Literal['non_finite_points', 'unused_points'] | typing.Literal['coincident_points', 'degenerate_faces', 'intersecting_edges', 'intersecting_faces', 'invalid_point_references', 'inverted_faces', 'negative_size', 'non_contiguous_edges', 'non_convex', 'non_planar_faces', 'wrong_number_of_points', 'zero_size'] | typing.Literal['data', 'points', 'cells'] | typing.Literal['memory_safe'] | pyvista.core.filters.data_object.CellStatus#

Plotting Types#

pyvista.typing.ColorLike#

Any object that can be converted to a Color.

ColorLike = tuple[int, int, int] | tuple[int, int, int, int] | tuple[float, float, float] | tuple[float, float, float, float] | collections.abc.Sequence[int] | collections.abc.Sequence[float] | NDArray[float] | dict[str, int | float | str] | str | ForwardRef('Color') | vtkmodules.vtkCommonDataModel.vtkColor3ub | ForwardRef('_ALL_COLORS_LITERAL')#

pyvista.typing.Chart#

Any of Chart2D, ChartBox, ChartPie or ChartMPL, as accepted by add_chart().

Chart#

pyvista.typing.PlottableType#

Object accepted by pyvista.plot() or pyvista.Plotter.add_mesh().

Includes PyVista and VTK datasets and composite datasets, trimesh and meshio meshes, NumPy arrays of points or of volume values, and the path of a mesh file.

PlottableType = NDArray[float] | collections.abc.Sequence[float] | collections.abc.Sequence[NDArray[float]] | collections.abc.Sequence[collections.abc.Sequence[float]] | collections.abc.Sequence[collections.abc.Sequence[NDArray[float]]] | collections.abc.Sequence[collections.abc.Sequence[collections.abc.Sequence[float]]] | collections.abc.Sequence[collections.abc.Sequence[collections.abc.Sequence[NDArray[float]]]] | collections.abc.Sequence[collections.abc.Sequence[collections.abc.Sequence[collections.abc.Sequence[float]]]] | collections.abc.Sequence[collections.abc.Sequence[collections.abc.Sequence[collections.abc.Sequence[NDArray[float]]]]] | vtkmodules.vtkCommonDataModel.vtkDataObject | ForwardRef('DataObject') | vtkmodules.vtkCommonCore.vtkDataArray | ForwardRef('trimesh.Trimesh') | ForwardRef('meshio.Mesh') | str | pathlib.Path#