.. role:: ts-api-decorator

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

.. container:: ts-api-section

   .. js:class:: SnapshotConfig

      This class contains configuration properties for creating viewer snapshots.



.. container:: api-index-section

   .. rubric:: Constructors

   .. rst-class:: api-index-list-item api-kind-constructor api-parent-kind-class

   * :js:meth:`~SnapshotConfig.constructor`



.. container:: api-index-section

   .. rubric:: Properties

   .. rst-class:: api-index-list-item api-kind-property api-parent-kind-class

   * :js:attr:`~SnapshotConfig.height`
   * :js:attr:`~SnapshotConfig.layers`
   * :js:attr:`~SnapshotConfig.viewKey`
   * :js:attr:`~SnapshotConfig.width`





------------

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

.. container:: ts-api-section

   .. js:function:: SnapshotConfig.constructor( width, height, layers, viewKey)

      :param width: None
      :type width: number
      :param height: None
      :type height: number
      :param layers: None
      :type layers: SnapshotLayer
      :param viewKey: None
      :type viewKey: ViewKey


      Creates a new SnapshotConfig object.


      :rtype: SnapshotConfig



Properties
==========

.. container:: ts-api-section

   .. js:attribute:: SnapshotConfig.height

      :type: 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.



.. container:: ts-api-section

   .. js:attribute:: SnapshotConfig.layers

      :type: SnapshotLayer

      Indicates which layers to include in the snapshot.
      The default value is [[SnapshotLayer.All]].



.. container:: ts-api-section

   .. js:attribute:: SnapshotConfig.viewKey

      :type: ViewKey

      Specifies which view the screenshot will be of.
      the default value is 0.



.. container:: ts-api-section

   .. js:attribute:: SnapshotConfig.width

      :type: 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.



