.. highlightlang:: us

.. index:: XYZGetColorMatrixAttrib

.. _xyzgetcolormatrixattrib:

XYZGetColorMatrixAttrib
=======================

.. us.tag XYZGetColorMatrixAttrib NOTREADYENGLISH XYZGet_color_matrix New5300

:ref:`XYZGetColorMatrixAttrib` returns color matrix attributes.

.. function:: nAttribs = XYZGetColorMatrixAttrib(hData)

.. us.return

**Return Value**

*nAttribs* is an OR combination of the following values:

.. list-table::
   :header-rows: 1

   * - Define
     - Values
     - Description
   * - COLORMATRIX_SHOWEDGE
     - 1
     - The matrix will display grid lines.
   * - COLORMATRIX_SHOWZVAL
     - 2
     - The elements will be labeled with z values.
   * - COLORMATRIX_SHRINKTEXT
     - 4
     - If the space to display the label is to small the text will shrink.
   * - COLORMATRIX_CLIPZMIN
     - 8
     - Cells with a z-value smaller than the first isoline value will not be 
       displayed.
   * - COLORMATRIX_CLIPTEXT
     - 16
     - The label will be clipped at the cell border.

.. us.params

**Parameters**

.. uparam:: hData

   identifies the dataset.

.. us.history

**History**

.. list-table::
   :header-rows: 1

   * - Version
     - Description
   * - 5.30
     - New.

.. seealso::
   :ref:`Overview-XYZ-Datasets`,
   :ref:`XYZSetColorMatrixAttrib`,
   :ref:`XYZShowColorMatrix`,
   :ref:`XYZGetProps`,
   :ref:`XYZSetProps`

:sub:`id-1632186`