
##############
ScalarSettings
##############

.. js:class:: cee.usg.ScalarSettings

   Setting for how a scalar should be shown in the model.
   
   You can get the settings for the scalar shown as fringes (filled contours) with the :js:func:`UnstructGridModel.fringesSettings <cee.usg.UnstructGridModel.fringesSettings>` property.
   
   Example using the ScalarMapperFilledContoursUniform:
   
   .. code-block:: javascript
   
      // Configure the mapper to use, and 
      const mapper = new cee.ScalarMapperFilledContoursUniform();
      mapper.colorArray = cee.ColorTableFactory.color4TableArray(cee.ColorTable.RAINBOW, 15);
      mapper.setRange(1,4);
      model.fringesSettings.scalarMapper = mapper;
      
      // Add a color legend based on the mapper
      this.m_view.overlay.addCustomColorLegendForScalarMapper(mapper, "Demo result", 1);
   
   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~cee.usg.ScalarSettings.constructor`
   
   .. rubric:: Accessors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~cee.usg.ScalarSettings.name`
   * :js:func:`~cee.usg.ScalarSettings.scalarMapper`
   
   



.. rst-class:: kind-group kind-constructors

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


.. js:method:: cee.usg.ScalarSettings.constructor

      .. rst-class:: sig-pretty-signature
      
         | ScalarSettings(): :js:class:`ScalarSettings <cee.usg.ScalarSettings>`
      
      **Returns**\ : :js:class:`ScalarSettings <cee.usg.ScalarSettings>`
      



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

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


.. js:method:: cee.usg.ScalarSettings.name

      .. rst-class:: sig-pretty-signature
      
         | *get* name(): *string*
      
      The name of the scalar result
      
      **Returns**\ : *string*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* name(**name**\ : *string*\ ): *void*
      
      **Parameters**
      
      
         **name**\ : *string*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.usg.ScalarSettings.scalarMapper

      .. rst-class:: sig-pretty-signature
      
         | *get* scalarMapper(): :js:class:`ScalarMapperContinuousDomain <cee.ScalarMapperContinuousDomain>`
      
      The scalar mapper to use to map from a scalar value to a color
      
      EnvisionWeb offers 4 different scalar mappers:
      
      
      - :js:class:`~cee.ScalarMapperFilledContours`
      - :js:class:`~cee.ScalarMapperFilledContoursUniform`
      - :js:class:`~cee.ScalarMapperContinuous`
      - :js:class:`~cee.ScalarMapperContinuousPiecewise`
      
      To add a color legend to a view to show the scalar mapper, use the :js:meth:`~cee.Overlay.addCustomColorLegendForScalarMapper` method (see example above).
      
      **Returns**\ : :js:class:`ScalarMapperContinuousDomain <cee.ScalarMapperContinuousDomain>`
      
      .. rst-class:: sig-pretty-signature
      
         | *set* scalarMapper(**scalarMapper**\ : :js:class:`ScalarMapperContinuousDomain <cee.ScalarMapperContinuousDomain>`\ ): *void*
      
      **Parameters**
      
      
         **scalarMapper**\ : :js:class:`ScalarMapperContinuousDomain <cee.ScalarMapperContinuousDomain>`
      
      
      **Returns**\ : *void*
      




