.. _HistoryStates:

================================================
HistoryStates
================================================


Description
-----------

The history state objects associated with the document.




Properties
^^^^^^^^^^

+--------------------------------------------------+---------------------------------------+
| :ref:`length<HistoryStates.length>` readonly     | Number of elements in the collection. |
+--------------------------------------------------+---------------------------------------+
| :ref:`parent<HistoryStates.parent>` readonly     | The object's container.               |
+--------------------------------------------------+---------------------------------------+
| :ref:`typename<HistoryStates.typename>` readonly | The class name of the object.         |
+--------------------------------------------------+---------------------------------------+







Methods
^^^^^^^

+----------------------------------------------------+-----------------------------------------------------------------+
| :ref:`[]<HistoryStates.[]>` readonly               | Get an element in the collection with the provided index.       |
+----------------------------------------------------+-----------------------------------------------------------------+
| :ref:`getByName<HistoryStates.getByName>` readonly | Get the first element in the collection with the provided name. |
+----------------------------------------------------+-----------------------------------------------------------------+






.. container:: hide

   .. toctree::
      :hidden:
      :maxdepth: 1

      HistoryStates/parent.rst
      HistoryStates/typename.rst
      HistoryStates/length.rst
      
      

      HistoryStates/getByName.rst
      HistoryStates/[].rst