Typing

Type aliases and type variable used by PyVista.

Numeric Array-Like Types

pyvista.NumberType

NumberType = TypeVar(NumberType, bound=Union)

Type:    TypeVar

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

Type variable for numeric data types.

pyvista.ArrayLike

ArrayLike

Any-dimensional array-like object with numerical values.

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

alias of ndarray[tuple[Any, …], dtype[NumberType]] | Sequence[NumberType] | Sequence[ndarray[tuple[Any, …], dtype[NumberType]]] | Sequence[Sequence[NumberType]] | Sequence[Sequence[ndarray[tuple[Any, …], dtype[NumberType]]]] | Sequence[Sequence[Sequence[NumberType]]] | Sequence[Sequence[Sequence[ndarray[tuple[Any, …], dtype[NumberType]]]]] | Sequence[Sequence[Sequence[Sequence[NumberType]]]] | Sequence[Sequence[Sequence[Sequence[ndarray[tuple[Any, …], dtype[NumberType]]]]]]

pyvista.MatrixLike

MatrixLike

Two-dimensional array-like object with numerical values.

Includes singly-nested sequences and numpy arrays.

alias of ndarray[tuple[Any, …], dtype[NumberType]] | Sequence[Sequence[NumberType]] | Sequence[Sequence[ndarray[tuple[Any, …], dtype[NumberType]]]]

pyvista.VectorLike

VectorLike

One-dimensional array-like object with numerical values.

Includes sequences and numpy arrays.

alias of ndarray[tuple[Any, …], dtype[NumberType]] | Sequence[NumberType] | Sequence[ndarray[tuple[Any, …], dtype[NumberType]]]

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

alias of ndarray[tuple[Any, …], dtype[int]] | Sequence[Sequence[int]] | Sequence[Sequence[ndarray[tuple[Any, …], dtype[int]]]] | Sequence[int] | Sequence[ndarray[tuple[Any, …], dtype[int]]]

pyvista.CellArrayLike

CellArrayLike

alias of ndarray[tuple[Any, …], dtype[int]] | Sequence[Sequence[int]] | Sequence[Sequence[ndarray[tuple[Any, …], dtype[int]]]] | Sequence[int] | Sequence[ndarray[tuple[Any, …], dtype[int]]] | vtkCellArray

pyvista.RotationLike

RotationLike

Array or object representing a spatial rotation.

Includes 3x3 arrays and SciPy Rotation objects.

alias of ndarray[tuple[Any, …], dtype[float]] | Sequence[Sequence[float]] | Sequence[Sequence[ndarray[tuple[Any, …], dtype[float]]]] | vtkMatrix3x3 | Rotation

pyvista.TransformLike

TransformLike

Array or object representing a spatial transformation.

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

alias of ndarray[tuple[Any, …], dtype[float]] | Sequence[Sequence[float]] | Sequence[Sequence[ndarray[tuple[Any, …], dtype[float]]]] | vtkMatrix3x3 | Rotation | vtkMatrix4x4 | vtkTransform

pyvista.InteractionEventType

InteractionEventType

Interaction event mostly used for widgets.

Includes both strings such as end, ‘start’ and always and _vtk.vtkCommand.EventIds.

alias of Literal[‘end’, ‘start’, ‘always’] | EventIds

Data Object Types

pyvista._GridType

_GridType = TypeVar(_GridType, bound=Grid)

Type:    TypeVar

Invariant TypeVar bound to pyvista.core.grid.Grid.

Type variable for PyVista Grid classes.

pyvista._PointGridType

_PointGridType = TypeVar(_PointGridType, bound=PointGrid)

Type:    TypeVar

Invariant TypeVar bound to pyvista.core.pointset.PointGrid.

Type variable for PyVista PointGrid classes.

pyvista._PointSetType

_PointSetType = TypeVar(_PointSetType, bound=_PointSet)

Type:    TypeVar

Invariant TypeVar bound to pyvista.core.pointset._PointSet.

Type variable for PyVista PointSet classes.

pyvista._DataSetType

_DataSetType = TypeVar(_DataSetType, bound=DataSet)

Type:    TypeVar

Invariant TypeVar bound to pyvista.core.dataset.DataSet.

Type variable for DataSet classes.

pyvista._DataSetOrMultiBlockType

_DataSetOrMultiBlockType = TypeVar(_DataSetOrMultiBlockType, bound=Union)

Type:    TypeVar

Invariant TypeVar bound to typing.Union[pyvista.core.dataset.DataSet, pyvista.core.composite.MultiBlock].

Type variable for DataSet or MultiBlock classes.

pyvista._DataObjectType

_DataObjectType = TypeVar(_DataObjectType, bound=DataObject)

Type:    TypeVar

Invariant TypeVar bound to pyvista.core.dataobject.DataObject.

Type variable for DataObject classes.