.. highlightlang:: us

.. _xyzsetcolormap:

XYZSetColorMap
==============

.. index:: XYZSetColorMap

.. us.tag  XYZSetColorMap ENGLISH XYZSet_iso New5900

:ref:`XYZSetColorMap` sets a color map name used to fill a contour map or
3D surface map.

.. function::  bool = XYZSetColorMap(hData, ssColorMapName)

.. us.return

**Return Value**

If the function succeeds, the return value *bool* is TRUE (1); otherwise
it is FALSE (0).

.. us.params

**Parameters**

.. uparam:: hData

   The handle of a dataset created with :ref:`XYZCreate`.

.. uparam:: ssColorMapName

   *ssColorMapName* is the name of a color map. Here is the list with the build
   in names:

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

.. us.comment

**Comment**

The :ref:`XYZSetColorMap` function enables the use of the color map. The 
option to use the color map can be switched off with :ref:`XYZEnableColorMap`.

Changes come into effect after the function :ref:`XYZUpdate` is called.

.. seealso::
   :ref:`overview-xyz-datasets`,
   :ref:`XYZCreate`,
   :ref:`XYZSetFillColors`,
   :ref:`XYZSetColorMap`,
   :ref:`XYZEnableColorMap`,
   :ref:`XYZSetFill`

:sub:`id-1206591`