.. highlightlang:: us

.. index:: ColorScale_dialog

.. _colorScale_dialog:

ColorScale_dialog
=================

.. us.tag ColorScale_dialog NOTREADYENGLISH DialogBoxes New5900

:ref:`ColorScale_dialog` displays a dialog box to select a color scale.

   .. image:: S:/uniplot-obj/images/Data3DDatasetColorMap-en.*

.. function::  ssColorScale =  ColorScale_dialog(ssColorScale, nColor)

.. us.return

**Return Value**

*oColor* is an object with the elements *ssColorScaleName* and *rmColor*.
If the Cancel button was selected, the real value 0 is returned. 

*oColor.ssColorScaleName* contains the selected color scale name and 
*oColor.rmColor* is a real matrix with three columns, containing the RGB values
of the selected color scale.

.. us.params

**Parameters**

.. uparam:: ssColorScale

   *ssColorScale* is a color scale name to initialize the dialog box or an empty
   string.

**Parameters**

.. uparam:: nColor

   *nColor* is the number of colors returned in the element *oColor.rmColor*.
   If *nColor* is 1, 12 colors will be displayed in the combo box. If the number
   of colors is greater than 12, only 12 colors will be displayed.

List of color maps:

   .. image:: S:/uniplot-obj/images/colormaplist.*

.. seealso::
   :ref:`overview-dialogboxes`,
   :ref:`GetColorGradientDialog`,
   :ref:`ColorScale_GetColors`,
   :ref:`ColorScale_GetNames`

:sub:`id-1002797`