add_point_labels

Plotter.add_point_labels(points, labels, italic=False, bold=True, font_size=None, text_color=None, font_family=None, shadow=False, show_points=True, point_color=None, point_size=5, name=None, shape_color='grey', shape='rounded_rect', fill_shape=True, margin=3, shape_opacity=1.0, pickable=False, render_points_as_spheres=False, tolerance=0.001, reset_camera=None, always_visible=False, render=True)

Create a point actor with one label from list labels assigned to each point.

Parameters

pointssequence or pyvista.DataSet

An n x 3 sequence points or pyvista dataset with points.

labelslist or str

List 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.

italicbool, optional

Italicises title and bar labels. Default False.

boldbool, optional

Bolds title and bar labels. Default True.

font_sizefloat, optional

Sets the size of the title font. Defaults to 16.

text_colorstr or 3 item list, optional

Color of text. Either a string, RGB sequence, or hex color string.

• text_color='white'

• text_color='w'

• text_color=[1, 1, 1]

• text_color='#FFFFFF'

font_familystr, optional

Font family. Must be either 'courier', 'times', or 'arial.

shadowbool, optional

Adds a black shadow to the text. Defaults to False.

show_pointsbool, optional

Controls if points are visible. Default True.

point_colorstr or sequence, optional

Either a string, rgb list, or hex color string. One of the following.

• point_color='white'

• point_color='w'

• point_color=[1, 1, 1]

• point_color='#FFFFFF'

point_sizefloat, optional

Size of points if visible.

namestr, optional

The name for the added actor so that it can be easily updated. If an actor of this name already exists in the rendering window, it will be replaced by the new actor.

shape_colorstr or sequence, optional

Color of points (if visible). Either a string, rgb sequence, or hex color string.

shapestr, optional

The string name of the shape to use. Options are 'rect' or 'rounded_rect'. If you want no shape, pass None.

fill_shapebool, optional

Fill the shape with the shape_color. Outlines if False.

marginint, optional

The size of the margin on the label background shape. Default is 3.

shape_opacityfloat, optional

The opacity of the shape in the range of [0, 1].

pickablebool, optional

Set whether this actor is pickable.

render_points_as_spheresbool, optional

Render points as spheres rather than dots.

tolerancefloat, optional

A tolerance to use to determine whether a point label is visible. A tolerance is usually required because the conversion from world space to display space during rendering introduces numerical round-off.

reset_camerabool, optional

Reset the camera after adding the points to the scene.

always_visiblebool, optional

Skip adding the visibility filter. Default False.

renderbool, optional

Force a render when True (default).

Returns

vtk.vtkActor2D

VTK label actor. Can be used to change properties of the labels.

Examples

>>> import numpy as np
>>> import pyvista
>>> pl = pyvista.Plotter()
>>> points = np.array([[0, 0, 0],
...                    [1, 1, 0],
...                    [2, 0, 0]])
>>> labels = ['Point A', 'Point B', 'Point C']
>>> actor = pl.add_point_labels(points, labels, italic=True, font_size=20,
...                             point_color='red', point_size=20, render_points_as_spheres=True,
...                             always_visible=True, shadow=True)
>>> pl.camera_position = 'xy'
>>> pl.show()