.. _LayerComp:

================================================
LayerComp
================================================


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

A snapshot of a state of the layers in a document (can be used to view different page layouts or compostions).




Properties
^^^^^^^^^^

+--------------------------------------------------+---------------------------------------------------------+
| :ref:`appearance<LayerComp.appearance>` readonly | If true, uses layer appearance (layer styles) settings. |
+--------------------------------------------------+---------------------------------------------------------+
| :ref:`comment<LayerComp.comment>` readonly       | The description of the layer comp.                      |
+--------------------------------------------------+---------------------------------------------------------+
| :ref:`name<LayerComp.name>` readonly             | The name of the layer comp.                             |
+--------------------------------------------------+---------------------------------------------------------+
| :ref:`parent<LayerComp.parent>` readonly         | The object's container.                                 |
+--------------------------------------------------+---------------------------------------------------------+
| :ref:`position<LayerComp.position>` readonly     | If true, uses layer position.                           |
+--------------------------------------------------+---------------------------------------------------------+
| :ref:`selected<LayerComp.selected>` readonly     | If true, the layer comp is currently selected.          |
+--------------------------------------------------+---------------------------------------------------------+
| :ref:`typename<LayerComp.typename>` readonly     | The class name of the object.                           |
+--------------------------------------------------+---------------------------------------------------------+
| :ref:`visibility<LayerComp.visibility>` readonly | If true, the layer comp is visible.                     |
+--------------------------------------------------+---------------------------------------------------------+







Methods
^^^^^^^

+--------------------------------------------------------+------------------------------------------------------------+
| :ref:`add<LayerComp.add>` readonly                     | Adds an element.                                           |
+--------------------------------------------------------+------------------------------------------------------------+
| :ref:`apply<LayerComp.apply>` readonly                 | Applies the layer comp to the document.                    |
+--------------------------------------------------------+------------------------------------------------------------+
| :ref:`recapture<LayerComp.recapture>` readonly         | Recaptures the current layer state(s) for this layer comp. |
+--------------------------------------------------------+------------------------------------------------------------+
| :ref:`remove<LayerComp.remove>` readonly               | Deletes this object.                                       |
+--------------------------------------------------------+------------------------------------------------------------+
| :ref:`removeAll<LayerComp.removeAll>` readonly         | Deletes all elements.                                      |
+--------------------------------------------------------+------------------------------------------------------------+
| :ref:`resetFromComp<LayerComp.resetFromComp>` readonly | Resets the layer comp state to the document state.         |
+--------------------------------------------------------+------------------------------------------------------------+






.. container:: hide

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

      LayerComp/parent.rst
      LayerComp/typename.rst
      LayerComp/name.rst
      LayerComp/comment.rst
      LayerComp/appearance.rst
      LayerComp/position.rst
      LayerComp/visibility.rst
      LayerComp/selected.rst
      
      

      LayerComp/add.rst
      LayerComp/remove.rst
      LayerComp/removeAll.rst
      LayerComp/apply.rst
      LayerComp/recapture.rst
      LayerComp/resetFromComp.rst