ScenarioAnimationTimePeriod
===========================

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

   Configure the scenario's animation time.

.. py:currentmodule:: ScenarioAnimationTimePeriod

Overview
--------

.. tab-set::

    .. tab-item:: Properties

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

            * - :py:attr:`~ansys.stk.core.stkobjects.ScenarioAnimationTimePeriod.start_time`
              - Get the animation's start time. Uses DateFormat Dimension.
            * - :py:attr:`~ansys.stk.core.stkobjects.ScenarioAnimationTimePeriod.stop_time`
              - Get the animation's stop time. Uses DateFormat Dimension.
            * - :py:attr:`~ansys.stk.core.stkobjects.ScenarioAnimationTimePeriod.duration`
              - A time duration. The value is a relative duration (i.e. ``+1 day``, ``+1 hour``).
            * - :py:attr:`~ansys.stk.core.stkobjects.ScenarioAnimationTimePeriod.use_analysis_start_time`
              - Whether the animation start time is the same as the analysis's start time.
            * - :py:attr:`~ansys.stk.core.stkobjects.ScenarioAnimationTimePeriod.use_analysis_stop_time`
              - Whether the animation stop time is the same as the analysis's stop time.



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

.. code-block:: python

    from ansys.stk.core.stkobjects import ScenarioAnimationTimePeriod


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

.. py:property:: start_time
    :canonical: ansys.stk.core.stkobjects.ScenarioAnimationTimePeriod.start_time
    :type: TimePeriodValue

    Get the animation's start time. Uses DateFormat Dimension.

.. py:property:: stop_time
    :canonical: ansys.stk.core.stkobjects.ScenarioAnimationTimePeriod.stop_time
    :type: TimePeriodValue

    Get the animation's stop time. Uses DateFormat Dimension.

.. py:property:: duration
    :canonical: ansys.stk.core.stkobjects.ScenarioAnimationTimePeriod.duration
    :type: typing.Any

    A time duration. The value is a relative duration (i.e. ``+1 day``, ``+1 hour``).

.. py:property:: use_analysis_start_time
    :canonical: ansys.stk.core.stkobjects.ScenarioAnimationTimePeriod.use_analysis_start_time
    :type: bool

    Whether the animation start time is the same as the analysis's start time.

.. py:property:: use_analysis_stop_time
    :canonical: ansys.stk.core.stkobjects.ScenarioAnimationTimePeriod.use_analysis_stop_time
    :type: bool

    Whether the animation stop time is the same as the analysis's stop time.