.. _ContactSheetOptions:

================================================
ContactSheetOptions
================================================


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

Options that can be specified for a contact sheet.






Static Properties
^^^^^^^^^^^^^^^^^

+--------------------------------------------------------------------+-------------------------------------------------------------------------+
| :ref:`acrossFirst<ContactSheetOptions.acrossFirst>` readonly       | If true, places the images horizontally first.                          |
+--------------------------------------------------------------------+-------------------------------------------------------------------------+
| :ref:`bestFit<ContactSheetOptions.bestFit>` readonly               | If true, rotates images for best fit.                                   |
+--------------------------------------------------------------------+-------------------------------------------------------------------------+
| :ref:`caption<ContactSheetOptions.caption>` readonly               | If true, uses the filename as a caption for the image.                  |
+--------------------------------------------------------------------+-------------------------------------------------------------------------+
| :ref:`columnCount<ContactSheetOptions.columnCount>` readonly       | The number of contact sheet columns.                                    |
+--------------------------------------------------------------------+-------------------------------------------------------------------------+
| :ref:`flatten<ContactSheetOptions.flatten>` readonly               | If true, flattens all layers in the final document.                     |
+--------------------------------------------------------------------+-------------------------------------------------------------------------+
| :ref:`font<ContactSheetOptions.font>` readonly                     | The font used for the caption.                                          |
+--------------------------------------------------------------------+-------------------------------------------------------------------------+
| :ref:`fontSize<ContactSheetOptions.fontSize>` readonly             | The caption font size.                                                  |
+--------------------------------------------------------------------+-------------------------------------------------------------------------+
| :ref:`height<ContactSheetOptions.height>` readonly                 | The height (in pixels) of the resulting document. Range: 100 to 2900.   |
+--------------------------------------------------------------------+-------------------------------------------------------------------------+
| :ref:`horizontal<ContactSheetOptions.horizontal>` readonly         | The horizontal spacing (in pixels) between images. Range: 0 to 29000.   |
+--------------------------------------------------------------------+-------------------------------------------------------------------------+
| :ref:`mode<ContactSheetOptions.mode>` readonly                     | The document color mode.                                                |
+--------------------------------------------------------------------+-------------------------------------------------------------------------+
| :ref:`resolution<ContactSheetOptions.resolution>` readonly         | The resolution of the document (in pixels per inch). Range: 35 to 1200. |
+--------------------------------------------------------------------+-------------------------------------------------------------------------+
| :ref:`rowCount<ContactSheetOptions.rowCount>` readonly             | The number of contact sheet rows.                                       |
+--------------------------------------------------------------------+-------------------------------------------------------------------------+
| :ref:`useAutoSpacing<ContactSheetOptions.useAutoSpacing>` readonly | If true, auto spaces the images in the contact sheet.                   |
+--------------------------------------------------------------------+-------------------------------------------------------------------------+
| :ref:`vertical<ContactSheetOptions.vertical>` readonly             | The vertical spacing (in pixels) between images. Range: 0 to 29000.     |
+--------------------------------------------------------------------+-------------------------------------------------------------------------+
| :ref:`width<ContactSheetOptions.width>` readonly                   | The width (in pixels) of the resulting document. Range: 100 to 2900.    |
+--------------------------------------------------------------------+-------------------------------------------------------------------------+












.. container:: hide

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

      
      ContactSheetOptions/width.rst
      ContactSheetOptions/height.rst
      ContactSheetOptions/resolution.rst
      ContactSheetOptions/mode.rst
      ContactSheetOptions/flatten.rst
      ContactSheetOptions/acrossFirst.rst
      ContactSheetOptions/useAutoSpacing.rst
      ContactSheetOptions/columnCount.rst
      ContactSheetOptions/rowCount.rst
      ContactSheetOptions/vertical.rst
      ContactSheetOptions/horizontal.rst
      ContactSheetOptions/bestFit.rst
      ContactSheetOptions/caption.rst
      ContactSheetOptions/font.rst
      ContactSheetOptions/fontSize.rst