.. highlightlang:: us

.. index:: LayerSetAxisTitleFreePos

.. _layersetaxistitlefreepos:

LayerSetAxisTitleFreePos
========================

.. us.tag  LayerSetAxisTitleFreePos NOTREADYENGLISH LayerAxisTitle New500

:ref:`LayerSetAxisTitleFreePos` specifies if the position of the axis title can
be modified using the mouse.

.. function::  bool = LayerSetAxisTitleAutoPos(hLayer, ssXYZ, bFreePos)

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

   If *bFreePos* is TRUE (1) the position can be modified using the mouse.

.. us.example

**Example**

Move the y axis title to the top of the diagram.

::

   hLayer = 20;   // Handle retrieved from status bar

   rvPS = OBJGetPosSize(hLayer);
   LayerSetAxisTitleFreePos(hLayer, "Y", TRUE);
   // returns a copy of the text object!
   hText = LayerGetAxisTB(hLayer, "Y");
   rvT_PS = OBJGetPosSize(hText);
   TBSetAngle(hText, 0);
   rvNewPos = [rvPS[1], rvPS[2]+rvPS[4], rvT_PS[3], rvT_PS[4]];
   OBJSetPosSize(hText, rvNewPos);
   TBSetAutoSize(hText, TRUE);
   LayerSetAxisTB(hLayer, "Y", hText);
   TBDestroy(hText); // delete the copy

.. us.history

**History**

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

   * - Version
     - Description
   * - 5.0.0
     - New

.. seealso::
   :ref:`overview-diagrams`,
   :ref:`LayerIsAxisTitleAutoPos`,
   :ref:`LayerSetAxisTitleOffset`,
   :ref:`LayerSetAxisTitleAutoPos`,
   :ref:`LayerCreate`

:sub:`id-282353`