Typing

Typing#

Type aliases for annotating code that uses PyVista.

Added in version 0.50: The pyvista.typing module.

Deprecated since version 0.50: Accessing these aliases from pyvista, for example pyvista.ColorLike, is deprecated. Use pyvista.typing.ColorLike instead.

Deprecated since version 0.50: pyvista.Number, pyvista.NumberType and pyvista.NumpyArray are deprecated. Use float, a TypeVar and numpy.typing.NDArray instead.

Deprecated since version 0.50: pyvista.ArrayLike, pyvista.MatrixLike and pyvista.VectorLike are deprecated. Use the Float, Int or Bool array-like types instead, for example VectorLikeFloat in place of VectorLike[float].

Numeric Array-Like Types#

Each array-like accepts NumPy arrays and sequences of one kind of value. As in Python type hints, Float means float, which also accepts int and bool, so the Float types accept integer and boolean arrays too; likewise the Int types accept boolean arrays. A sequence holds either Python values or NumPy scalars, not a mix of both, and a lone scalar or zero-dimensional array is not array-like. Complex, string, and object arrays are not included; annotate an input that accepts them as NDArray[Any] | Sequence[Any].

pyvista.typing.VectorLikeFloat#

One-dimensional array-like object with numerical values, such as a list of numbers or a 1D NumPy array.

Sequence[float]
| Sequence[np.floating | np.integer | np.bool]
| np.ndarray[
    tuple[int], np.dtype[np.floating | np.integer | np.bool]
]

pyvista.typing.VectorLikeInt#

One-dimensional array-like object with integer values, such as a list of integers or a 1D NumPy array.

Sequence[int]
| Sequence[np.integer | np.bool]
| np.ndarray[tuple[int], np.dtype[np.integer | np.bool]]

pyvista.typing.VectorLikeBool#

One-dimensional array-like object with boolean values, such as a list of booleans or a 1D NumPy array.

Sequence[bool]
| Sequence[np.bool]
| np.ndarray[tuple[int], np.dtype[np.bool]]

pyvista.typing.MatrixLikeFloat#

Two-dimensional array-like object with numerical values, such as a list of vectors or a 2D NumPy array.

Sequence[Sequence[float]]
| Sequence[
    Sequence[np.floating | np.integer | np.bool]
    | np.ndarray[
        tuple[int], np.dtype[np.floating | np.integer | np.bool]
    ]
]
| np.ndarray[
    tuple[int, int], np.dtype[np.floating | np.integer | np.bool]
]

pyvista.typing.MatrixLikeInt#

Two-dimensional array-like object with integer values, such as a list of vectors or a 2D NumPy array.

Sequence[Sequence[int]]
| Sequence[
    Sequence[np.integer | np.bool]
    | np.ndarray[tuple[int], np.dtype[np.integer | np.bool]]
]
| np.ndarray[tuple[int, int], np.dtype[np.integer | np.bool]]

pyvista.typing.MatrixLikeBool#

Two-dimensional array-like object with boolean values, such as a list of vectors or a 2D NumPy array.

Sequence[Sequence[bool]]
| Sequence[
    Sequence[np.bool] | np.ndarray[tuple[int], np.dtype[np.bool]]
]
| np.ndarray[tuple[int, int], np.dtype[np.bool]]

pyvista.typing.ArrayLikeFloat#

Any-dimensional array-like object with numerical values, such as nested lists of numbers or a NumPy array.

Sequence[
    float
    | Sequence[float]
    | Sequence[float | Sequence[float]]
    | Sequence[
        float | Sequence[float] | Sequence[float | Sequence[float]]
    ]
]
| Sequence[
    np.floating
    | np.integer
    | np.bool
    | NDArray[np.floating | np.integer | np.bool]
    | Sequence[
        np.floating
        | np.integer
        | np.bool
        | NDArray[np.floating | np.integer | np.bool]
    ]
    | Sequence[
        np.floating
        | np.integer
        | np.bool
        | NDArray[np.floating | np.integer | np.bool]
        | Sequence[
            np.floating
            | np.integer
            | np.bool
            | NDArray[np.floating | np.integer | np.bool]
        ]
    ]
    | Sequence[
        np.floating
        | np.integer
        | np.bool
        | NDArray[np.floating | np.integer | np.bool]
        | Sequence[
            np.floating
            | np.integer
            | np.bool
            | NDArray[np.floating | np.integer | np.bool]
        ]
        | Sequence[
            np.floating
            | np.integer
            | np.bool
            | NDArray[np.floating | np.integer | np.bool]
            | Sequence[
                np.floating
                | np.integer
                | np.bool
                | NDArray[np.floating | np.integer | np.bool]
            ]
        ]
    ]
]
| np.ndarray[
    tuple[int, *tuple[int, ...]],
    np.dtype[np.floating | np.integer | np.bool],
]

pyvista.typing.ArrayLikeInt#

Any-dimensional array-like object with integer values, such as nested lists of integers or a NumPy array.

Sequence[
    int
    | Sequence[int]
    | Sequence[int | Sequence[int]]
    | Sequence[int | Sequence[int] | Sequence[int | Sequence[int]]]
]
| Sequence[
    np.integer
    | np.bool
    | NDArray[np.integer | np.bool]
    | Sequence[np.integer | np.bool | NDArray[np.integer | np.bool]]
    | Sequence[
        np.integer
        | np.bool
        | NDArray[np.integer | np.bool]
        | Sequence[
            np.integer | np.bool | NDArray[np.integer | np.bool]
        ]
    ]
    | Sequence[
        np.integer
        | np.bool
        | NDArray[np.integer | np.bool]
        | Sequence[
            np.integer | np.bool | NDArray[np.integer | np.bool]
        ]
        | Sequence[
            np.integer
            | np.bool
            | NDArray[np.integer | np.bool]
            | Sequence[
                np.integer | np.bool | NDArray[np.integer | np.bool]
            ]
        ]
    ]
]
| np.ndarray[
    tuple[int, *tuple[int, ...]], np.dtype[np.integer | np.bool]
]

pyvista.typing.ArrayLikeBool#

Any-dimensional array-like object with boolean values, such as nested lists of booleans or a NumPy array.

Sequence[
    bool
    | Sequence[bool]
    | Sequence[bool | Sequence[bool]]
    | Sequence[
        bool | Sequence[bool] | Sequence[bool | Sequence[bool]]
    ]
]
| Sequence[
    np.bool
    | NDArray[np.bool]
    | Sequence[np.bool | NDArray[np.bool]]
    | Sequence[
        np.bool
        | NDArray[np.bool]
        | Sequence[np.bool | NDArray[np.bool]]
    ]
    | Sequence[
        np.bool
        | NDArray[np.bool]
        | Sequence[np.bool | NDArray[np.bool]]
        | Sequence[
            np.bool
            | NDArray[np.bool]
            | Sequence[np.bool | NDArray[np.bool]]
        ]
    ]
]
| np.ndarray[tuple[int, *tuple[int, ...]], np.dtype[np.bool]]

VTK Related Types#

pyvista.typing.WrappableType#

Object accepted by wrap(), such as a VTK data object, a NumPy array of points, or a mesh from another library.

vtkDataSet
| vtkMultiBlockDataSet
| vtkPartitionedDataSet
| DataSet
| MultiBlock
| PartitionedDataSet
| NDArray[
    np.float64
    | np.float32
    | np.float16
    | np.int64
    | np.int32
    | np.int16
    | np.int8
    | np.uint64
    | np.uint32
    | np.uint16
    | np.uint8
    | np.bool
    | np.complex64
    | np.complex128
]
| VectorLikeFloat
| MatrixLikeFloat
| trimesh.Trimesh
| meshio.Mesh
| vtkDataObject
| DataObject
| vtkDataArray
| None

pyvista.BoundsTuple#

class BoundsTuple( x_min: float, x_max: float, y_min: float, y_max: float, z_min: float, z_max: float, )[source]#

Tuple of six values representing 3D bounds.

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

pyvista.typing.CellsLike#

MatrixLikeInt | VectorLikeInt

pyvista.typing.CellArrayLike#

CellsLike | vtkCellArray

pyvista.typing.RotationLike#

Array or object representing a spatial rotation, such as a 3x3 matrix.

MatrixLikeFloat | vtkMatrix3x3 | Rotation

pyvista.typing.TransformLike#

Array or object representing a spatial transformation, such as a 4x4 matrix or a RotationLike.

RotationLike | vtkMatrix4x4 | vtkTransform

pyvista.typing.InteractionEventType#

Interaction event mostly used for widgets, given by name or as a VTK event ID.

Literal['end', 'start', 'always'] | vtkCommand.EventIds

pyvista.typing.LineStyle#

Named style of a line, shared by the charts and the line filters.

Literal['', '-', '--', ':', '-.', '-..']

pyvista.typing.CameraPositionOptions#

Any object used to set a Camera.

Literal['xy', 'xz', 'yz', 'yx', 'zx', 'zy', 'iso']
| VectorLikeFloat
| MatrixLikeFloat
| Sequence[VectorLikeFloat]
| CameraPosition

pyvista.typing.JupyterBackendOptions#

Jupyter backend to use.

Literal['static', 'client', 'server', 'trame', 'html', 'none']

pyvista.typing.MeshValidationFields#

Field options for validate_mesh().

Literal['cell_data_wrong_length', 'point_data_wrong_length']
| Literal['non_finite_points', 'unused_points']
| 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',
]
| Literal['data', 'points', 'cells']
| Literal['memory_safe']
| CellStatus

Plotting Types#

pyvista.typing.ColorLike#

Any object that can be converted to a Color.

tuple[int, int, int]
| tuple[int, int, int, int]
| tuple[float, float, float]
| tuple[float, float, float, float]
| Sequence[int]
| Sequence[float]
| NDArray[np.floating]
| NDArray[np.integer]
| dict[str, int | float | str]
| str
| Color
| vtkColor3ub
| _ALL_COLORS_LITERAL

pyvista.typing.Chart#

Chart accepted by add_chart().

Chart2D | ChartBox | ChartPie | ChartMPL

pyvista.typing.PlottableType#

Object accepted by plot() or add_mesh(), such as a dataset, a NumPy array of points, or the path of a mesh file.

vtkDataSet
| vtkMultiBlockDataSet
| vtkPartitionedDataSet
| DataSet
| MultiBlock
| PartitionedDataSet
| NDArray[
    np.float64
    | np.float32
    | np.float16
    | np.int64
    | np.int32
    | np.int16
    | np.int8
    | np.uint64
    | np.uint32
    | np.uint16
    | np.uint8
    | np.bool
    | np.complex64
    | np.complex128
]
| VectorLikeFloat
| MatrixLikeFloat
| trimesh.Trimesh
| meshio.Mesh
| str
| Path