.. highlightlang:: us

.. _xysetscaleoffset:

XYSetScaleOffset
================

.. index:: XYSetScaleOffset

.. us.tag  XYSetScaleOffset ENGLISH XYSet New400

:ref:`XYSetScaleOffset` sets the scaling for the x- and y-coordinates of the 
given dataset.

.. function::  bool = XYSetScaleOffset(hData, rvScaleOffset)

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

   *rvScaleOffset* is a real vector with 4 elements:

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

   * - Value
     - Bedeutung
   * - rvScaleOffset[1]
     - X-Scale Factor
   * - rvScaleOffset[2]
     - X-Offset
   * - rvScaleOffset[3]
     - Y-Scale Factor
   * - rvScaleOffset[4]
     - Y-Offset

::

   XOriginal = XOriginal * rvScaleOffset[1] + rvScaleOffset[2]
   YOriginal = YOriginal * rvScaleOffset[3] + rvScaleOffset[4]

.. us.comment

**Comment**

:ref:`XYGetData` returns the scaled values. :ref:`XYSetData` sets scaled
values.

.. seealso::
   :ref:`overview-xy-datasets`,
   :ref:`XYCreate`,
   :ref:`XYGetScaleOffset`

:sub:`id-561563`