.. highlightlang:: us

.. _auto_xy_labeldataset:

auto_xy_LabelDataset
====================

.. index:: auto_xy_LabelDataset

.. us.tag  auto_xy_LabelDataset NOTREADYENGLISH auto_xy

:ref:`auto_xy_LabelDataset` labels the
first or last point of a 2D dataset with its name.

.. function::  hText = auto_xy_LabelDataset(hData)
    hText = auto_xy_LabelDataset(hData, rvOffsetCM)
    hText = auto_xy_LabelDataset(hData, rvOffsetCM, bShowHelpLine)
    hText = auto_xy_LabelDataset(hData, rvOffsetCM, bShowHelpLine, nType)
    hText = auto_xy_LabelDataset(hData, rvOffsetCM, bShowHelpLine, nType, rsXPos)

.. us.return

**Return Value**

*hText* is the handle of the created text object or 0 is the function failed.

.. us.params

**Parameters**

.. uparam:: hData

   *hData* is the handle of a 1D or 2D dataset.

.. uparam:: rvOffsetCM

   *rvOffsetCM* is a vector with two elements:

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

   * - Value
     - Meaning
   * - rvOffsetCM[1]
     - Offset of the text in x direction in centimeters.
   * - rvOffsetCM[2]
     - Offset of the text in y direction in centimeters.

.. uparam:: bShowHelpLine

   If *bShowHelpLine* is TRUE (1)
   a line will be drawn from a datapoint to the text.

.. uparam:: nType

   *nType* is one of the following values
   (default is 1):

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

   * - Value
     - Meaning
   * - 0
     - Label first data point.
   * - 1
     - Label last data point.
   * - 2
     - Label last data point and set the angle of the text to the gradient of the curve.

.. uparam:: rsXPos

   *rsXPos* Draws the text at the
   specified x coordinate. The coordinate is specified in the
   coordinatesystem of the diagram.

.. seealso::
   :ref:`overview-automation`,
   :ref:`auto_LoadTemplate`,
   :ref:`auto_LoadDataset`,
   :ref:`ObjSetName`

:sub:`id-97051`