.. _Guide:

================================================
Guide
================================================


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

A guide in the document.




Properties
^^^^^^^^^^

+----------------------------------------------+--------------------------------------------------------+
| :ref:`coordinate<Guide.coordinate>` readonly | Location of the guide from origin of image.            |
+----------------------------------------------+--------------------------------------------------------+
| :ref:`direction<Guide.direction>` readonly   | Indicates whether the guide is vertical or horizontal. |
+----------------------------------------------+--------------------------------------------------------+
| :ref:`parent<Guide.parent>` readonly         | The object's container.                                |
+----------------------------------------------+--------------------------------------------------------+
| :ref:`typename<Guide.typename>` readonly     | The class name of the object.                          |
+----------------------------------------------+--------------------------------------------------------+







Methods
^^^^^^^

+--------------------------------------------+-----------------------+
| :ref:`remove<Guide.remove>` readonly       | Deletes this object.  |
+--------------------------------------------+-----------------------+
| :ref:`removeAll<Guide.removeAll>` readonly | Deletes all elements. |
+--------------------------------------------+-----------------------+






.. container:: hide

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

      Guide/parent.rst
      Guide/typename.rst
      Guide/direction.rst
      Guide/coordinate.rst
      
      

      Guide/remove.rst
      Guide/removeAll.rst