Typing

Type aliases and type variable used by PyVista.

Numeric Array-Like Types

NumberType = TypeVar(NumberType, bool, int, float, bool_, int64, float64, uint8)

Type:    TypeVar

Invariant TypeVar constrained to bool, int, float, numpy.bool_, numpy.int64, numpy.float64 and numpy.uint8.

Type variable for numeric data types.

ArrayLike

Any-dimensional array-like object with numerical values.

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

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

MatrixLike

Two-dimensional array-like object with numerical values.

Includes singly-nested sequences and numpy arrays.

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

VectorLike

One-dimensional array-like object with numerical values.

Includes sequences and numpy arrays.

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

VTK Related Types

BoundsLike

Tuple of six values representing 3D bounds.

Has the form (xmin, xmax, ymin, ymax, zmin, zmax).

alias of Tuple[Union[int, float], Union[int, float], Union[int, float], Union[int, float], Union[int, float], Union[int, float]]

CellsLike

alias of Union[ndarray[Any, dtype[int]], Sequence[Sequence[int]], Sequence[Sequence[ndarray[Any, dtype[int]]]], Sequence[int], Sequence[ndarray[Any, dtype[int]]]]

CellArrayLike

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

TransformLike

Array or vtk object representing a 3x3 or 4x4 matrix.

alias of Union[ndarray[Any, dtype[float]], Sequence[Sequence[float]], Sequence[Sequence[ndarray[Any, dtype[float]]]], vtkMatrix3x3, vtkMatrix4x4, vtkTransform]