.. highlightlang:: us

.. index:: LayerSetAxisLinkName

.. _layersetaxislinkname:

LayerSetAxisLinkName
====================

.. us.tag  LayerSetAxisLinkName GERMAN LayerSet New5400

:ref:`LayerSetAxisLinkName` legt den Namen für eine Achsenverknüpfung fest.

.. function::  bool = LayerSetAxisLinkName(hLayer, ssAxis, ssLinkName)

.. us.return

**Returnwert**

*bool* ist TRUE (1), wenn die Funktion erfolgreich war und sonst FALSE (0).

.. us.params

**Parameter**

.. uparam:: hLayer

   *hLayer* ist die Zugriffsnummer des Diagramms, das mit :ref:`LayerCreate`
   erzeugt wurde.

.. uparam:: ssAxis

   *ssAxis* ist ``"X"``, falls die Funktion die x-Achse betrifft und ``"Y"``,
   falls die Funktion die y-Achse betrifft. (``"Z"`` wird nicht unterstützt).

.. uparam:: ssLinkName

   *ssLinkName* eine ein beliebiger Text, z. B. "xlink1". Über den Text werden 
   die Achsen verknüpft. Dazu wird im Dokument eine Tabelle erzeugt die zu jedem 
   Namen die Werte für die Achsenskalierung speichert. Um eine existierende 
   Verknüpfung zu entfernen, gibt man einen leeren String ein. 

.. us.comment

**Kommentar**

Verknüpfte Achsen innerhalb eines Dokumentes zeigen die gleiche Skalierung an. 
Wird die Skalierung auf einer Seite geändert, werden die verknüpften Achsen
automatisch aktualisiert. Mit :ref:`LayerSetAxisLinkName` können Achsen von
Diagrammen verknüpft werden, die sich auf verschiedenen Seiten eines Dokuments
befinden.

Um in UniScript die Achsen eines Dokumentes zu verknüpften, geht man wie folgt
vor.

1. Für alle Achsen, die man verknüpfen möchte muss die Funktion 
:ref:`LayerSetAxisLinkName` aufgerufen werden. Dazu legt man zuerst einen
beliebigen Namen für die Verknüpfung fest, z. B. "xlink1". 

Für alle Diagramme wird dann der folgende Aufruf entsprechend oft
in das Skript eingefügt (oder über eine for-Schleife)::

   LayerSetAxisLinkName(hLayer, "X", "xlink1");

2. Für ein Diagramm sollte dann die Funktion :ref:`LayerUpdateDocumentMap`
aufgerufen werden. Die Funktion kopiert die Achsenskalierung der entsprechenden
Achse des gegebenen Diagramms in eine zentrale Tabelle des Dokuments::

   LayerUpdateDocumentMap(hLayer, "X", TRUE);

3. Damit nun alle Diagramme der aktuellen Seite die Skalierung des Diagramms 
übernehmen, muss zum Abschluss noch die Funktion :ref:`PageUpdateAxisLink` 
aufgerufen werden::

   PageUpdateAxisLink(GetParent(hLayer))

Wenn das Dokument nach der Erstellung mit UniScript interaktiv verwendet
wird, sollte die Achsenskalierungen dann automatisch aktualisiert werden.

**History**

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

   * - Version
     - Beschreibung
   * - R2012 (5.40.0)
     - Neu.

.. seealso::
   :ref:`uberblick-diagramme`,
   :ref:`LayerCreate`,
   :ref:`LayerGetAxisLinkName`,
   :ref:`LayerUpdateDocumentMap`,
   :ref:`PageUpdateAxisLink`

:sub:`id-1643567`