.. role:: clio-inherited
   :class: clio-flag clio-flag-inherited


##########################
ScalarMapperFilledContours
##########################

.. js:class:: cee.ScalarMapperFilledContours

   Maps scalar values to texture coordinates/colors using a filled contours style color map with levels of uniform size.
   
   Configured by specifying the colors and their values with the method :js:meth:`setColorsAtValues <cee.ScalarMapperFilledContours.setColorsAtValues>`\ .
   
   To show a color legend in the view representing this mapper, use the :js:meth:`Overlay.addCustomColorLegendForScalarMapper <cee.Overlay.addCustomColorLegendForScalarMapper>` function.
   
   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~cee.ScalarMapperFilledContours.constructor`
   
   .. rubric:: Accessors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~cee.ScalarMapperFilledContours.aboveRangeColor`
   * :js:func:`~cee.ScalarMapperFilledContours.belowRangeColor`
   * :js:func:`~cee.ScalarMapperFilledContours.rangeMaximum`
   * :js:func:`~cee.ScalarMapperFilledContours.rangeMinimum`
   * :js:func:`~cee.ScalarMapperFilledContours.undefinedColor`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~cee.ScalarMapperFilledContours.createTexture`
   * :js:meth:`~cee.ScalarMapperFilledContours.domainValue`
   * :js:meth:`~cee.ScalarMapperFilledContours.mapToColor`
   * :js:meth:`~cee.ScalarMapperFilledContours.mapToTextureCoordinate`
   * :js:meth:`~cee.ScalarMapperFilledContours.normalizedValue`
   * :js:meth:`~cee.ScalarMapperFilledContours.setColorsAtValues`
   * :js:meth:`~cee.ScalarMapperFilledContours.tickValuesHint`
   * :js:meth:`~cee.ScalarMapperFilledContours.version`
   
   



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

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


.. js:method:: cee.ScalarMapperFilledContours.constructor

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



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

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


.. js:method:: cee.ScalarMapperFilledContours.aboveRangeColor

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | *get* aboveRangeColor(): :js:class:`Color4Like <cee.Color4Like>`
      
      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.
      
      **Returns**\ : :js:class:`Color4Like <cee.Color4Like>`
      
      .. rst-class:: sig-pretty-signature
      
         | *set* aboveRangeColor(**color**\ : :js:class:`Color4Like <cee.Color4Like>`\ ): *void*
      
      **Parameters**
      
      
         **color**\ : :js:class:`Color4Like <cee.Color4Like>`
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.ScalarMapperFilledContours.belowRangeColor

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | *get* belowRangeColor(): :js:class:`Color4Like <cee.Color4Like>`
      
      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.
      
      **Returns**\ : :js:class:`Color4Like <cee.Color4Like>`
      
      .. rst-class:: sig-pretty-signature
      
         | *set* belowRangeColor(**color**\ : :js:class:`Color4Like <cee.Color4Like>`\ ): *void*
      
      **Parameters**
      
      
         **color**\ : :js:class:`Color4Like <cee.Color4Like>`
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.ScalarMapperFilledContours.rangeMaximum

      .. rst-class:: sig-pretty-signature
      
         | *get* rangeMaximum(): *number*
      
      The maximum range of the mapper
      
      **Returns**\ : *number*
      



.. js:method:: cee.ScalarMapperFilledContours.rangeMinimum

      .. rst-class:: sig-pretty-signature
      
         | *get* rangeMinimum(): *number*
      
      The minimum range of the mapper
      
      **Returns**\ : *number*
      



.. js:method:: cee.ScalarMapperFilledContours.undefinedColor

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | *get* undefinedColor(): :js:class:`Color4Like <cee.Color4Like>`
      
      The color used for undefined values.
      
      **Returns**\ : :js:class:`Color4Like <cee.Color4Like>`
      
      .. rst-class:: sig-pretty-signature
      
         | *set* undefinedColor(**color**\ : :js:class:`Color4Like <cee.Color4Like>`\ ): *void*
      
      **Parameters**
      
      
         **color**\ : :js:class:`Color4Like <cee.Color4Like>`
      
      
      **Returns**\ : *void*
      



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

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


.. js:method:: cee.ScalarMapperFilledContours.createTexture

      .. rst-class:: sig-pretty-signature
      
         | createTexture(): :js:class:`Texture <cee.Texture>`
      
      Creates and returns texture for this scalar mapper
      
      **Returns**\ : :js:class:`Texture <cee.Texture>`
      



.. js:method:: cee.ScalarMapperFilledContours.domainValue

      .. rst-class:: sig-pretty-signature
      
         | domainValue(**normalizedPosition**\ : *number*\ ): *number*
      
      Map normalized value (0 -> 1) into a domain value (range_min -> range_max)
      
      **Parameters**
      
      
         **normalizedPosition**\ : *number*
      
      
      **Returns**\ : *number*
      



.. js:method:: cee.ScalarMapperFilledContours.mapToColor

      .. rst-class:: sig-pretty-signature
      
         | mapToColor(**scalarValue**\ : *number*\ ): :js:class:`Color4Like <cee.Color4Like>`
      
      Maps the given domain value to a color using the current range and color array.
      
      **Parameters**
      
      
         **scalarValue**\ : *number*
      
      
      **Returns**\ : :js:class:`Color4Like <cee.Color4Like>`
      



.. js:method:: cee.ScalarMapperFilledContours.mapToTextureCoordinate

      .. rst-class:: sig-pretty-signature
      
         | mapToTextureCoordinate(**scalarValue**\ : *number*\ ): :js:class:`Vec2Like <cee.Vec2Like>`
      
      Maps the given domain value to a color using the current range and color array.
      
      **Parameters**
      
      
         **scalarValue**\ : *number*
      
      
      **Returns**\ : :js:class:`Vec2Like <cee.Vec2Like>`
      



.. js:method:: cee.ScalarMapperFilledContours.normalizedValue

      .. rst-class:: sig-pretty-signature
      
         | normalizedValue(**domainValue**\ : *number*\ ): *number*
      
      Map domain value (range_min -> range_max) into a normalized value (0 -> 1)
      
      **Parameters**
      
      
         **domainValue**\ : *number*
      
      
      **Returns**\ : *number*
      



.. js:method:: cee.ScalarMapperFilledContours.setColorsAtValues

      .. rst-class:: sig-pretty-signature
      
         | setColorsAtValues(**colorArr**\ : *ArrayLike*\ , **valueArr**\ : *ArrayLike*\ ): *void*
      
      Sets the scalar mapper level colors from an array of colors at the given values
      
      **Parameters**
      
      
         **colorArr**\ : *ArrayLike*
      
         **valueArr**\ : *ArrayLike*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.ScalarMapperFilledContours.tickValuesHint

      .. rst-class:: sig-pretty-signature
      
         | tickValuesHint(): *ArrayLike*
      
      Returns the suggest tick values (the values of the color changes)
      
      **Returns**\ : *ArrayLike*
      



.. js:method:: cee.ScalarMapperFilledContours.version

      .. rst-class:: sig-pretty-signature
      
         | version(): *number*
      
      Returns the version of the scalar mapper. Version is increased whenever the mapper is changed.
      
      **Returns**\ : *number*
      




