.. highlight:: us

.. index:: ColorScale_AddUser
.. index:: ColorMap

.. _colorscale_adduser:

ColorScale_AddUser
==================

.. us.tag ColorScale_AddUser New6805

:ref:`ColorScale_AddUser` erzeugt oder ersetzt eine Benutzer-Farbskala. Die
Farbskala wird im User-Verzeichnis gespeichert und steht auch nach einem
Neustart und nach einem Update von UniPlot zur Verfügung.

.. function::  bool = ColorScale_AddUser(ssName, svColor)

.. us.return

**Returnwert**

*bool* ist TRUE (1), wenn die Farbskala gespeichert wurde, und FALSE (0), wenn
ein Fehler aufgetreten ist. Die Fehlermeldung wird in die Ereignisanzeige
geschrieben.

.. us.params

**Parameter**

.. uparam:: ssName

   *ssName* ist der Name der Farbskala. Der Name darf nicht länger als 31
   Zeichen sein und darf nicht der Name einer vordefinierten Farbskala sein
   (siehe :ref:`ColorScale_GetNames`). Falls eine Benutzer-Farbskala mit
   demselben Namen existiert, wird sie ersetzt.

.. uparam:: svColor

   *svColor* ist ein String-Vektor mit mindestens zwei HTML-Farben im Format
   ``"#RRGGBB"``, z. B. ``["#00FF00", "#FF0000"]``, oder eine reelle Matrix
   mit drei Spalten (Rot-, Grün- und Blauanteil im Bereich 0 bis 255) und einer
   Zeile pro Farbe, z. B. ``[0,255,0; 255,0,0]``.

.. us.comment

**Kommentar**

Die Benutzer-Farbskalen werden in der Datei
:file:`Settings\\user_color_scales.rgb` im UniPlot-User-Verzeichnis gespeichert
(siehe :ref:`GetUserDirectory`). Die Farbskalen können mit
:ref:`tools-user-color-maps` bearbeitet werden.

.. us.example

**Beispiel**

::

   ColorScale_AddUser("MynewColorMap", ["#00FF00", "#FF0000"]);
   rmColor = ColorScale_GetColors("MynewColorMap", 10);

.. us.history

**History**

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

   * - Version
     - Beschreibung
   * - R2026.5
     - Neu.

.. seealso::
   :ref:`tools-user-color-maps`,
   :ref:`ColorScale_DeleteUser`,
   :ref:`ColorScale_GetUserNames`,
   :ref:`ColorScale_GetNames`,
   :ref:`ColorScale_GetColors`

:sub:`id-1102328`