
##########
MarkupView
##########

.. js:class:: wv.Markup.MarkupView

   
   Index
   =====
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~wv.Markup.MarkupView.addMarkupItem`
   * :js:meth:`~wv.Markup.MarkupView.getCamera`
   * :js:meth:`~wv.Markup.MarkupView.getColorMap`
   * :js:meth:`~wv.Markup.MarkupView.getCuttingPlaneData`
   * :js:meth:`~wv.Markup.MarkupView.getDefaultVisibility`
   * :js:meth:`~wv.Markup.MarkupView.getExplodeMagnitude`
   * :js:meth:`~wv.Markup.MarkupView.getFaceVisibility`
   * :js:meth:`~wv.Markup.MarkupView.getLineVisibility`
   * :js:meth:`~wv.Markup.MarkupView.getMarkup`
   * :js:meth:`~wv.Markup.MarkupView.getName`
   * :js:meth:`~wv.Markup.MarkupView.getSheetId`
   * :js:meth:`~wv.Markup.MarkupView.getSnapshotImage`
   * :js:meth:`~wv.Markup.MarkupView.getUniqueId`
   * :js:meth:`~wv.Markup.MarkupView.getVisibilityExceptions`
   * :js:meth:`~wv.Markup.MarkupView.removeMarkup`
   * :js:meth:`~wv.Markup.MarkupView.setColorMap`
   * :js:meth:`~wv.Markup.MarkupView.setCuttingPlaneData`
   * :js:meth:`~wv.Markup.MarkupView.setDefaultVisibility`
   * :js:meth:`~wv.Markup.MarkupView.setExplodeMagnitude`
   * :js:meth:`~wv.Markup.MarkupView.setFaceVisibility`
   * :js:meth:`~wv.Markup.MarkupView.setLineVisibility`
   * :js:meth:`~wv.Markup.MarkupView.setName`
   * :js:meth:`~wv.Markup.MarkupView.setSnapshotImage`
   * :js:meth:`~wv.Markup.MarkupView.setVisibilityExceptions`
   * :js:meth:`~wv.Markup.MarkupView.toJson`
   
   



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

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


.. js:method:: wv.Markup.MarkupView.addMarkupItem

      .. rst-class:: sig-pretty-signature
      
         | addMarkupItem(**markupItem**\ : :js:class:`MarkupItem <wv.Markup.MarkupItem>`\ ): *void*
      
      Adds a markup item to this view
      
      **Parameters**
      
      
         **markupItem**\ : :js:class:`MarkupItem <wv.Markup.MarkupItem>`
      
      
            the markup to be added to this view.
      
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.Markup.MarkupView.getCamera

      .. rst-class:: sig-pretty-signature
      
         | getCamera(): :js:class:`Camera <wv.Camera>`
      
      Gets the camera of this view
      
      **Returns**\ : :js:class:`Camera <wv.Camera>`
      
      
         the camera of this view
      
      



.. js:method:: wv.Markup.MarkupView.getColorMap

      .. rst-class:: sig-pretty-signature
      
         | getColorMap(): *Map*
      
      **Returns**\ : *Map*
      
      
         A color map associating NodeIds to Colors.
      
      



.. js:method:: wv.Markup.MarkupView.getCuttingPlaneData

      .. rst-class:: sig-pretty-signature
      
         | getCuttingPlaneData(): *object*
      
      **Returns**\ : *object*
      
      
         a JSON object with the cutting plane data associated with this view
      
      



.. js:method:: wv.Markup.MarkupView.getDefaultVisibility

      .. rst-class:: sig-pretty-signature
      
         | getDefaultVisibility(): *boolean*
      
      **Returns**\ : *boolean*
      



.. js:method:: wv.Markup.MarkupView.getExplodeMagnitude

      .. rst-class:: sig-pretty-signature
      
         | getExplodeMagnitude(): *number*
      
      **Returns**\ : *number*
      
      
         the explode value associated with this view
      
      



.. js:method:: wv.Markup.MarkupView.getFaceVisibility

      .. rst-class:: sig-pretty-signature
      
         | getFaceVisibility(): *boolean*
      
      Gets face visibility setting for this view
      
      **Returns**\ : *boolean*
      
      
         face visibility setting for this view
      
      



.. js:method:: wv.Markup.MarkupView.getLineVisibility

      .. rst-class:: sig-pretty-signature
      
         | getLineVisibility(): *boolean*
      
      Gets line visibility setting for this view
      
      **Returns**\ : *boolean*
      
      
         line visibility setting for this view
      
      



.. js:method:: wv.Markup.MarkupView.getMarkup

      .. rst-class:: sig-pretty-signature
      
         | getMarkup(): :js:class:`MarkupItem <wv.Markup.MarkupItem>`\ []
      
      Gets an array of markup items associated with this view
      
      **Returns**\ : :js:class:`MarkupItem <wv.Markup.MarkupItem>`\ []
      
      
         face visibility setting for this view
      
      



.. js:method:: wv.Markup.MarkupView.getName

      .. rst-class:: sig-pretty-signature
      
         | getName(): *string*
      
      Gets the name of this view
      
      **Returns**\ : *string*
      
      
         name of this view
      
      



.. js:method:: wv.Markup.MarkupView.getSheetId

      .. rst-class:: sig-pretty-signature
      
         | getSheetId(): (*None* | *number*\ )
      
      Gets the sheet id for this view
      
      **Returns**\ : (*None* \| *number*\ )
      
      
         the id of the sheet for this view. If no view was active at the time of creation this function will return null.
      
      



.. js:method:: wv.Markup.MarkupView.getSnapshotImage

      .. rst-class:: sig-pretty-signature
      
         | getSnapshotImage(): (*None* | *HTMLImageElement*\ )
      
      **Returns**\ : (*None* \| *HTMLImageElement*\ )
      



.. js:method:: wv.Markup.MarkupView.getUniqueId

      .. rst-class:: sig-pretty-signature
      
         | getUniqueId(): *string*
      
      Gets the unique identifier of this view
      
      **Returns**\ : *string*
      
      
         unique identifier of this view
      
      



.. js:method:: wv.Markup.MarkupView.getVisibilityExceptions

      .. rst-class:: sig-pretty-signature
      
         | getVisibilityExceptions(): *Set*
      
      **Returns**\ : *Set*
      



.. js:method:: wv.Markup.MarkupView.removeMarkup

      .. rst-class:: sig-pretty-signature
      
         | removeMarkup(**item**\ : :js:class:`MarkupItem <wv.Markup.MarkupItem>`\ ): *boolean*
      
      Removes a markup item from the view
      
      **Parameters**
      
      
         **item**\ : :js:class:`MarkupItem <wv.Markup.MarkupItem>`
      
      
            the markup to be removed from this view.
      
      
      
      **Returns**\ : *boolean*
      
      
         result of the removal operation
      
      



.. js:method:: wv.Markup.MarkupView.setColorMap

      .. rst-class:: sig-pretty-signature
      
         | setColorMap(**colorMap**\ : *Map*\ ): *void*
      
      Takes a color map associating NodeIds to Colors and associates it with this view.
      
      **Parameters**
      
      
         **colorMap**\ : *Map*
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.Markup.MarkupView.setCuttingPlaneData

      .. rst-class:: sig-pretty-signature
      
         | setCuttingPlaneData(**cuttingPlaneData**\ : *object*\ ): *void*
      
      Takes a JSON cutting plane data object and associates it with this view
      
      **Parameters**
      
      
         **cuttingPlaneData**\ : *object*
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.Markup.MarkupView.setDefaultVisibility

      .. rst-class:: sig-pretty-signature
      
         | setDefaultVisibility(**defaultVisibility**\ : *boolean*\ ): *void*
      
      **Parameters**
      
      
         **defaultVisibility**\ : *boolean*
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.Markup.MarkupView.setExplodeMagnitude

      .. rst-class:: sig-pretty-signature
      
         | setExplodeMagnitude(**explodeMagnitude**\ : *number*\ ): *void*
      
      Takes an explode magnitude and associates it with this view
      
      **Parameters**
      
      
         **explodeMagnitude**\ : *number*
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.Markup.MarkupView.setFaceVisibility

      .. rst-class:: sig-pretty-signature
      
         | setFaceVisibility(**faceVisibility**\ : *boolean*\ ): *void*
      
      Sets face visibility for this view
      
      **Parameters**
      
      
         **faceVisibility**\ : *boolean*
      
      
            face visibility setting for this view
      
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.Markup.MarkupView.setLineVisibility

      .. rst-class:: sig-pretty-signature
      
         | setLineVisibility(**lineVisibility**\ : *boolean*\ ): *void*
      
      Sets line visibility for this view
      
      **Parameters**
      
      
         **lineVisibility**\ : *boolean*
      
      
            line visibility setting for this view
      
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.Markup.MarkupView.setName

      .. rst-class:: sig-pretty-signature
      
         | setName(**name**\ : *string*\ ): *void*
      
      Sets the name for this view
      
      **Parameters**
      
      
         **name**\ : *string*
      
      
            name to set
      
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.Markup.MarkupView.setSnapshotImage

      .. rst-class:: sig-pretty-signature
      
         | setSnapshotImage(**image**\ : *HTMLImageElement*\ ): *void*
      
      **Parameters**
      
      
         **image**\ : *HTMLImageElement*
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.Markup.MarkupView.setVisibilityExceptions

      .. rst-class:: sig-pretty-signature
      
         | setVisibilityExceptions(**nodeIds**\ : *Set*\ ): *void*
      
      **Parameters**
      
      
         **nodeIds**\ : *Set*
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.Markup.MarkupView.toJson

      .. rst-class:: sig-pretty-signature
      
         | toJson(): *object*
      
      Creates an object ready for JSON serialization.
      
      **Returns**\ : *object*
      
      
         The prepared object.
      
      




