.. role:: ts-api-decorator

#################
ColorTableFactory
#################

.. js:module:: cee
   :noindex:

.. container:: ts-api-section

   .. js:class:: ColorTableFactory



.. container:: api-index-section

   .. rubric:: Constructors

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

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



.. container:: api-index-section

   .. rubric:: Methods

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

   * :js:meth:`~cee.ColorTableFactory.color3TableArray`
   * :js:meth:`~cee.ColorTableFactory.color4TableArray`
   * :js:meth:`~cee.ColorTableFactory.interpolateColor4Array`
   * :js:meth:`~cee.ColorTableFactory.interpolateColorArray`
   * :js:meth:`~cee.ColorTableFactory.partColorArray`





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

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

.. container:: ts-api-section

   .. js:function:: ColorTableFactory.constructor()



      :rtype: ColorTableFactory



Methods
=======

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

:ts-api-decorator:`static` color3TableArray
-------------------------------------------

.. js:method:: ColorTableFactory.color3TableArray( colorTable, colorCount)

   :param colorTable: None
   :type colorTable: ColorTable
   :param colorCount: None
   :type colorCount: number


   Returns an array of Color3 created from the given color scheme.

   The returned array will have colorCount number of values


   :rtype: [Color3Like]

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

:ts-api-decorator:`static` color4TableArray
-------------------------------------------

.. js:method:: ColorTableFactory.color4TableArray( colorTable, colorCount)

   :param colorTable: None
   :type colorTable: ColorTable
   :param colorCount: None
   :type colorCount: number


   Returns an array of Color4 created from the given color scheme.

   The returned array will have colorCount number of values. All alpha values will be set to 1.


   :rtype: [Color4Like]

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

:ts-api-decorator:`static` interpolateColor4Array
-------------------------------------------------

.. js:method:: ColorTableFactory.interpolateColor4Array( colorArray, targetColorCount)

   :param colorArray: None
   :type colorArray: [Color4Like]
   :param targetColorCount: None
   :type targetColorCount: number


   Interpolate a graded color table with the given number of colors (targetColorCount) based on
   the input colors (colorArray).

   This is useful for creating gradient/continuous style color maps based on two or more colors.


   :rtype: [Color4Like]

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

:ts-api-decorator:`static` interpolateColorArray
------------------------------------------------

.. js:method:: ColorTableFactory.interpolateColorArray( colorArray, targetColorCount)

   :param colorArray: None
   :type colorArray: [Color3Like]
   :param targetColorCount: None
   :type targetColorCount: number


   Interpolate a graded color table with the given number of colors (targetColorCount) based on
   the input colors (colorArray).

   This is useful for creating gradient/continuous style color maps based on two or more colors.


   :rtype: [Color3Like]

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

:ts-api-decorator:`static` partColorArray
-----------------------------------------

.. js:method:: ColorTableFactory.partColorArray( colorCount)

   :param colorCount: None
   :type colorCount: number


   Returns an array with colors matching the part colors in the Envision and the cee.ug component.


   :rtype: [Color3Like]

