.. highlightlang:: us

.. index:: LayerSetAxisUserLabel

.. _layersetaxisuserlabel:

LayerSetAxisUserLabel
=====================

.. us.tag  LayerSetAxisUserLabel ENGLISH LayerAxisLabel New5600

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

.. function::  bool = LayerSetAxisUserLabel(hLayer, ssXYZ, smLabel)
               bool = LayerSetAxisUserLabel(hLayer, ssXYZ, svLabel, rvPos)

.. us.return

**Return Value**

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

.. us.params

**Parameters**

.. uparam:: hLayer

   Identifies the layer.

.. uparam:: ssXYZ

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

.. uparam:: smLabel

   *smLabel* is a string matrix with two columns. The first columns contains the
   position as a string and the second column the display string. 

.. uparam:: svLabel

   *svLabel* is a string vector with the display string.

.. uparam:: rvPos

   *rvPos* is a real vector with the label positions. To remove all user label
   set rvPos to 1e10 and svLabel to "".

.. 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);

Remove alle user label::

   LayerSetAxisUserLabel(hLayer, "Y", "", 1e10);

.. us.history

**History**

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

   * - Version
     - Description
   * - R2014
     - New.

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

:sub:`id-1190257`