.. highlightlang:: us

.. _xyzsethullnewdata:

XYZSetHullNewData
=================

.. index:: XYZSetHullNewData

.. us.tag  XYZSetHullNewData ENGLISH XYZSet_hull

:ref:`XYZSetHullNewData` creates a new data hull that
can also contain islands.

.. function::  bool = XYZSetHullNewData(hData, rvX, rvY, rvLineTo)

.. us.return

**Return Value**

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

.. us.params

**Parameters**

.. uparam:: hData

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

.. uparam:: rvX

   *rvX* A vector with the x-coordinates.

.. uparam:: rvY

   *rvY* A vector with the y-coordinates.

.. uparam:: rvLineTo

   *rvLineTo* A vector of characters which define
   the shape of the data hull, e.g. Full Load Line (WOT). Each vector
   element be one of the following ASCII characters:

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

   * - Value
     - Meaning
   * - ``"m"`` ASCII-Code = 109
     - MoveTo without z-value label.
   * - ``"M"`` ASCII-Code = 77
     - MoveTo with z-value label.
   * - ``"l"`` ASCII-Code = 108
     - LineTo without z-value label.
   * - ``"L"`` ASCII-Code = 76
     - LineTo with z-value label.

.. us.comment

**Comment**

All vectors must have the same number of elements. The z-value
for the labelling of hull data points will be interpolated.

.. us.example

**Example**

::

   rvHull = [10,10; 20,10; 20,20; 20,10];

   nRows = nr(rvHull);
   rvLineTo = zeros(nRows, 1) + 109; // MoveTo
   XYZSetHullNewData(hData, rvHull[;1], rvHull[;2], rvLineTo);
   XYZSetHullType(hData, HULL_USERDEF);
   XYZUpdate(hData);

.. seealso::
   :ref:`overview-xyz-datasets`,
   :ref:`XYZCreate`,
   :ref:`XYZGetHullData`,
   :ref:`XYZSetHullType`,
   :ref:`XYZUpdate`,
   :ref:`strcode`,
   :ref:`strsplit`,
   :ref:`strchar`,
   :ref:`sum`

:sub:`id-892593`