.. highlightlang:: us

.. _xygetxmonoton:

XYGetXMonoton
=============

.. index:: XYGetXMonoton

.. us.tag  XYGetXMonoton NOTREADYENGLISH xy.data New534

:ref:`XYGetXMonoton` returns a value greater 0, if the x-coordinates are 
monotonically increasing or decreasing.

.. function::  nMonoton = XYGetXMonoton(hData)
    nMonoton = XYGetXMonoton(hData, bExt)

.. us.return

**Return Value**

*nMonoton* is one of the following values:

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

   * - Value
     - Description
   * - -1
     - unknown. The value is not valid. The dataset is not added to a document.
   * - 0
     - not monoton
   * - 1
     - monotonically increasing
   * - 2
     - strictly Monotonicallyincreasing
   * - 3
     - monotonically decreasing
   * - 4
     - strictly monotonically decreasing

.. us.params

**Parameters**

.. uparam:: hData

   The handle of a dataset created with :ref:`XYCreate` or
   :ref:`TYCreate`.

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

.. us.history

**History**

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

   * - Version
     - Description
   * - 5.3.4
     - New.

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

:sub:`id-1122240`