.. highlightlang:: us

.. index:: XYSetData

.. _xysetdata:

XYSetData
=========

.. us.tag  XYSetData ENGLISH xy.data New400 Changed530 Changed590 Changed5200

:ref:`XYSetData` sets the xy-coordinates of a dataset.

.. function::  bool = XYSetData(hData)
    bool = XYSetData(hData, bExt)
    bool = XYSetData(hData, rvX, rvY)
    bool = XYSetData(hData, rvX, rvY, bExt)
    bool = XYSetData(hData, rvX, rvY, bExt, rvMissingValue)

.. 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:`XYCreate` or :ref:`TYCreate`.

.. uparam:: rvX

   *rvX* is a vector with x-coordinates.

.. uparam:: rvY

   *rvY* is a vector with y-coordinates.

.. uparam:: bExt

   This parameter specifies if the function will access the original data
   or the filtered data.

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

      * - Value
        - Description
      * - -1
        - If filtered data is available it will access filtered data, otherwise it will  access original data. Default value is -1.
      * - 0
        - Access original data.
      * - 1
        - Access filtered data.

.. uparam:: rvMissingValue

   *rvMissingValue* is a real vector with one or two elements. The values specify
   the missing value in *rvX* and *rvY*. All missing values in *rvX* and *rvY*
   will be ignored. If *rvMissingValue* contains only one value, it will be used
   to remove missing valued for the x- and y-coordiantes. 
   Default value is 1e10.

.. us.comment

**Comment**

The number of vector elements *rvX* and *rvY* must agree.

A function call without data sets the dataset to empty.

All data points equal to *rvMissingValue* will not be added to the dataset.

.. us.history

**History**

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

   * - Version
     - Description
   * - 5.20.0
     - New parameter *rvMissingValue*.
   * - 5.9.0
     - Can be invoked with 2 parameters.
   * - 5.3.0
     - Call with one parameter sets the dataset to empty.

.. seealso::
   :ref:`overview-xy-datasets`,
   :ref:`XYCreate`,
   :ref:`TYCreate`,
   :ref:`XYSetDataType`

:sub:`id-600555`