CornerAnnotation

class CornerAnnotation(*args, **kwargs)

Text annotation in four corners.

This is an annotation object that manages four text actors / mappers to provide annotation in the four corners of a viewport.

Parameters:

positionstr | bool | int

Position of the text. Either the name of a corner, True for the upper left one, or the index of a corner.

textstr

Text input.

proppyvista.TextProperty, optional

Text property.

linear_font_scale_factorfloat, optional

Linear font scale factor.

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 text annotation in four corners.

>>> import pyvista as pv
>>> text = pv.CornerAnnotation(0, 'text')
>>> prop = text.prop

Inheritance

Inherited members are documented on _NameMixin.

See them all under Inherited Attributes.

Wraps vtkCornerAnnotation.

Attributes

CornerAnnotation.linear_font_scale_factor	Font scaling factors.
CornerAnnotation.prop	Property of this actor.

Inherited Attributes

_NameMixin.name

Get or set the unique name identifier used by PyVista.

Methods

CornerAnnotation.get_text(position)	Get the text to be displayed for each corner.
CornerAnnotation.set_text(position, text)	Set the text to be displayed for each corner.