Text

Text#

class Text(*args, **kwargs)[source]#

Define text by default theme.

Parameters:
textstr, optional

Text string to be displayed. \n is recognized as a carriage return/linefeed (line separator). The characters must be in the UTF-8 encoding.

positionSequence[float], optional

The position coordinate.

proppyvista.TextProperty, optional

The property of this actor.

namestr, optional

The name of this actor used when tracking on a plotter.

Added in version 0.45.

Examples#

Download Python source code | Download Jupyter notebook

Create a text with text’s property.

>>> import pyvista as pv
>>> text = pv.Text()
>>> prop = text.prop

Inheritance#

Inherited members are documented on _NameMixin.

See them all under Inherited Attributes.

Wraps vtkTextActor.

Attributes#

Text.input

Text string to be displayed.

Text.position

Position coordinate.

Text.prop

Property of this actor.

Inherited Attributes#

_NameMixin.name

Get or set the unique name identifier used by PyVista.