.. _PathPoints:

================================================
PathPoints
================================================


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

A collection of path point objects that comprises the path points property of the sub path item object.




Properties
^^^^^^^^^^

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







Methods
^^^^^^^

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






.. container:: hide

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

      PathPoints/parent.rst
      PathPoints/typename.rst
      PathPoints/length.rst
      
      

      PathPoints/getByName.rst
      PathPoints/[].rst