.. highlightlang:: us

.. index:: LayerSetAxisUserLabel

.. _layersetaxisuserlabel:

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

.. us.tag  LayerSetAxisUserLabel GERMAN LayerAxisLabel New5600

:ref:`LayerSetAxisUserLabel` setzt die Benutzerlabel. Ein Label besteht aus
dem Anzeigetext und der Position auf der Achse.

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

.. us.return

**Returnwert**

*bool* ist TRUE (1), wenn die Funktion erfolgreich war und sonst FALSE (0).

.. us.params

**Parameter**

.. uparam:: hLayer

   *hLayer* ist die Zugriffsnummer des Diagramms, das mit :ref:`LayerCreate`
   erzeugt wurde.

.. uparam:: ssXYZ

   *ssXYZ* ist ``"X"``, falls die Funktion die x-Achse betrifft, ``"Y"``, falls
   die Funktion die y-Achse betrifft. Für die Z-Achse können keine 
   Benutzerlabel angezeigt werden.

.. uparam:: smLabel

   *smLabel* ist eine Stringmatrix  mit 2 Spalten. Die erste Spalte ist 
   enthält die Position auf der Achse als String und die zweite Spalte den
   Anzeigetext (siehe Beispiel).

.. uparam:: svLabel

   *svLabel* ist ein Stringvektor mit dem Anzeigetext.

.. uparam:: rvPos

   *rvPos* ist ein Vektor mit den Label Positionen. Um alle Label zu löschen,
   wird *svLabel*  gleich "" und *rvPos* auf 1e10 gesetzt.

.. us.example

**Beispiel**

::

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

Mit dem folgenden Aufruf werden alle Userlabel gelöscht::

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

.. us.history

**History**

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

   * - Version
     - Beschreibung
   * - R2014
     - Neu.

.. seealso::
   :ref:`uberblick-diagramme`,
   :ref:`LayerCreate`,
   :ref:`LayerGetAxisUserLabel`,
   :ref:`LayerGetAxisUserLabelAttribs`

:sub:`id-1190257`