.. _LayerSet:

================================================
LayerSet
================================================


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

A group of layer objects, which can include art layer objects and other (nested) layer set objects. A single command or set of commands manipulates all layers in a layer set object.




Properties
^^^^^^^^^^

+-----------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`artLayers<LayerSet.artLayers>` readonly             | The art layers contained in this layer set.                                            |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`enabledChannels<LayerSet.enabledChannels>` readonly | The channels that are enabled for the layer set. Must be a list of component channels. |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`layerSets<LayerSet.layerSets>` readonly             | The layer sets contained within the layer set.                                         |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`layers<LayerSet.layers>` readonly                   | The layers in this layer set.                                                          |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`parent<LayerSet.parent>` readonly                   | The object's container.                                                                |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`typename<LayerSet.typename>` readonly               | The class name of the object.                                                          |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------+







Methods
^^^^^^^

+---------------------------------------+-----------------------+
| :ref:`add<LayerSet.add>` readonly     | Adds an element.      |
+---------------------------------------+-----------------------+
| :ref:`merge<LayerSet.merge>` readonly | Merges the layer set. |
+---------------------------------------+-----------------------+






.. container:: hide

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

      LayerSet/parent.rst
      LayerSet/typename.rst
      LayerSet/enabledChannels.rst
      LayerSet/layers.rst
      LayerSet/layerSets.rst
      LayerSet/artLayers.rst
      
      

      LayerSet/add.rst
      LayerSet/merge.rst