TextOverlay

class ansys.stk.core.graphics.TextOverlay

Bases: IScreenOverlay, IOverlay, IScreenOverlayContainer

A rectangular overlay that contains text.

Overview

Properties

text	Set the Text to be rendered to an overlay. Newline characters (’n’) will mark the start of the next line in the text.
outline_color	Get or set the text’s outline color.
font	Get the graphics font used to style the text.

Import detail

from ansys.stk.core.graphics import TextOverlay

Property detail

property TextOverlay.text: str

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

property TextOverlay.outline_color: Color

Get or set the text’s outline color.

property TextOverlay.font: GraphicsFont

Get the graphics font used to style the text.