TextOverlay
===========

.. py:class:: ansys.stk.core.graphics.TextOverlay

   Bases: :py:class:`~ansys.stk.core.graphics.IScreenOverlay`, :py:class:`~ansys.stk.core.graphics.IOverlay`, :py:class:`~ansys.stk.core.graphics.IScreenOverlayContainer`

   A rectangular overlay that contains text.

.. py:currentmodule:: TextOverlay

Overview
--------

.. tab-set::

    .. tab-item:: Properties

        .. list-table::
            :header-rows: 0
            :widths: auto

            * - :py:attr:`~ansys.stk.core.graphics.TextOverlay.text`
              - Set the Text to be rendered to an overlay. Newline characters ('\n') will mark the start of the next line in the text.
            * - :py:attr:`~ansys.stk.core.graphics.TextOverlay.outline_color`
              - Get or set the text's outline color.
            * - :py:attr:`~ansys.stk.core.graphics.TextOverlay.font`
              - Get the graphics font used to style the text.



Import detail
-------------

.. code-block:: python

    from ansys.stk.core.graphics import TextOverlay


Property detail
---------------

.. py:property:: text
    :canonical: ansys.stk.core.graphics.TextOverlay.text
    :type: str

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

.. py:property:: outline_color
    :canonical: ansys.stk.core.graphics.TextOverlay.outline_color
    :type: Color

    Get or set the text's outline color.

.. py:property:: font
    :canonical: ansys.stk.core.graphics.TextOverlay.font
    :type: GraphicsFont

    Get the graphics font used to style the text.