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]]]

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.