pyvista.Plotter.add_point_scalar_labels#
- Plotter.add_point_scalar_labels(
- points: MatrixLike[float] | VectorLike[float] | DataSet,
- labels: list[str | int] | str,
- fmt: str | None = None,
- preamble: str = '',
- **kwargs,
Label the points from a dataset with the values of their scalars.
Wrapper for
pyvista.Plotter.add_point_labels()
.- Parameters:
- pointssequence[
float
] |np.ndarray
|DataSet
An
n x 3
numpy.ndarray or pyvista dataset with points.- labels
list
|str
List of scalars of labels. Must be the same length as points. If a string name is given with a
pyvista.DataSet
input for points, then these are fetched.- fmt
str
,optional
String formatter used to format numerical data.
- preamble
str
, default: “” Text before the start of each label.
- **kwargs
dict
,optional
Keyword arguments passed to
pyvista.Plotter.add_point_labels()
.
- pointssequence[
- Returns:
- vtkActor2D
VTK label actor. Can be used to change properties of the labels.