.. _ColorSampler:

================================================
ColorSampler
================================================


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

A color sampler in a document.




Properties
^^^^^^^^^^

+-------------------------------------------------+----------------------------------------------------+
| :ref:`color<ColorSampler.color>` readonly       | The color of the color sampler.                    |
+-------------------------------------------------+----------------------------------------------------+
| :ref:`parent<ColorSampler.parent>` readonly     | The object's container.                            |
+-------------------------------------------------+----------------------------------------------------+
| :ref:`position<ColorSampler.position>` readonly | The position of the color sampler in the document. |
+-------------------------------------------------+----------------------------------------------------+
| :ref:`typename<ColorSampler.typename>` readonly | The class name of the object.                      |
+-------------------------------------------------+----------------------------------------------------+







Methods
^^^^^^^

+---------------------------------------------------+--------------------------------------------+
| :ref:`add<ColorSampler.add>` readonly             | Adds an element.                           |
+---------------------------------------------------+--------------------------------------------+
| :ref:`move<ColorSampler.move>` readonly           | Moves the color sampler to a new location. |
+---------------------------------------------------+--------------------------------------------+
| :ref:`remove<ColorSampler.remove>` readonly       | Deletes this object.                       |
+---------------------------------------------------+--------------------------------------------+
| :ref:`removeAll<ColorSampler.removeAll>` readonly | Deletes all elements.                      |
+---------------------------------------------------+--------------------------------------------+






.. container:: hide

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

      ColorSampler/parent.rst
      ColorSampler/typename.rst
      ColorSampler/position.rst
      ColorSampler/color.rst
      
      

      ColorSampler/add.rst
      ColorSampler/remove.rst
      ColorSampler/removeAll.rst
      ColorSampler/move.rst