Scripting-Dokumentation
Scripting-Dokumentation der graphomate slopegraphs für SAP Lumira Designer
Version 2.1 – Stand September 2018
Einführung
Die graphomate slopegraphs unterstützen 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.
Ereignisse
Die nachfolgend aufgelisteten Ereignisse stehen zur Verfügung. Auf diesen können im Property Sheet unter dem Punkt Events vom Benutzer geschriebene Skripte hinterlegt werden.
Ereignis Name | Beschreibung |
---|---|
On Element Clicked | Wird ausgelöst, wenn der Benutzer zur Laufzeit auf ein Element der Komponente in der Zeichenfläche klickt. Um einen Drilldown zu ermöglichen, muss an dieser Stelle auf die Benutzereingabe reagiert werden. Zum Zeitpunkt dieses Ereignisses werden die Rückgabewerte folgender Funktionen aktualisiert:
|
Funktionen
Folgende Funktionen stehen zur Verfügung. Diese können innerhalb des Skript-Editors von Designer angesprochen werden.
Getter Name | Beispiel | Rückgabetyp | Beispiel Rückgabewert | Beschreibung |
---|---|---|---|---|
getSelectedMember(Dimension dimensionKey) | GRAPHOMATESLOPEGRAPH_1.getSelectedMember(); | Member | Nachdem der User ein Element/eine Kategorie des slopegraphs geklickt hat, gibt diese Funktion den Member der spezifizierten Dimension dimensionKey zurück. Der Member stellt verschiedene Properties wie text, internalKey und externalKey zur Verfügung. | |
getData() | GRAPHOMATESLOPEGRAPH_1.getData(); | String | {"(MEASURES_DIMENSION)": "0D_NWI_NSAL", "0D_NWI_RCOD": "80503"} | Gibt den Selektions-String zurück, der die vom Nutzer selektierten Daten aus der gewählten Data Source beschreibt. Für nähere Informationen konsultieren Sie bitte die Designer-Dokumentation. |
getShowCategoryLabels() | GRAPHOMATESLOPEGRAPH_1.getShowCategoryLabels(); | boolean | false | Gibt zurück, ob Kategorielabel angezeigt werden. |
getFontSize() | GRAPHOMATESLOPEGRAPH_1.getFontSize(); | float | 14 | Gibt die Schriftgröße zurück. |
getTextColor() | GRAPHOMATESLOPEGRAPH_1.getTextColor(); | String | #ff0000 | Gibt die Schriftfarbe zurück. |
getFocusTextColor() | GRAPHOMATESLOPEGRAPH_1.getFocusTextColor(); | String | #BADA55 | Gibt die Fokus-Schriftfarbe zurück, die zur Runtime beim Hovern mit der Maus über einen Slope angezeigt wird. |
getFontFamily() | GRAPHOMATESLOPEGRAPH_1.getFontFamily(); | String | Comic Sans | Gibt die Schriftfamilie zurück. |
getOnlyLeadingDescription() | GRAPHOMATESLOPEGRAPH_1.getOnlyLeadingDescription(); | boolean | true | Gibt zurück, ob nur die führenden Label der Slopes angezeigt werden. |
getNumberFormat() | GRAPHOMATESLOPEGRAPH_1.getNumberFormat(); | String | 0b | Gibt das Nummernformat zurück. |
getSlopeColor() | GRAPHOMATESLOPEGRAPH_1.getSlopeColor(); | String | #777 | Gibt die Slope-Farbe zurück. |
getFocusSlopeColor() | GRAPHOMATESLOPEGRAPH_1.getFocusSlopeColor(); | String | #1CE1CE | Gibt die Slope-Fokus-Farbe zurück, die zur Runtime beim Hovern mit der Maus über einen Slope angezeigt wird. |
getPositiveSlopeColor() | GRAPHOMATESLOPEGRAPH_1.getPositiveSlopeColor(); | String | #facade | Gibt die Farbe für steigende Slopes zurück (wird nur angezeigt, wenn Show Trend in Slopes aktiv ist). |
getNegativeSlopeColor() | GRAPHOMATESLOPEGRAPH_1.getNegativeSlopeColor(); | String | #911 | Gibt die Farbe für fallende Slopes zurück (wird nur angezeigt, wenn Show Trend in Slopes aktiv ist). |
getNegativeIsGood() | GRAPHOMATESLOPEGRAPH_1.getNegativeIsGood(); | boolean | false | Gibt zurück, ob die steigenden Slopes negativ interpretiert werden und entsprechend farblich anders dargestellt werden (und umgekehrt). |
getShowTrendInSlopes() | GRAPHOMATESLOPEGRAPH_1.getShowTrendInSlopes(); | boolean | true | Gibt zurück, ob die Trends angezeigt werden sollen (durch farbliche Markierung mit den Trend-Farben, s. oben). |
getSlopeThickness() | GRAPHOMATESLOPEGRAPH_1.getSlopeThickness(); | float | 1.5 | Gibt die Dicke der Slopes-Linien zurück. |
getUseRanks() | GRAPHOMATESLOPEGRAPH_1.getUseRanks(); | boolean | false | Gibt zurück, ob die Slopes anhand der Rangfolge und nicht des Wertes skaliert werden. |
getRankDotRadius() | GRAPHOMATESLOPEGRAPH_1.getRankDotRadius(); | float | 3 | Gibt die Dicke des Rank Dot Radius zurück (nur relevant, wenn Use Ranks aktiv ist). |
getAscendingOrder() | GRAPHOMATESLOPEGRAPH_1.getAscendingOrder(); | boolean | true | Gibt zurück, ob die Slopes aufsteigend gezeichnet werden. |
Setter Name | Beispiel | Beschreibung |
---|---|---|
setData(String val) | GRAPHOMATESLOPEGRAPH_1.setData({"(MEASURES_DIMENSION)": "0D_NWI_NSAL", "0D_NWI_RCOD": "80503"}); | Setzt den Selektions-String zurück, das heißt den Ausschnitt der Daten, der durch die slopegraphs visualisiert werden soll. Für nähere Informationen konsultieren Sie bitte die Designer-Dokumentation. |
setShowCategoryLabels(boolean val) | GRAPHOMATESLOPEGRAPH_1.setShowCategoryLabels(true); | Setzt, ob die Kategorielabel angezeigt werden. |
setFontSize(float val) | GRAPHOMATESLOPEGRAPH_1.setFontSize(12); | Setzt die Schriftgröße. |
setTextColor(String val) | GRAPHOMATESLOPEGRAPH_1.setTextColor("#eee"); | Setzt die Schriftfarbe. |
setFocusTextColor(String val) | GRAPHOMATESLOPEGRAPH_1.setFocusTextColor("#ff0000); | Setzt die Fokus-Schriftfarbe, die zur Runtime verwendet wird, wenn der Nutzer über einen Text hovert. |
setFontFamily(String val) | GRAPHOMATESLOPEGRAPH_1.setFontFamily("Wingdings"); | Setzt die Schriftfarbe. |
setOnlyLeadingDescription(boolean val) | GRAPHOMATESLOPEGRAPH_1.setOnlyLeadingDescription(false); | Setzt, ob nur die führenden Label der Slopes angezeigt werden. |
setNumberFormat(String val) | GRAPHOMATESLOPEGRAPH_1.setNumberFormat("0.0a"); | Setzt das Nummernformat. |
setSlopeColor(String val) | GRAPHOMATESLOPEGRAPH_1.setSlopeColor("#00ff00"); | Setzt die Slope-Farbe. |
setFocusSlopeColor(String val) | GRAPHOMATESLOPEGRAPH_1.setFocusSlopeColor("#0000ff"); | Setzt die Fokus-Slope-Farbe, die zur Runtime verwendet wird, wenn der Nutzer über einen Slope hovert. |
setPositiveSlopeColor(String val) | GRAPHOMATESLOPEGRAPH_1.setPositiveSlopeColor("#123456"); | Setzt die Farbe für steigende Slopes (wird nur angezeigt, wenn Show Trend in Slopes aktiv ist). |
setNegativeSlopeColor(String val) | GRAPHOMATESLOPEGRAPH_1.setNegativeSlopeColor("#654321"); | Setzt die Farbe für fallende Slopes (wird nur angezeigt, wenn Show Trend in Slopes aktiv ist). |
setNegativeIsGood(boolean val) | GRAPHOMATESLOPEGRAPH_1.setNegativeIsGood(true); | Setzt, ob die steigenden Slopes negativ interpretiert werden und entsprechend farblich anders dargestellt werden (und umgekehrt). |
setShowTrendInSlopes(boolean val) | GRAPHOMATESLOPEGRAPH_1.setShowTrendInSlopes(false); | Setzt, ob die Trends angezeigt werden sollen (durch farbliche Markierung mit den Trend-Farben, s. oben). |
setSlopeThickness(float val) | GRAPHOMATESLOPEGRAPH_1.setSlopeThickness(2); | Setzt die Dicke der slopes-Linien. |
setUseRanks(boolean val) | GRAPHOMATESLOPEGRAPH_1.setUseRanks(true); | Setzt, ob die Slopes anhand der Rangfolge und nicht des Wertes skaliert werden. |
setRankDotRadius(float val) | GRAPHOMATESLOPEGRAPH_1.setRankDotRadius(5); | Setzt die Dicke des Rank Dot Radius (nur relevant, wenn Use Ranks aktiv ist). |
setAscendingOrder(boolean val) | GRAPHOMATESLOPEGRAPH_1.setAscendingOrder(false); | Setzt, ob die Slopes aufsteigend gezeichnet werden. |