.. highlightlang:: us

.. index:: LayerSetAxisTB

.. _layersetaxistb:

LayerSetAxisTB
==============

.. us.tag  LayerSetAxisTB NOTREADYENGLISH LayerAxisTitle

:ref:`LayerSetAxisTB` copies the specified text object into the axis title.

.. function::  bool = LayerSetAxisTB(hLayer, ssXYZ, hText)

.. us.return

**Return Value**

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

.. us.params

**Parameters**

.. uparam:: hLayer

   *hLayer* is the handle of a diagram (layer).

.. uparam:: ssXYZ

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

.. uparam:: hText

   *hText* is the handle of a text object.

.. us.example

**Example**

::

   //hPage = auto_LoadTemplate(...)
   hPage = 20;   // Handle retrieved from status bar
   hLayer = PageGetLayerHandle(hPage, "Diagram1");
   hText = LayerGetAxisTB(hLayer, "X");
   TBSetText(hText, "Speed");
   TBSetAlignHorz(hText, LEFT);
   OBJSetColorGradient(hText, [255,0,0], [0,255,255]);
   OBJSetFillMode(hText, 1);
   OBJSetBkMode(hText, 0);
   LayerSetAxisTB(hLayer, "X", hText);
   TBDestroy(hText); // Delete copy otherwise we have a memory leek.

.. seealso::
   :ref:`LayerCreate`,
   :ref:`LayerGetAxisTB`

:sub:`id-1653779`