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[Any, dtype[NumberType]] | Sequence[NumberType] | Sequence[ndarray[Any, dtype[NumberType]]] | Sequence[Sequence[NumberType]] | Sequence[Sequence[ndarray[Any, dtype[NumberType]]]] | Sequence[Sequence[Sequence[NumberType]]] | Sequence[Sequence[Sequence[ndarray[Any, dtype[NumberType]]]]] | Sequence[Sequence[Sequence[Sequence[NumberType]]]] | Sequence[Sequence[Sequence[Sequence[ndarray[Any, dtype[NumberType]]]]]]

pyvista.MatrixLike

MatrixLike

Two-dimensional array-like object with numerical values.

Includes singly-nested sequences and numpy arrays.

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

pyvista.VectorLike

VectorLike

One-dimensional array-like object with numerical values.

Includes sequences and numpy arrays.

alias of ndarray[Any, dtype[NumberType]] | Sequence[NumberType] | Sequence[ndarray[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[Any, dtype[int]] | Sequence[Sequence[int]] | Sequence[Sequence[ndarray[Any, dtype[int]]]] | Sequence[int] | Sequence[ndarray[Any, dtype[int]]]

pyvista.CellArrayLike

CellArrayLike

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

pyvista.RotationLike

RotationLike

Array or object representing a spatial rotation.

Includes 3x3 arrays and SciPy Rotation objects.

alias of ndarray[Any, dtype[float]] | Sequence[Sequence[float]] | Sequence[Sequence[ndarray[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[Any, dtype[float]] | Sequence[Sequence[float]] | Sequence[Sequence[ndarray[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

Concrete Data Object Types

pyvista.ConcreteGridType

ConcreteGridType = TypeVar(ConcreteGridType, bound=Union)

Type:    TypeVar

Invariant TypeVar bound to typing.Union[pyvista.core.grid.ImageData, pyvista.core.grid.RectilinearGrid].

Type variable of all concrete PyVista Grid classes.

pyvista.ConcretePointGridType

ConcretePointGridType = TypeVar(ConcretePointGridType, bound=Union)

Type:    TypeVar

Invariant TypeVar bound to typing.Union[pyvista.core.pointset.ExplicitStructuredGrid, pyvista.core.pointset.StructuredGrid, pyvista.core.pointset.UnstructuredGrid].

Type variable of all concrete PyVista PointGrid` classes.

pyvista.ConcretePointSetType

ConcretePointSetType = TypeVar(ConcretePointSetType, bound=Union)

Type:    TypeVar

Invariant TypeVar bound to typing.Union[pyvista.core.pointset.ExplicitStructuredGrid, pyvista.core.pointset.PointSet, pyvista.core.pointset.PolyData, pyvista.core.pointset.StructuredGrid, pyvista.core.pointset.UnstructuredGrid].

Type variable of all concrete PyVista PointSet classes.

pyvista.ConcreteDataSetType

ConcreteDataSetType = TypeVar(ConcreteDataSetType, bound=Union)

Type:    TypeVar

Invariant TypeVar bound to typing.Union[pyvista.core.grid.ImageData, pyvista.core.grid.RectilinearGrid, pyvista.core.pointset.ExplicitStructuredGrid, pyvista.core.pointset.PointSet, pyvista.core.pointset.PolyData, pyvista.core.pointset.StructuredGrid, pyvista.core.pointset.UnstructuredGrid].

Type variable of all concrete DataSet classes.

pyvista.ConcreteDataObjectType

ConcreteDataObjectType = TypeVar(ConcreteDataObjectType, bound=Union)

Type:    TypeVar

Invariant TypeVar bound to typing.Union[pyvista.core.grid.ImageData, pyvista.core.grid.RectilinearGrid, pyvista.core.pointset.ExplicitStructuredGrid, pyvista.core.pointset.PointSet, pyvista.core.pointset.PolyData, pyvista.core.pointset.StructuredGrid, pyvista.core.pointset.UnstructuredGrid, pyvista.core.objects.Table, pyvista.core.composite.MultiBlock, pyvista.core.partitioned.PartitionedDataSet].

Type variable of all concrete DataObject classes.