.. role:: ts-api-decorator

##########
ResultInfo
##########

.. js:module:: cee.cug
   :noindex:

.. container:: ts-api-section

   .. js:class:: ResultInfo

      Information about a given result



.. container:: api-index-section

   .. rubric:: Accessors

   .. rst-class:: api-index-list-item api-kind-accessor api-parent-kind-class

   * :js:attr:`~cee.cug.ResultInfo.id`
   * :js:attr:`~cee.cug.ResultInfo.idString`
   * :js:attr:`~cee.cug.ResultInfo.mapping`
   * :js:attr:`~cee.cug.ResultInfo.maximumValue`
   * :js:attr:`~cee.cug.ResultInfo.minimumValue`
   * :js:attr:`~cee.cug.ResultInfo.name`
   * :js:attr:`~cee.cug.ResultInfo.resultType`
   * :js:attr:`~cee.cug.ResultInfo.unit`





------------

Accessors
=========

.. container:: ts-api-section

   .. js:function:: ResultInfo.id()



      The id of the result. Will be unique within each result type.


      :rtype: number



.. container:: ts-api-section

   .. js:function:: ResultInfo.idString()



      The persistent string id of the result.

      This is a persistent ID of the result that will not change between versions of EnvisionWeb, and can thus be used to store setting regarding results. 
      The id of the result might change in future versions of EnvisionWeb, and is only guaranteed to be constant in a given version.


      :rtype: string



.. container:: ts-api-section

   .. js:function:: ResultInfo.mapping()



      Result position (mapping) of the result


      :rtype: ResultMapping



.. container:: ts-api-section

   .. js:function:: ResultInfo.maximumValue()



      The maximum value (length for vectors or displacement) of the result


      :rtype: number



.. container:: ts-api-section

   .. js:function:: ResultInfo.minimumValue()



      The minimum value (length for vectors or displacement) of the result


      :rtype: number



.. container:: ts-api-section

   .. js:function:: ResultInfo.name()



      The name of the result.


      :rtype: string



.. container:: ts-api-section

   .. js:function:: ResultInfo.resultType()



      The type of result (scalar, vector, displacement)


      :rtype: ResultType



.. container:: ts-api-section

   .. js:function:: ResultInfo.unit()



      The unit of the results (if available).


      :rtype: string



