.. highlightlang:: us

.. index:: LayerGetAxisUserLabelAttribs

.. _layergetaxisuserlabelattribs:

LayerGetAxisUserLabelAttribs
============================

.. us.tag  LayerGetAxisUserLabelAttribs ENGLISH LayerAxisLabel New5600

:ref:`LayerGetAxisUserLabelAttribs` returns the display attributes for axis labels.

.. function::  nAttrib = LayerGetAxisUserLabelAttribs(hLayer, ssXYZ)

.. us.return

**Return Value**

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

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

      * - Define
        - Value
        - Description
      * - AXIS_USERLABEL_ENABLE
        - 1
        - Display user labels. At least one label must be specified.
      * - AXIS_STANDARDLABEL_DISABLE
        - 2
        - Standard labels are not displayed.
      * - AXIS_USERLABEL_SKIPOVERLAP
        - 4
        - Overlapping labels are not displayed. If a user label overlaps with a 
          standard label, the standard label is not plotted.
      * - AXIS_USERLABEL_SHOWGRID
        - 8
        - Grid lines are displayed for user labels.
      * - AXIS_USERLABEL_AUTOLOAD
        - 16
        - Labels will be updated if data is loaded

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

.. us.example

**Example**

::

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

.. us.history

**History**

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

   * - Version
     - Description
   * - R2014
     - New.

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

:sub:`id-303498`