.. _PathItems:

================================================
PathItems
================================================


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

The collection of path item objects in the document.




Properties
^^^^^^^^^^

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







Methods
^^^^^^^

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

Static Methods
^^^^^^^^^^^^^^

+------------------------------------+--------------------------+
| :ref:`add<PathItems.add>` readonly | Creates a new path item. |
+------------------------------------+--------------------------+




.. container:: hide

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

      PathItems/parent.rst
      PathItems/typename.rst
      PathItems/length.rst
      
      

      PathItems/getByName.rst
      PathItems/[].rst
      
      PathItems/add.rst