Plotter.add_arrows

Plotter.add_arrows(

cent: NumpyArray[float],

direction: NumpyArray[float],

mag: float = 1.0,

**kwargs,

) → Actor

Add arrows to the plotter.

Parameters:

centnp.ndarray

Array of centers.

directionnp.ndarray

Array of direction vectors.

magfloat, optional

Amount to scale the direction vectors.

**kwargsdict, optional

See pyvista.Plotter.add_mesh() for optional keyword arguments.

Returns:

pyvista.Actor

Actor of the arrows.

Examples

Download Python source code | Download Jupyter notebook

Plot a random field of vectors and save a screenshot of it.

>>> import numpy as np
>>> import pyvista as pv
>>> rng = np.random.default_rng(seed=0)
>>> cent = rng.random((10, 3))
>>> direction = rng.random((10, 3))
>>> pl = pv.Plotter()
>>> _ = pl.add_arrows(cent, direction, mag=2)
>>> pl.show()

Static Scene

Interactive Scene