.. highlightlang:: us

.. _xyzdeletelabel:

XYZDeleteLabel
==============

.. index:: XYZDeleteLabel

.. us.tag  XYZDeleteLabel ENGLISH XYZGet_label

:ref:`XYZDeleteLabel` deletes isoline labels inside a
rectangle.

.. function::  bool = XYZDeleteLabel(hData, rvRect)

.. us.return

**Return Value**

*bool*  If the function succeeds, the return value *bool* is TRUE (1).
If the function fails, the return value is FALSE (0).

.. us.params

**Parameters**

.. uparam:: hData

   A handle of a dataset created with :ref:`XYZCreate`.

.. uparam:: rvRect

   *rvRect*    is a vector with 4 elements:

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

   * - Value
     - Meaning
   * - rvRect[1]
     - x-coordinate from Point 1 (P1)
   * - rvRect[2]
     - y-coordinate from Point 1 (P1)
   * - rvRect[3]
     - x-coordinate from Point 1 (P2)
   * - rvRect[4]
     - y-coordinate from Point 1 (P2)

.. us.example

**Example**

Deletes all labels:

::

   ...
   rvRect = XYZGetMatrixRange(hData);
   XYZDeleteLabel(hData, rvRect);
   ...

The rectangle coordinates must be specified in world coordinates.
All labels between points P1 and P2 inside the rectangle will be deleted.

.. seealso::
   :ref:`overview-xyz-datasets`,
   :ref:`XYZCreate`,
   :ref:`XYZInsertLabel`

:sub:`id-314814`