.. role:: ts-api-decorator

#################################
ScalarMapperFilledContoursUniform
#################################

.. js:module:: cee
   :noindex:

.. container:: ts-api-section

   .. js:class:: ScalarMapperFilledContoursUniform

      Maps scalar values to texture coordinates/colors using a filled contours style color map with
      levels of uniform size.

      Configured by specifying the number of level colors (``colorArray``) and the range (``setRange``).

      To show a color legend in the view representing this mapper, use the ``Overlay.addCustomColorLegendForScalarMapper`` 
      function.



.. container:: api-index-section

   .. rubric:: Constructors

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

   * :js:meth:`~cee.ScalarMapperFilledContoursUniform.constructor`



.. container:: api-index-section

   .. rubric:: Accessors

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

   * :js:attr:`~cee.ScalarMapperFilledContoursUniform.aboveRangeColor`
   * :js:attr:`~cee.ScalarMapperFilledContoursUniform.belowRangeColor`
   * :js:attr:`~cee.ScalarMapperFilledContoursUniform.colorArray`
   * :js:attr:`~cee.ScalarMapperFilledContoursUniform.rangeMaximum`
   * :js:attr:`~cee.ScalarMapperFilledContoursUniform.rangeMinimum`
   * :js:attr:`~cee.ScalarMapperFilledContoursUniform.undefinedColor`



.. container:: api-index-section

   .. rubric:: Methods

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

   * :js:meth:`~cee.ScalarMapperFilledContoursUniform.createTexture`
   * :js:meth:`~cee.ScalarMapperFilledContoursUniform.domainValue`
   * :js:meth:`~cee.ScalarMapperFilledContoursUniform.mapToColor`
   * :js:meth:`~cee.ScalarMapperFilledContoursUniform.mapToTextureCoordinate`
   * :js:meth:`~cee.ScalarMapperFilledContoursUniform.normalizedValue`
   * :js:meth:`~cee.ScalarMapperFilledContoursUniform.setRange`
   * :js:meth:`~cee.ScalarMapperFilledContoursUniform.setRangeLogarithmic`
   * :js:meth:`~cee.ScalarMapperFilledContoursUniform.tickValuesHint`
   * :js:meth:`~cee.ScalarMapperFilledContoursUniform.version`





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

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

.. container:: ts-api-section

   .. js:function:: ScalarMapperFilledContoursUniform.constructor()



      :rtype: ScalarMapperFilledContoursUniform



Accessors
=========

.. container:: ts-api-section

   .. js:function:: ScalarMapperFilledContoursUniform.aboveRangeColor()



      The color to assign values that are above the given range.

      Default is undefined, which indicates that the last color in the color array will be used.


      :rtype: Color4Like

   .. js:function:: ScalarMapperFilledContoursUniform.aboveRangeColor( color)

      :param color: None
      :type color: Color4Like


      :rtype: void



.. container:: ts-api-section

   .. js:function:: ScalarMapperFilledContoursUniform.belowRangeColor()



      The color to assign values that are below the given range.

      Default is null, which indicates that the first color in the color array will be used.


      :rtype: Color4Like

   .. js:function:: ScalarMapperFilledContoursUniform.belowRangeColor( color)

      :param color: None
      :type color: Color4Like


      :rtype: void



.. container:: ts-api-section

   .. js:function:: ScalarMapperFilledContoursUniform.colorArray()



      The colors to use for the mapper.


      :rtype: ArrayLike <Color4Like>

   .. js:function:: ScalarMapperFilledContoursUniform.colorArray( colors)

      :param colors: None
      :type colors: ArrayLike <Color4Like>


      :rtype: void



.. container:: ts-api-section

   .. js:function:: ScalarMapperFilledContoursUniform.rangeMaximum()



      The maximum range of the mapper


      :rtype: number



.. container:: ts-api-section

   .. js:function:: ScalarMapperFilledContoursUniform.rangeMinimum()



      The minimum range of the mapper


      :rtype: number



.. container:: ts-api-section

   .. js:function:: ScalarMapperFilledContoursUniform.undefinedColor()



      The color used for undefined values.


      :rtype: Color4Like

   .. js:function:: ScalarMapperFilledContoursUniform.undefinedColor( color)

      :param color: None
      :type color: Color4Like


      :rtype: void



Methods
=======

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

createTexture
-------------

.. js:method:: ScalarMapperFilledContoursUniform.createTexture()



   Creates and returns texture for this scalar mapper


   :rtype: Texture

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

domainValue
-----------

.. js:method:: ScalarMapperFilledContoursUniform.domainValue( normalizedPosition)

   :param normalizedPosition: None
   :type normalizedPosition: number


   Map normalized value (0 -> 1) into a domain value (range_min -> range_max)


   :rtype: number

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

mapToColor
----------

.. js:method:: ScalarMapperFilledContoursUniform.mapToColor( scalarValue)

   :param scalarValue: None
   :type scalarValue: number


   Maps the given domain value to a color using the current range and color array.


   :rtype: Color4Like

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

mapToTextureCoordinate
----------------------

.. js:method:: ScalarMapperFilledContoursUniform.mapToTextureCoordinate( scalarValue)

   :param scalarValue: None
   :type scalarValue: number


   Maps the given domain value to a color using the current range and color array.


   :rtype: Vec2Like

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

normalizedValue
---------------

.. js:method:: ScalarMapperFilledContoursUniform.normalizedValue( domainValue)

   :param domainValue: None
   :type domainValue: number


   Map domain value (range_min -> range_max) into a normalized value (0 -> 1)


   :rtype: number

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

setRange
--------

.. js:method:: ScalarMapperFilledContoursUniform.setRange( min, max)

   :param min: None
   :type min: number
   :param max: None
   :type max: number


   Sets the range of the mapper. The mapper will map domain values to colors based on an 
   even distribution between the given min and max values.


   :rtype: void

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

setRangeLogarithmic
-------------------

.. js:method:: ScalarMapperFilledContoursUniform.setRangeLogarithmic( min, max)

   :param min: None
   :type min: number
   :param max: None
   :type max: number


   Sets a logarithmic range of the mapper.


   :rtype: void

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

tickValuesHint
--------------

.. js:method:: ScalarMapperFilledContoursUniform.tickValuesHint()



   Returns the suggest tick values (the values of the color changes)


   :rtype: ArrayLike <number>

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

version
-------

.. js:method:: ScalarMapperFilledContoursUniform.version()



   Returns the version of the scalar mapper. Version is increased whenever the mapper is changed.


   :rtype: number

