.. role:: ts-api-decorator

###########
PartScalars
###########

.. js:module:: cee.usg
   :noindex:

.. container:: ts-api-section

   .. js:class:: PartScalars

      Scalar results for one part in one state.

      The results can be mapped to the mesh as per node, per elements or per element node results.

      The PartScalars class is immutable.



.. container:: api-index-section

   .. rubric:: Constructors

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

   * :js:meth:`~cee.usg.PartScalars.constructor`



.. container:: api-index-section

   .. rubric:: Accessors

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

   * :js:attr:`~cee.usg.PartScalars.resultMapping`
   * :js:attr:`~cee.usg.PartScalars.valueArray`



.. container:: api-index-section

   .. rubric:: Methods

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

   * :js:meth:`~cee.usg.PartScalars.getValueRange`





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

Constructors
============

.. container:: ts-api-section

   .. js:function:: PartScalars.constructor( resultMapping, valueArray)

      :param resultMapping: None
      :type resultMapping: ResultMapping
      :param valueArray: None
      :type valueArray: ArrayLike <number>


      Create a scalar result for a part/mesh with the given mapping and values.

      Note: There is some performance penalty for visualizing per element or per element node results, 
      as the vertices needs to be duplicated in order to produce the WebGL based visualization. This
      will result in higher GPU and CPU memory usage.


      :rtype: PartScalars



Accessors
=========

.. container:: ts-api-section

   .. js:function:: PartScalars.resultMapping()



      The result mapping of this object


      :rtype: ResultMapping



.. container:: ts-api-section

   .. js:function:: PartScalars.valueArray()



      A readonly array with the scalar results


      :rtype: ArrayLike <number>



Methods
=======

.. rst-class:: ts-api-section

getValueRange
-------------

.. js:method:: PartScalars.getValueRange()



   The range (min/max) if the ``valueArray``


   :rtype: Range

