Scripting-Dokumentation

Scripting-Dokumentation der graphomate legends für SAP Lumira Designer

Version 2020.4 – Stand Oktober 2020

PDF

Einführung

Die graphomate legends unterstützt die Skriptsprache von Designer. Somit ist es möglich, die Extension zur Laufzeit interaktiv zu verwenden. Beispielsweise können neue Daten gesetzt, Titel bearbeitet und Skalierungen verändert werden. Eine Auflistung der gegenwärtigen Funktionen und Beispiele zur Verwendung liefert dieses Dokument. Wir sind bemüht, den Funktionsumfang ständig zu erweitern. Sollten Ihnen bestimmte Funktionen fehlen, teilen Sie uns dies gerne über unser Kontaktformular mit.

Funktionen

Folgende Funktionen stehen zur Verfügung. Diese können innerhalb des Skript-Editors von Designer angesprochen werden.

Getter NameBeispielRückgabetypBeispiel RückgabewertBeschreibung
getBoldText()GRAPHOMATELEGENDS_1.getBoldText();booleanfalseGibt true zurück, wenn die Legendeneinträge fett formatiert sind, ansonsten false.
getColoredText()GRAPHOMATELEGENDS_1.getColoredText();booleantrueGibt true zurück, wenn die Beschriftung der Legendeneinträge in der Farbe des dazugehörigen Icons eingefärbt sind, ansonsten false.
getDataSet(int dataSetIndex)GRAPHOMATELEGENDS_1.getDataSet(1);String'{"0D_NWI_RCOD":"80503"}'Gibt den Selektionsstring der übergebenen Daten-Property zurück.
getFollowingIcons()GRAPHOMATELEGENDS_1.getFollowingIcons();booleanfalseGibt true zurück, wenn die Icons rechts von der Beschriftung angezeigt werden sollen, ansonsten false.
getFontSize()GRAPHOMATELEGENDS_1.getFontSize();float13.5Gibt die Schriftgröße der Legendeneinträge zurück.
getSelectedMember()GRAPHOMATELEGENDS_1.getSelectedMember("0D_NWI_RCOD");Member
Gibt den Member der übergebenen Dimension zum zuletzt angeklickten Legendeneintrag zurück.
getShowIcons()GRAPHOMATELEGENDS_1.getShowIcons();booleantrueGibt true zurück, wenn zusätzlich zur Beschriftung ein Icon angezeigt werden soll, ansonsten false.
getVerticalAlignment()GRAPHOMATELEGENDS_1.getVerticalAlignment();booleanfalseGibt true zurück, wenn die Legendeneinträge vertikal ausgerichtet sind, ansonsten false.


Setter NameBeispielBeschreibung
setBoldText(boolean)GRAPHOMATELEGENDS_1.setBoldText(true);Bestimmt, ob die Legendeneinträge fett formatiert sein sollen.
setColoredText(boolean)GRAPHOMATELEGENDS_1.setColoredText(true);Bestimmt, ob die Beschriftung der Legendeneinträge in der Farbe der dazugehörigen Icons eingefärbt sein sollen.
setDataSet(int dataSetIndex, String dataSet)GRAPHOMATELEGENDS_1.setDataSet(1, ‘{“0CALMONTH”:”22009”}’);Setzt die Daten-Property mit dem übergebenen Index auf den übergebenen Selektionsstring.
setEntryOption(int index, String targetProperty, String newValue)GRAPHOMATELEGENDS_1.setEntryOption(1, “shape”, “circle”);

Mit dieser Skript-Funktion lässt sich eine einzelne Eigenschaft eines Legendeneintrags verändern. Folgende Parameter müssen übergeben werden:

- index: Index des zu ändernden Legendeneintrags. Wenn der Index nicht vorhanden ist, wird stattdessen ein neuer Legendeneintrag generiert.

- targetProperty: Name der zu ändernden Property („shape“, „filltype“, „color“ oder „text“)

- newValue: Neuer Wert der Property

Folgende Werte werden akzeptiert:

- Für die Property „shape“: „rect“, „circle“ und „rhomb“

- Für die Property „filltype“: „filled“, „hatchedUp“, „hatchedDown“, „dotted“, „empty“, "hatchedUpBold", "hatchedDownBold"

- Für die Property „color“ kann eine beliebige Farbe im Hex-Format angegeben werden (z. B. „#000000“ für Schwarz oder „#ff0000“ für Rot.

- Als Text kann eine beliebige Zeichenkette angegeben werden.

Im Fall von ungültigen Parameterangaben fällt der Legendeneintrag auf den Standardwert zurück; dies ist ein vollständig gefülltes, schwarzes Viereck.

setFollowingIcons(boolean followingIcons)GRAPHOMATELEGENDS_1.setFollowingIcons(true);Bestimmt, ob die Icons links oder rechts der Beschriftung angezeigt werden (true = rechts, false = links)
setFontSize(float fontsize)GRAPHOMATELEGENDS_1.setFontSize(13.5);Bestimmt die Schriftgröße der Legendeneinträge.
setShowIcons(boolean showIcons)GRAPHOMATELEGENDS_1.setShowIcons(false);Bestimmt, ob zusätzlich zur Beschriftung der Legendeneinträge ein Icon angezeigt werden soll. Mit Übergabe von false werden die Icons ausgeblendet.
setVerticalAlignment(boolean verticalAlignment)GRAPHOMATELEGENDS_1.setVerticalAlignment(true);Bestimmt, ob die Legendeneinträge vertikal ausgerichtet sind. Für true werden die Einträge vertikal ausgerichtet; für false entsprechend horizontal mit einem Eintrag pro Zeile.