
##################################
OverlayColorLegendContinuousDomain
##################################

.. js:class:: cee.OverlayColorLegendContinuousDomain

   Color legend for all continuous domain scalar mappers.
   
   The OverlayColorLegendContinuousDomain is capable of visualizing all scalar mappers that derives from the ScalarMapperContinuousDomain.
   
   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~cee.OverlayColorLegendContinuousDomain.constructor`
   
   .. rubric:: Accessors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~cee.OverlayColorLegendContinuousDomain.drawTickMarksOnTopOfLegendBar`
   * :js:func:`~cee.OverlayColorLegendContinuousDomain.forceUniformTickMarkSpacing`
   * :js:func:`~cee.OverlayColorLegendContinuousDomain.lineColor`
   * :js:func:`~cee.OverlayColorLegendContinuousDomain.showTickMarkLabels`
   * :js:func:`~cee.OverlayColorLegendContinuousDomain.textColor`
   * :js:func:`~cee.OverlayColorLegendContinuousDomain.title`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~cee.OverlayColorLegendContinuousDomain.clearCustomLabels`
   * :js:meth:`~cee.OverlayColorLegendContinuousDomain.setCustomLabels`
   * :js:meth:`~cee.OverlayColorLegendContinuousDomain.setTickValues`
   * :js:meth:`~cee.OverlayColorLegendContinuousDomain.setupFromScalarMapper`
   
   



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

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


.. js:method:: cee.OverlayColorLegendContinuousDomain.constructor

      .. rst-class:: sig-pretty-signature
      
         | OverlayColorLegendContinuousDomain(**resultId**\ : *number*\ ): :js:class:`OverlayColorLegendContinuousDomain <cee.OverlayColorLegendContinuousDomain>`
      
      **Parameters**
      
      
         **resultId**\ : *number*
      
      
      **Returns**\ : :js:class:`OverlayColorLegendContinuousDomain <cee.OverlayColorLegendContinuousDomain>`
      



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

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


.. js:method:: cee.OverlayColorLegendContinuousDomain.drawTickMarksOnTopOfLegendBar

      .. rst-class:: sig-pretty-signature
      
         | *get* drawTickMarksOnTopOfLegendBar(): *boolean*
      
      Specify if the tick mark lines should be drawn on top of the color legend or just on the side of it.
      
      **Returns**\ : *boolean*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* drawTickMarksOnTopOfLegendBar(**drawOnTop**\ : *boolean*\ ): *void*
      
      **Parameters**
      
      
         **drawOnTop**\ : *boolean*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.OverlayColorLegendContinuousDomain.forceUniformTickMarkSpacing

      .. rst-class:: sig-pretty-signature
      
         | *get* forceUniformTickMarkSpacing(): *boolean*
      
      Sets that all tick marks should be evenly distributed in the color legend, despite the uneven size of each level.
      
      The default value is true, which will render a color legend where all the levels have the same size or all the continuous custom tick marks with even spacing.
      
      **Returns**\ : *boolean*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* forceUniformTickMarkSpacing(**force**\ : *boolean*\ ): *void*
      
      **Parameters**
      
      
         **force**\ : *boolean*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.OverlayColorLegendContinuousDomain.lineColor

      .. rst-class:: sig-pretty-signature
      
         | *get* lineColor(): :js:class:`Color3Like <cee.Color3Like>`
      
      The color of the border and tick marks
      
      **Returns**\ : :js:class:`Color3Like <cee.Color3Like>`
      
      .. rst-class:: sig-pretty-signature
      
         | *set* lineColor(**color**\ : :js:class:`Color3Like <cee.Color3Like>`\ ): *void*
      
      **Parameters**
      
      
         **color**\ : :js:class:`Color3Like <cee.Color3Like>`
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.OverlayColorLegendContinuousDomain.showTickMarkLabels

      .. rst-class:: sig-pretty-signature
      
         | *get* showTickMarkLabels(): *boolean*
      
      Specifies if the tick mark labels (usually the number values) should be shown together with the tick mark lines.
      
      **Returns**\ : *boolean*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* showTickMarkLabels(**show**\ : *boolean*\ ): *void*
      
      **Parameters**
      
      
         **show**\ : *boolean*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.OverlayColorLegendContinuousDomain.textColor

      .. rst-class:: sig-pretty-signature
      
         | *get* textColor(): :js:class:`Color3Like <cee.Color3Like>`
      
      The color of the legend text
      
      **Returns**\ : :js:class:`Color3Like <cee.Color3Like>`
      
      .. rst-class:: sig-pretty-signature
      
         | *set* textColor(**color**\ : :js:class:`Color3Like <cee.Color3Like>`\ ): *void*
      
      **Parameters**
      
      
         **color**\ : :js:class:`Color3Like <cee.Color3Like>`
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.OverlayColorLegendContinuousDomain.title

      .. rst-class:: sig-pretty-signature
      
         | *get* title(): *string*
      
      The title of the color legend.
      
      The legend supports multi-line titles. Separate each line with a '\n' character
      
      **Returns**\ : *string*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* title(**title**\ : *string*\ ): *void*
      
      **Parameters**
      
      
         **title**\ : *string*
      
      
      **Returns**\ : *void*
      



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

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


.. js:method:: cee.OverlayColorLegendContinuousDomain.clearCustomLabels

      .. rst-class:: sig-pretty-signature
      
         | clearCustomLabels(): *void*
      
      Clear the custom labels
      
      **Returns**\ : *void*
      



.. js:method:: cee.OverlayColorLegendContinuousDomain.setCustomLabels

      .. rst-class:: sig-pretty-signature
      
         | setCustomLabels(**labels**\ : *string*\ [], **relativePositions**\ : *number*\ []): *void*
      
      Set custom labels that will be drawn at the given relative position on the color legend
      
      **Parameters**
      
      
         **labels**\ : *string*\ []
      
         **relativePositions**\ : *number*\ []
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.OverlayColorLegendContinuousDomain.setTickValues

      .. rst-class:: sig-pretty-signature
      
         | setTickValues(**values**\ : *ArrayLike*\ , **scalarMapper**\ : :js:class:`ScalarMapperContinuousDomain <cee.ScalarMapperContinuousDomain>`\ ): *void*
      
      Specify custom tick marks to use
      
      setupFromScalarMapper will setup default tick marks. Use this method to override this and use custom tick mark values.
      
      **Parameters**
      
      
         **values**\ : *ArrayLike*
      
         **scalarMapper**\ : :js:class:`ScalarMapperContinuousDomain <cee.ScalarMapperContinuousDomain>`
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.OverlayColorLegendContinuousDomain.setupFromScalarMapper

      .. rst-class:: sig-pretty-signature
      
         | setupFromScalarMapper(**scalarMapper**\ : :js:class:`ScalarMapperContinuousDomain <cee.ScalarMapperContinuousDomain>`\ ): *void*
      
      Configure the color legend from the given scalar mapper
      
      **Parameters**
      
      
         **scalarMapper**\ : :js:class:`ScalarMapperContinuousDomain <cee.ScalarMapperContinuousDomain>`
      
      
      **Returns**\ : *void*
      




