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

.. js:class:: Markup.MarkupView

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




Methods
=======

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

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



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

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



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

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



.. js:method:: 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:: Markup.MarkupView.getDefaultVisibility

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



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

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



.. js:method:: 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:: 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:: Markup.MarkupView.getMarkup

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



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

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



.. js:method:: 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:: Markup.MarkupView.getSnapshotImage

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



.. js:method:: 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:: Markup.MarkupView.getVisibilityExceptions

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



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

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



.. js:method:: 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:: 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:: Markup.MarkupView.setDefaultVisibility

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



.. js:method:: 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:: 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:: 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:: 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:: Markup.MarkupView.setSnapshotImage

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



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

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



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

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





