.. highlightlang:: us

.. index:: LayerGetAxisUserLabel

.. _layergetaxisuserlabel:

LayerGetAxisUserLabel
=====================

.. us.tag  LayerGetAxisUserLabel ENGLISH LayerAxisLabel New5600

:ref:`LayerGetAxisUserLabel` retrieves the user labels. The user labels are
labels which can be places at the axis. The labels can display text. 

.. function::  smLabel = LayerSetAxisUserLabel(hLayer, ssXYZ)
               smLabel = LayerSetAxisUserLabel(hLayer, ssXYZ)

.. us.return

**Return Value**

*smLabel* is a string matrix with two columns. The first columns contains the
position as a string and the second column the display string. If no labels are
defined, the function returns an empty string.

.. us.params

**Parameters**

.. uparam:: hLayer

   Identifies the layer.

.. uparam:: ssXYZ

   *ssXYZ* is ``"X"`` for the x-axis, ``"Y"`` for the y-axis. ``"Z"`` is not 
   supported.

.. us.example

**Example**

::

   smEnum = ["1.0", "On";
             "0.0", "Off"];
   LayerSetAxisUserLabel(hLayer, "Y", smEnum);
   LayerSetAxisUserLabelAttribs(hLayer, "Y", ...
          AXIS_USERLABEL_ENABLE | AXIS_STANDARDLABEL_DISABLE | AXIS_USERLABEL_SKIPOVERLAP);
   smLabel = LayerSetAxisUserLabel(hLayer, "Y");

.. us.history

**History**

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

   * - Version
     - Description
   * - R2014
     - New.

.. seealso::
   :ref:`overview-diagrams`,
   :ref:`LayerCreate`,
   :ref:`LayerGetAxisUserLabelAttribs`,
   :ref:`LayerSetAxisUserLabel`

:sub:`id-1190577`