.. role:: ts-api-decorator

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

.. js:module:: cee
   :noindex:

.. container:: ts-api-section

   .. js:class:: OverlayColorLegendContinuousDomain

      Color legend for all continuous domain scalar mappers.

      The OverlayColorLegendContinuousDomain is capable of visualizing all scalar mappers that
      derives from the ScalarMapperContinuousDomain.



.. container:: api-index-section

   .. rubric:: Constructors

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

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



.. container:: api-index-section

   .. rubric:: Accessors

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

   * :js:attr:`~cee.OverlayColorLegendContinuousDomain.drawTickMarksOnTopOfLegendBar`
   * :js:attr:`~cee.OverlayColorLegendContinuousDomain.forceUniformTickMarkSpacing`
   * :js:attr:`~cee.OverlayColorLegendContinuousDomain.lineColor`
   * :js:attr:`~cee.OverlayColorLegendContinuousDomain.showTickMarkLabels`
   * :js:attr:`~cee.OverlayColorLegendContinuousDomain.textColor`
   * :js:attr:`~cee.OverlayColorLegendContinuousDomain.title`



.. container:: api-index-section

   .. rubric:: Methods

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

   * :js:meth:`~cee.OverlayColorLegendContinuousDomain.clearCustomLabels`
   * :js:meth:`~cee.OverlayColorLegendContinuousDomain.setCustomLabels`
   * :js:meth:`~cee.OverlayColorLegendContinuousDomain.setTickValues`
   * :js:meth:`~cee.OverlayColorLegendContinuousDomain.setupFromScalarMapper`





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

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

.. container:: ts-api-section

   .. js:function:: OverlayColorLegendContinuousDomain.constructor( resultId)

      :param resultId: None
      :type resultId: number


      :rtype: OverlayColorLegendContinuousDomain



Accessors
=========

.. container:: ts-api-section

   .. js:function:: OverlayColorLegendContinuousDomain.drawTickMarksOnTopOfLegendBar()



      Specify if the tick mark lines should be drawn on top of the color legend or just on the side of it.


      :rtype: boolean

   .. js:function:: OverlayColorLegendContinuousDomain.drawTickMarksOnTopOfLegendBar( drawOnTop)

      :param drawOnTop: None
      :type drawOnTop: boolean


      :rtype: void



.. container:: ts-api-section

   .. js:function:: OverlayColorLegendContinuousDomain.forceUniformTickMarkSpacing()



      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.


      :rtype: boolean

   .. js:function:: OverlayColorLegendContinuousDomain.forceUniformTickMarkSpacing( force)

      :param force: None
      :type force: boolean


      :rtype: void



.. container:: ts-api-section

   .. js:function:: OverlayColorLegendContinuousDomain.lineColor()



      The color of the border and tick marks


      :rtype: Color3Like

   .. js:function:: OverlayColorLegendContinuousDomain.lineColor( color)

      :param color: None
      :type color: Color3Like


      :rtype: void



.. container:: ts-api-section

   .. js:function:: OverlayColorLegendContinuousDomain.showTickMarkLabels()



      Specifies if the tick mark labels (usually the number values) should be shown together with
      the tick mark lines.


      :rtype: boolean

   .. js:function:: OverlayColorLegendContinuousDomain.showTickMarkLabels( show)

      :param show: None
      :type show: boolean


      :rtype: void



.. container:: ts-api-section

   .. js:function:: OverlayColorLegendContinuousDomain.textColor()



      The color of the legend text


      :rtype: Color3Like

   .. js:function:: OverlayColorLegendContinuousDomain.textColor( color)

      :param color: None
      :type color: Color3Like


      :rtype: void



.. container:: ts-api-section

   .. js:function:: OverlayColorLegendContinuousDomain.title()



      The title of the color legend. 

      The legend supports multi-line titles. Separate each line with a '\\n' character


      :rtype: string

   .. js:function:: OverlayColorLegendContinuousDomain.title( title)

      :param title: None
      :type title: string


      :rtype: void



Methods
=======

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

clearCustomLabels
-----------------

.. js:method:: OverlayColorLegendContinuousDomain.clearCustomLabels()



   Clear the custom labels


   :rtype: void

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

setCustomLabels
---------------

.. js:method:: OverlayColorLegendContinuousDomain.setCustomLabels( labels, relativePositions)

   :param labels: None
   :type labels: [string]
   :param relativePositions: None
   :type relativePositions: [number]


   Set custom labels that will be drawn at the given relative position on the color legend


   :rtype: void

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

setTickValues
-------------

.. js:method:: OverlayColorLegendContinuousDomain.setTickValues( values, scalarMapper)

   :param values: None
   :type values: ArrayLike <number>
   :param scalarMapper: None
   :type scalarMapper: ScalarMapperContinuousDomain


   Specify custom tick marks to use

   setupFromScalarMapper will setup default tick marks. Use this method to override this and use
   custom tick mark values.


   :rtype: void

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

setupFromScalarMapper
---------------------

.. js:method:: OverlayColorLegendContinuousDomain.setupFromScalarMapper( scalarMapper)

   :param scalarMapper: None
   :type scalarMapper: ScalarMapperContinuousDomain


   Configure the color legend from the given scalar mapper


   :rtype: void

