TextOverlay#

class ansys.stk.core.graphics.TextOverlay#

Bases: IScreenOverlay, IOverlay, IScreenOverlayContainer

A rectangular overlay that contains text.

Overview#

font

Get or set the graphics font used to style the text.

outline_color

Get or set the text’s outline color.

text

Get or set the text to be rendered to an overlay. Newline characters (’n’) will mark the start of the next line in the text.

Import detail#

from ansys.stk.core.graphics import TextOverlay

Property detail#

property TextOverlay.font: GraphicsFont#

Get or set the graphics font used to style the text.

property TextOverlay.outline_color: Color#

Get or set the text’s outline color.

property TextOverlay.text: str#

Get or set the text to be rendered to an overlay. Newline characters (’n’) will mark the start of the next line in the text.