Typing

Type aliases and type variable used by PyVista.

Numeric Array-Like Types

pyvista.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.ArrayLike

Any-dimensional array-like object with numerical values.

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

ArrayLike = numpy.ndarray[tuple[typing.Any, ...], numpy.dtype[~NumberType]] | collections.abc.Sequence[~NumberType] | collections.abc.Sequence[numpy.ndarray[tuple[typing.Any, ...], numpy.dtype[~NumberType]]] | collections.abc.Sequence[collections.abc.Sequence[~NumberType]] | collections.abc.Sequence[collections.abc.Sequence[numpy.ndarray[tuple[typing.Any, ...], numpy.dtype[~NumberType]]]] | collections.abc.Sequence[collections.abc.Sequence[collections.abc.Sequence[~NumberType]]] | collections.abc.Sequence[collections.abc.Sequence[collections.abc.Sequence[numpy.ndarray[tuple[typing.Any, ...], numpy.dtype[~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[numpy.ndarray[tuple[typing.Any, ...], numpy.dtype[~NumberType]]]]]]

Represent a union type

E.g. for int | str

pyvista.MatrixLike

Two-dimensional array-like object with numerical values.

Includes singly nested sequences and numpy arrays.

MatrixLike = numpy.ndarray[tuple[typing.Any, ...], numpy.dtype[~NumberType]] | collections.abc.Sequence[collections.abc.Sequence[~NumberType]] | collections.abc.Sequence[collections.abc.Sequence[numpy.ndarray[tuple[typing.Any, ...], numpy.dtype[~NumberType]]]]

Represent a union type

E.g. for int | str

pyvista.VectorLike

One-dimensional array-like object with numerical values.

Includes sequences and numpy arrays.

VectorLike = numpy.ndarray[tuple[typing.Any, ...], numpy.dtype[~NumberType]] | collections.abc.Sequence[~NumberType] | collections.abc.Sequence[numpy.ndarray[tuple[typing.Any, ...], numpy.dtype[~NumberType]]]

Represent a union type

E.g. for int | str

VTK Related Types

pyvista.BoundsTuple

class BoundsTuple(

x_min: float,

x_max: float,

y_min: float,

y_max: float,

z_min: float,

z_max: float,

)

Tuple of six values representing 3D bounds.

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

pyvista.CellsLike

CellsLike = numpy.ndarray[tuple[typing.Any, ...], numpy.dtype[int]] | collections.abc.Sequence[collections.abc.Sequence[int]] | collections.abc.Sequence[collections.abc.Sequence[numpy.ndarray[tuple[typing.Any, ...], numpy.dtype[int]]]] | collections.abc.Sequence[int] | collections.abc.Sequence[numpy.ndarray[tuple[typing.Any, ...], numpy.dtype[int]]]

Represent a union type

E.g. for int | str

pyvista.CellArrayLike

CellArrayLike = numpy.ndarray[tuple[typing.Any, ...], numpy.dtype[int]] | collections.abc.Sequence[collections.abc.Sequence[int]] | collections.abc.Sequence[collections.abc.Sequence[numpy.ndarray[tuple[typing.Any, ...], numpy.dtype[int]]]] | collections.abc.Sequence[int] | collections.abc.Sequence[numpy.ndarray[tuple[typing.Any, ...], numpy.dtype[int]]] | vtkmodules.vtkCommonDataModel.vtkCellArray

Represent a union type

E.g. for int | str

pyvista.RotationLike

Array or object representing a spatial rotation.

Includes 3x3 arrays and SciPy Rotation objects.

RotationLike = numpy.ndarray[tuple[typing.Any, ...], numpy.dtype[float]] | collections.abc.Sequence[collections.abc.Sequence[float]] | collections.abc.Sequence[collections.abc.Sequence[numpy.ndarray[tuple[typing.Any, ...], numpy.dtype[float]]]] | vtkmodules.vtkCommonMath.vtkMatrix3x3 | scipy.spatial.transform._rotation.Rotation

Represent a union type

E.g. for int | str

pyvista.TransformLike

Array or object representing a spatial transformation.

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

TransformLike = numpy.ndarray[tuple[typing.Any, ...], numpy.dtype[float]] | collections.abc.Sequence[collections.abc.Sequence[float]] | collections.abc.Sequence[collections.abc.Sequence[numpy.ndarray[tuple[typing.Any, ...], numpy.dtype[float]]]] | vtkmodules.vtkCommonMath.vtkMatrix3x3 | scipy.spatial.transform._rotation.Rotation | vtkmodules.vtkCommonMath.vtkMatrix4x4 | vtkmodules.vtkCommonTransforms.vtkTransform

Represent a union type

E.g. for int | str

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

Represent a union type

E.g. for int | str

pyvista.CameraPositionOptions

Any object used to set a Camera.

CameraPositionOptions = typing.Literal['xy', 'xz', 'yz', 'yx', 'zx', 'zy', 'iso'] | numpy.ndarray[tuple[typing.Any, ...], numpy.dtype[float]] | collections.abc.Sequence[float] | collections.abc.Sequence[numpy.ndarray[tuple[typing.Any, ...], numpy.dtype[float]]] | collections.abc.Sequence[collections.abc.Sequence[float]] | collections.abc.Sequence[collections.abc.Sequence[numpy.ndarray[tuple[typing.Any, ...], numpy.dtype[float]]]] | pyvista.plotting.renderer.CameraPosition

Represent a union type

E.g. for int | str

pyvista.JupyterBackendOptions

Jupyter backend to use.

JupyterBackendOptions

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

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

Represent a union type

E.g. for int | str