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

.. js:class:: wv.SnapshotConfig

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



.. rst-class:: kind-group kind-constructors

.. rubric:: Constructors
   :class: kind-group-title


.. js:method:: wv.SnapshotConfig.constructor

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



.. rst-class:: kind-group kind-properties

.. rubric:: Properties
   :class: kind-group-title


.. js:data:: wv.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:: wv.SnapshotConfig.layers

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



.. js:data:: wv.SnapshotConfig.viewKey

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



.. js:data:: wv.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.
      




