
##############
SnapshotConfig
##############

.. js:class:: SnapshotConfig

   This class contains configuration properties for creating viewer snapshots.
   
   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~SnapshotConfig.constructor`
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~SnapshotConfig.height`
   * :js:data:`~SnapshotConfig.layers`
   * :js:data:`~SnapshotConfig.viewKey`
   * :js:data:`~SnapshotConfig.width`
   
   




Constructors
============

.. js:method:: SnapshotConfig.constructor

   .. rst-class:: sig-pretty-signature
   
      | SnapshotConfig(**width**\ : *number*\ ?, **height**\ : *number*\ ?, **layers**\ : :js:data:`~SnapshotLayer`\ ?, **viewKey**\ : :js:data:`ViewKey <Sc.ViewKey>`\ ?): :js:class:`~SnapshotConfig`
   
   Creates a new SnapshotConfig object.
   
   **Parameters**
   
      **width**\ : *number* = 0
   
      **height**\ : *number* = 0
   
      **layers**\ : :js:data:`~SnapshotLayer` = SnapshotLayer.All
   
      **viewKey**\ : :js:data:`ViewKey <Sc.ViewKey>` = ViewKey.Default
   
   
   **Returns**\ : :js:class:`~SnapshotConfig`
   





Properties
==========

.. js:data:: SnapshotConfig.height

   .. rst-class:: sig-pretty-signature
   
      | height: *number*
   
   Specifies the width of the resulting snapshot image. A value of 0 indicates the canvas width should be used. The default value is 0.
   



.. js:data:: SnapshotConfig.layers

   .. rst-class:: sig-pretty-signature
   
      | layers: :js:data:`~SnapshotLayer`
   
   Indicates which layers to include in the snapshot. The default value is [[SnapshotLayer.All]].
   



.. js:data:: SnapshotConfig.viewKey

   .. rst-class:: sig-pretty-signature
   
      | viewKey: :js:data:`ViewKey <Sc.ViewKey>`
   
   Specifies which view the screenshot will be of. the default value is 0.
   



.. js:data:: SnapshotConfig.width

   .. rst-class:: sig-pretty-signature
   
      | width: *number*
   
   Specifies the width of the resulting snapshot image. A value of 0 indicates the canvas width should be used. The default value is 0.
   





