
##############
MeasureManager
##############

.. js:class:: wv.MeasureManager

   This class provides an interface to measurement management related functions of the viewer.
   
   
   Index
   =====
   
   .. rubric:: Accessors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~wv.MeasureManager.viewer`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~wv.MeasureManager.addMeasurement`
   * :js:meth:`~wv.MeasureManager.exportMarkup`
   * :js:meth:`~wv.MeasureManager.finalizeMeasurement`
   * :js:meth:`~wv.MeasureManager.getAllMeasurements`
   * :js:meth:`~wv.MeasureManager.getMeasurementColor`
   * :js:meth:`~wv.MeasureManager.getMeasurementEdgeColor`
   * :js:meth:`~wv.MeasureManager.loadData`
   * :js:meth:`~wv.MeasureManager.removeAllMeasurements`
   * :js:meth:`~wv.MeasureManager.removeLastMeasurement`
   * :js:meth:`~wv.MeasureManager.removeMeasurement`
   * :js:meth:`~wv.MeasureManager.setMeasurementColor`
   * :js:meth:`~wv.MeasureManager.setMeasurementEdgeColor`
   
   



.. rst-class:: kind-group kind-accessors

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


.. js:method:: wv.MeasureManager.viewer

      .. rst-class:: sig-pretty-signature
      
         | *get* viewer(): :js:class:`IWebViewer <wv.IWebViewer>`
      
      **Returns**\ : :js:class:`IWebViewer <wv.IWebViewer>`
      



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

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


.. js:method:: wv.MeasureManager.addMeasurement

      .. rst-class:: sig-pretty-signature
      
         | addMeasurement(**measureItem**\ : :js:class:`MeasureMarkup <wv.Operators.Markup.Measure.MeasureMarkup>`\ ): *string*
      
      Adds a new Measurement to the Measure Manager
      
      **Parameters**
      
      
         **measureItem**\ : :js:class:`MeasureMarkup <wv.Operators.Markup.Measure.MeasureMarkup>`
      
      
            MeasureMarkup Object that will be added
      
      
      
      **Returns**\ : *string*
      



.. js:method:: wv.MeasureManager.exportMarkup

      .. rst-class:: sig-pretty-signature
      
         | exportMarkup(): *object*\ []
      
      **Returns**\ : *object*\ []
      
      
         JSON Array with measurement markup
      
      



.. js:method:: wv.MeasureManager.finalizeMeasurement

      .. rst-class:: sig-pretty-signature
      
         | finalizeMeasurement(**measureItem**\ : :js:class:`MeasureMarkup <wv.Operators.Markup.Measure.MeasureMarkup>`\ ): *void*
      
      Triggers a measurementCreated callback
      
      **Parameters**
      
      
         **measureItem**\ : :js:class:`MeasureMarkup <wv.Operators.Markup.Measure.MeasureMarkup>`
      
      
            measureItem passed to the callback
      
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.MeasureManager.getAllMeasurements

      .. rst-class:: sig-pretty-signature
      
         | getAllMeasurements(): :js:class:`MeasureMarkup <wv.Operators.Markup.Measure.MeasureMarkup>`\ []
      
      Return an array of measurement items.
      
      **Returns**\ : :js:class:`MeasureMarkup <wv.Operators.Markup.Measure.MeasureMarkup>`\ []
      
      
         array of all measurement items.
      
      



.. js:method:: wv.MeasureManager.getMeasurementColor

      .. rst-class:: sig-pretty-signature
      
         | getMeasurementColor(): :js:class:`Color <wv.Color>`
      
      Gets the current measurement color.
      
      **Returns**\ : :js:class:`Color <wv.Color>`
      
      
         color current measurement color.
      
      



.. js:method:: wv.MeasureManager.getMeasurementEdgeColor

      .. rst-class:: sig-pretty-signature
      
         | getMeasurementEdgeColor(): :js:class:`Color <wv.Color>`
      
      Gets the current measurement edge color.
      
      **Returns**\ : :js:class:`Color <wv.Color>`
      
      
         color current measurement edge color.
      
      



.. js:method:: wv.MeasureManager.loadData

      .. rst-class:: sig-pretty-signature
      
         | loadData(**measurementDataJson**\ : *any*\ []): *Promise*
      
      Loads JSON markup data
      
      **Parameters**
      
      
         **measurementDataJson**\ : *any*\ []
      
      
            Measurement Data object (JSON)
      
      
      
      **Returns**\ : *Promise*
      



.. js:method:: wv.MeasureManager.removeAllMeasurements

      .. rst-class:: sig-pretty-signature
      
         | removeAllMeasurements(): *void*
      
      Removes all measurement items.
      
      **Returns**\ : *void*
      



.. js:method:: wv.MeasureManager.removeLastMeasurement

      .. rst-class:: sig-pretty-signature
      
         | removeLastMeasurement(): *void*
      
      Removes the most recently added measurement item.
      
      **Returns**\ : *void*
      



.. js:method:: wv.MeasureManager.removeMeasurement

      .. rst-class:: sig-pretty-signature
      
         | removeMeasurement(**measureItem**\ : :js:class:`MeasureMarkup <wv.Operators.Markup.Measure.MeasureMarkup>`\ ): *void*
      
      Removes an existing measurement item.
      
      **Parameters**
      
      
         **measureItem**\ : :js:class:`MeasureMarkup <wv.Operators.Markup.Measure.MeasureMarkup>`
      
      
            the measurement item to remove.
      
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.MeasureManager.setMeasurementColor

      .. rst-class:: sig-pretty-signature
      
         | setMeasurementColor(**color**\ : :js:class:`Color <wv.Color>`\ ): *void*
      
      Sets the current measurement color.
      
      **Parameters**
      
      
         **color**\ : :js:class:`Color <wv.Color>`
      
      
            the measurement color to set.
      
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.MeasureManager.setMeasurementEdgeColor

      .. rst-class:: sig-pretty-signature
      
         | setMeasurementEdgeColor(**color**\ : :js:class:`Color <wv.Color>`\ ): *void*
      
      Sets the current measurement edge color.
      
      **Parameters**
      
      
         **color**\ : :js:class:`Color <wv.Color>`
      
      
            the measurement edge color to set.
      
      
      
      **Returns**\ : *void*
      




