LevelAttribute
==============

.. py:class:: ansys.stk.core.stkobjects.LevelAttribute

   Properties defining display of contour levels.

.. py:currentmodule:: LevelAttribute

Overview
--------

.. tab-set::

    .. tab-item:: Properties

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

            * - :py:attr:`~ansys.stk.core.stkobjects.LevelAttribute.level`
              - Contour level.
            * - :py:attr:`~ansys.stk.core.stkobjects.LevelAttribute.color`
              - Color in which contours at the given level are displayed.
            * - :py:attr:`~ansys.stk.core.stkobjects.LevelAttribute.line_style`
              - The style of the line representing contours at the given level. A member of the LineStyle enumeration.
            * - :py:attr:`~ansys.stk.core.stkobjects.LevelAttribute.line_width`
              - The width of the line representing contours at the given level.
            * - :py:attr:`~ansys.stk.core.stkobjects.LevelAttribute.show_label`
              - Display a label identifying the given contour level.
            * - :py:attr:`~ansys.stk.core.stkobjects.LevelAttribute.show_user_text_visible`
              - Whether the user-specified text is displayed.
            * - :py:attr:`~ansys.stk.core.stkobjects.LevelAttribute.label_angle`
              - The angle from the contour at which the label is displayed. Dimensionless.
            * - :py:attr:`~ansys.stk.core.stkobjects.LevelAttribute.user_text`
              - User-specified text that can be displayed with the contour.



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

.. code-block:: python

    from ansys.stk.core.stkobjects import LevelAttribute


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

.. py:property:: level
    :canonical: ansys.stk.core.stkobjects.LevelAttribute.level
    :type: typing.Any

    Contour level.

.. py:property:: color
    :canonical: ansys.stk.core.stkobjects.LevelAttribute.color
    :type: Color

    Color in which contours at the given level are displayed.

.. py:property:: line_style
    :canonical: ansys.stk.core.stkobjects.LevelAttribute.line_style
    :type: LineStyle

    The style of the line representing contours at the given level. A member of the LineStyle enumeration.

.. py:property:: line_width
    :canonical: ansys.stk.core.stkobjects.LevelAttribute.line_width
    :type: LineWidth

    The width of the line representing contours at the given level.

.. py:property:: show_label
    :canonical: ansys.stk.core.stkobjects.LevelAttribute.show_label
    :type: bool

    Display a label identifying the given contour level.

.. py:property:: show_user_text_visible
    :canonical: ansys.stk.core.stkobjects.LevelAttribute.show_user_text_visible
    :type: bool

    Whether the user-specified text is displayed.

.. py:property:: label_angle
    :canonical: ansys.stk.core.stkobjects.LevelAttribute.label_angle
    :type: float

    The angle from the contour at which the label is displayed. Dimensionless.

.. py:property:: user_text
    :canonical: ansys.stk.core.stkobjects.LevelAttribute.user_text
    :type: str

    User-specified text that can be displayed with the contour.