.. highlightlang:: us

.. index:: LayerSetAxisLabel

.. _layersetaxislabel:

LayerSetAxisLabel
=================

.. us.tag  LayerSetAxisLabel ENGLISH LayerAxisLabel Changed5600

:ref:`LayerSetAxisLabel` specifies the text of the axis labels.

.. function::  bool = LayerSetAxisLabel(hLayer, ssXYZ, svLabel)
               bool = LayerSetAxisLabel(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:: svLabel

   *svLabel* is a string vector. The number of elements must be equal or smaller
   than the number axis labels. Example: ["1000.0","2000","Nm","3000"].
   To avoid that labels are overwritten when the axis scaling is changed,
   labels can be marked ``#b`` and ``#e``. The marked label will not be replaced
   by a value and will stay at the position counted from the beginning or
   end of the scale. The two characters must be placed in front of the text:

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

      * - Value
        - Meaning
      * - #b
        - This sign means that the label string will stay at the position counted
          from the beginning.
      * - #a
        - the same as #b.
      * - #e
        - This sign means that the label string will stay at the position counted
          from the end. E-AxisLabel_e

.. us.example

**Example**

::

   svLabel = LayerGetAxisLabel(hLayer, "X");
   nLabel = len(svLabel);
   svLabel[nLabel-1] = "#erpm";
   LayerSetAxisLabel(hLayer, "X", svLabel);

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

:sub:`id-434768`