.. highlightlang:: us

.. _xythresholdcreate:

XYThresholdCreate
=================

.. index:: XYThresholdCreate

.. us.tag  XYThresholdCreate GERMAN New6002

:ref:`XYThresholdCreate` erzeugt einen 2D-Datensatz von einem skalaren Wert als horizontale
oder vertikale Linie oder als horizontalen oder vertikalen Bereich (Balken).

.. function::  hData = XYThresholdCreate(ssName, rsValue, nType)
               hData = XYThresholdCreate(ssName, rvRangeValue, nType)

.. us.return

**Returnwert**

*hData* ist die Zugriffsnummer (Handle) mit der auf den
Datensatz zugegriffen werden kann. Falls der Datensatz nicht erzeugt
werden kann ist *hData* gleich 0.

.. us.params

**Parameter**

.. uparam:: ssName

   *ssName* ist ein skalarer String.

.. uparam:: rsValue

   *rsValue* ist eine Zahl mit der X bzw. Y-Koordinate.

.. uparam:: rvRangeValue

   *rvRangeValue* ist ein Vektor mit zwei Elementen mit den X bzw. Y-Koordinaten.

.. uparam:: nType

   *nType* legt fest, ob der Datensatz als horizontale oder
   vertikale Linie angezeigt werden soll. Mögliche Werte: XY_THRESHOLD_XCONST
   oder XY_THRESHOLD_YCONST

.. us.example

**Beispiel**

::

   * hData = XYThresholdCreate("Test", 12, XY_THRESHOLD_YCONST);
   * hLayer = LayerCreate();
   * hDoc = DocCreate();
   * hPage = PageCreate();
   * DocAddPage(hDoc, hPage);
   * PageAddLayer(hPage, hLayer);
   * LayerAddDataset(hLayer, hData);
   * LayerAutoScale(hLayer);
   * PageReplot(hPage);

Schwellwertbereich erzeugen::

   rsMin = 27;
   rsMax = 34;
   hData = XYThresholdCreate("Test", [rsMin, rsMax], XY_THRESHOLD_YCONST); // range
   // ! means without an item in the legend
   //  XYSetLegendText(hData, "!" + svRet[obj.id.LegendText]);
   XYSetLegendText(hData, "NOx range");
   XYSetFillColor(hData, [127,255,0,0];  // red with 50% transparency
   LayerAddDataset(hLayer, hData);
   LayerMoveDataset(hLayer, hData, 0); // send to beginning of list (background).

Schwellwertbereich ändern::

   rvX = [rsMin, rsMin, rsMax, rsMax];
   rvY = [rsMin, rsMin, rsMax, rsMax];
   XYSetData(hData, rvX, rvY);

.. us.history

**History**

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

   * - Version
     - Beschreibung
   * - R2018.2
     - Schwellwert Bereich zugefügt. Neuer Parameter *rvRangeValue*

.. seealso::
   :ref:`uberblick-xy-datensatze`,
   :ref:`XYCreate`,
   :ref:`DocCreate`,
   :ref:`LayerCreate`

:sub:`id-1203610`