
############
SheetManager
############

.. js:class:: wv.SheetManager

   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~wv.SheetManager.constructor`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~wv.SheetManager.deactivateSheets`
   * :js:meth:`~wv.SheetManager.endComparison`
   * :js:meth:`~wv.SheetManager.get3DNodes`
   * :js:meth:`~wv.SheetManager.getActiveSheetId`
   * :js:meth:`~wv.SheetManager.getBackgroundSelectionEnabled`
   * :js:meth:`~wv.SheetManager.getBackgroundSheetEnabled`
   * :js:meth:`~wv.SheetManager.getSheetBackgroundColor`
   * :js:meth:`~wv.SheetManager.getSheetColor`
   * :js:meth:`~wv.SheetManager.getSheetIds`
   * :js:meth:`~wv.SheetManager.getSheetShadowColor`
   * :js:meth:`~wv.SheetManager.isDrawingSheetActive`
   * :js:meth:`~wv.SheetManager.setActiveSheetId`
   * :js:meth:`~wv.SheetManager.setBackgroundSelectionEnabled`
   * :js:meth:`~wv.SheetManager.setBackgroundSheetEnabled`
   * :js:meth:`~wv.SheetManager.setSheetColors`
   * :js:meth:`~wv.SheetManager.startComparison`
   
   



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

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


.. js:method:: wv.SheetManager.constructor

      .. rst-class:: sig-pretty-signature
      
         | SheetManager(**viewer**\ : :js:class:`IWebViewer <wv.IWebViewer>`\ , **engine**\ : :js:class:`IScEngine <wv.IScEngine>`\ , **callbackManager**\ : :js:class:`ICallbackManager <wv.ICallbackManager>`\ , **disableAutomaticBackgroundSheets**\ : *boolean*\ ): :js:class:`SheetManager <wv.SheetManager>`
      
      **Parameters**
      
      
         **viewer**\ : :js:class:`IWebViewer <wv.IWebViewer>`
      
         **engine**\ : :js:class:`IScEngine <wv.IScEngine>`
      
         **callbackManager**\ : :js:class:`ICallbackManager <wv.ICallbackManager>`
      
         **disableAutomaticBackgroundSheets**\ : *boolean*
      
      
      **Returns**\ : :js:class:`SheetManager <wv.SheetManager>`
      



.. rst-class:: kind-group kind-methods

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


.. js:method:: wv.SheetManager.deactivateSheets

      .. rst-class:: sig-pretty-signature
      
         | deactivateSheets(**triggerCallback**\ : *boolean*\ ?, **ignoreFitNodes**\ : *boolean*\ ?): *Promise*
      
      Deactivate sheets and only display 3D content
      
      **Parameters**
      
      
         **triggerCallback**\ : *boolean* = true
      
      
            triggers a "sheetDeactivated" callback if true
      
      
         **ignoreFitNodes**\ : *boolean* = false
      
      
            camera will not fit nodes if true
      
      
      
      **Returns**\ : *Promise*
      
      
         promise that resolves when the operation has completed
      
      



.. js:method:: wv.SheetManager.endComparison

      .. rst-class:: sig-pretty-signature
      
         | endComparison(): *Promise*
      
      Disables a visual comparison of two drawing sheets enabled by [[startSheetComparison]]. The ``Promise`` returned by that function should be waited upon before calling [[endSheetComparison]].
      
      **Returns**\ : *Promise*
      



.. js:method:: wv.SheetManager.get3DNodes

      .. rst-class:: sig-pretty-signature
      
         | get3DNodes(): *number*\ []
      
      Returns Ids of sheet nodes which contain 3D data.
      
      **Returns**\ : *number*\ []
      



.. js:method:: wv.SheetManager.getActiveSheetId

      .. rst-class:: sig-pretty-signature
      
         | getActiveSheetId(): (*None* | *number*\ )
      
      **Returns**\ : (*None* \| *number*\ )
      
      
         gets the id of the current active sheet. null if none has been set.
      
      



.. js:method:: wv.SheetManager.getBackgroundSelectionEnabled

      .. rst-class:: sig-pretty-signature
      
         | getBackgroundSelectionEnabled(): *boolean*
      
      Gets the current state of the background sheet.
      
      **Returns**\ : *boolean*
      
      
         ``true`` if enabled and ``false`` otherwise.
      
      



.. js:method:: wv.SheetManager.getBackgroundSheetEnabled

      .. rst-class:: sig-pretty-signature
      
         | getBackgroundSheetEnabled(): *boolean*
      
      Gets the current state of the background sheet.
      
      **Returns**\ : *boolean*
      
      
         ``true`` if enabled and ``false`` otherwise.
      
      



.. js:method:: wv.SheetManager.getSheetBackgroundColor

      .. rst-class:: sig-pretty-signature
      
         | getSheetBackgroundColor(): :js:class:`Color <wv.Color>`
      
      Gets the sheet Background Color.
      
      **Returns**\ : :js:class:`Color <wv.Color>`
      



.. js:method:: wv.SheetManager.getSheetColor

      .. rst-class:: sig-pretty-signature
      
         | getSheetColor(): :js:class:`Color <wv.Color>`
      
      Gets the Sheet Color.
      
      **Returns**\ : :js:class:`Color <wv.Color>`
      



.. js:method:: wv.SheetManager.getSheetIds

      .. rst-class:: sig-pretty-signature
      
         | getSheetIds(): *number*\ []
      
      **Returns**\ : *number*\ []
      
      
         an array of 2D [[SheetId]]s.
      
      



.. js:method:: wv.SheetManager.getSheetShadowColor

      .. rst-class:: sig-pretty-signature
      
         | getSheetShadowColor(): :js:class:`Color <wv.Color>`
      
      Gets the Sheet Shadow Color.
      
      **Returns**\ : :js:class:`Color <wv.Color>`
      



.. js:method:: wv.SheetManager.isDrawingSheetActive

      .. rst-class:: sig-pretty-signature
      
         | isDrawingSheetActive(): *boolean*
      
      **Returns**\ : *boolean*
      
      
         true if a drawing sheet is activated, false otherwise
      
      



.. js:method:: wv.SheetManager.setActiveSheetId

      .. rst-class:: sig-pretty-signature
      
         | setActiveSheetId(**activeSheetId**\ : *number*\ , **isolateNodes**\ : *boolean*\ ?, **fitNodes**\ : *boolean*\ ?): *Promise*
      
      Sets the id of the current active sheet
      
      **Parameters**
      
      
         **activeSheetId**\ : *number*
      
      
            id of the sheet which will be activated.
      
      
         **isolateNodes**\ : *boolean* = true
      
      
            indicates whether the nodes in the sheet should be isolated
      
      
         **fitNodes**\ : *boolean* = true
      
      
            indicates whether a fit world should be performed after isolating the nodes.  Note: This parameter has no effect if ``isolateNodes`` is ``false``\ .
      
      
      
      **Returns**\ : *Promise*
      
      
         promise that resolves when the operation has completed
      
      



.. js:method:: wv.SheetManager.setBackgroundSelectionEnabled

      .. rst-class:: sig-pretty-signature
      
         | setBackgroundSelectionEnabled(**enabled**\ : *boolean*\ ): *Promise*
      
      Sets whether the background for 2D drawings is selectable. By default it is not. 2D drawings have an invisible selection plane with a single face. Note that this setting is unaffected by the background-sheet enable setting.
      
      **Parameters**
      
      
         **enabled**\ : *boolean*
      
      
      **Returns**\ : *Promise*
      



.. js:method:: wv.SheetManager.setBackgroundSheetEnabled

      .. rst-class:: sig-pretty-signature
      
         | setBackgroundSheetEnabled(**enabled**\ : *boolean*\ ): *Promise*
      
      Enables or disables the background sheet used for 2D drawings.
      
      **Parameters**
      
      
         **enabled**\ : *boolean*
      
      
      **Returns**\ : *Promise*
      



.. js:method:: wv.SheetManager.setSheetColors

      .. rst-class:: sig-pretty-signature
      
         | setSheetColors(**backgroundColor**\ : :js:class:`Color <wv.Color>`\ , **sheetColor**\ : :js:class:`Color <wv.Color>`\ , **sheetShadowColor**\ : :js:class:`Color <wv.Color>`\ ): *Promise*
      
      Sets custom sheet colors.
      
      **Parameters**
      
      
         **backgroundColor**\ : :js:class:`Color <wv.Color>`
      
      
            viewer background color.
      
      
         **sheetColor**\ : :js:class:`Color <wv.Color>`
      
      
            sheet background color.
      
      
         **sheetShadowColor**\ : :js:class:`Color <wv.Color>`
      
      
            sheet shadow effect color.
      
      
      
      **Returns**\ : *Promise*
      



.. js:method:: wv.SheetManager.startComparison

      .. rst-class:: sig-pretty-signature
      
         | startComparison(**sheetId1**\ : *number*\ , **sheetId2**\ : *number*\ , **config**\ : :js:class:`ComparisonConfig <wv.ComparisonConfig>`\ ): *Promise*
      
      Enables a visual comparison of two drawing sheets. The nodes specified by ``sheetId1`` are filled with one color, the nodes specified by ``sheetId2`` with another color, and overlapping areas are filled with a third color.
      
      See [[endSheetComparison]], [[View.startComparison]].
      
      **Parameters**
      
      
         **sheetId1**\ : *number*
      
      
            the drawing sheet to compare against ``sheetId2``
      
      
         **sheetId2**\ : *number*
      
      
            the drawing sheet to compare against ``sheetId1``
      
      
         **config**\ : :js:class:`ComparisonConfig <wv.ComparisonConfig>`
      
      
            settings controlling the behavior of the comparison
      
      
      
      **Returns**\ : *Promise*
      




