.. _Channels:

================================================
Channels
================================================


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

The collection of channel objects in the document.




Properties
^^^^^^^^^^

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







Methods
^^^^^^^

+-----------------------------------------------+-----------------------------------------------------------------+
| :ref:`[]<Channels.[]>` readonly               | Get an element in the collection with the provided index.       |
+-----------------------------------------------+-----------------------------------------------------------------+
| :ref:`add<Channels.add>` readonly             | Adds an element.                                                |
+-----------------------------------------------+-----------------------------------------------------------------+
| :ref:`getByName<Channels.getByName>` readonly | Get the first element in the collection with the provided name. |
+-----------------------------------------------+-----------------------------------------------------------------+
| :ref:`removeAll<Channels.removeAll>` readonly | Deletes all elements.                                           |
+-----------------------------------------------+-----------------------------------------------------------------+






.. container:: hide

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

      Channels/parent.rst
      Channels/typename.rst
      Channels/length.rst
      
      

      Channels/add.rst
      Channels/removeAll.rst
      Channels/getByName.rst
      Channels/[].rst