LabelNote
=========

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

   Class defining label notes.

.. py:currentmodule:: LabelNote

Overview
--------

.. tab-set::

    .. tab-item:: Properties

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

            * - :py:attr:`~ansys.stk.core.stkobjects.LabelNote.note`
              - Note property.
            * - :py:attr:`~ansys.stk.core.stkobjects.LabelNote.show_note`
              - Property specifying when the note is displayed. A member of the NoteShowType enumeration.
            * - :py:attr:`~ansys.stk.core.stkobjects.LabelNote.show_label`
              - Property specifying whether the label is displayed.
            * - :py:attr:`~ansys.stk.core.stkobjects.LabelNote.intervals`
              - Intervals during which the note is displayed. This property is used if the corresponding value is selected for the NoteVisible property.



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

.. code-block:: python

    from ansys.stk.core.stkobjects import LabelNote


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

.. py:property:: note
    :canonical: ansys.stk.core.stkobjects.LabelNote.note
    :type: str

    Note property.

.. py:property:: show_note
    :canonical: ansys.stk.core.stkobjects.LabelNote.show_note
    :type: NoteShowType

    Property specifying when the note is displayed. A member of the NoteShowType enumeration.

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

    Property specifying whether the label is displayed.

.. py:property:: intervals
    :canonical: ansys.stk.core.stkobjects.LabelNote.intervals
    :type: TimeIntervalCollection

    Intervals during which the note is displayed. This property is used if the corresponding value is selected for the NoteVisible property.