Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Div
classpdfExportLandscape
Skript-Dokumentation der

Script documentation for the graphomate slopegraphs

für

for SAP BusinessObjects Design Studio

Author: Gregor Große-Bölting

Version 1.0 –

Stand März

March 2017

Einführung

Introduction

Die The graphomate slopegraphs unterstützen die Skriptsprache von Design Studio. 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.support the scripting language for Design Studio, so it is possible to interactively use the extension during runtime. One could, for example, set new data, manipulate the title or change the scaling. This documentation will provide a list of the currently active functions including examples of their usage. We are trying to enhance the extend of our functionality, so please don't hesitate to let us know if you are in need of a certain functionality using out contact page.

Events

These are the available event hooks, for which the user can define his own scripts using the property sheet under events.

Ereignis NameBeschreibung
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 aktualisiertTriggered if the user clicks some element of the component during runtime. To enable drilldowns one iwll have to react to the user input. For this the return value for the following function will be updated with this event:

  • getSelectedMember() 

Funktionen

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

Functions

These are the available functions, they can be used withing Design Studios script editor.

Getter NameBeispielRückgabetypBeispiel RückgabewertBeschreibung
getSelectedMember(Dimension dimensionKey)GRAPHOMATESLOPEGRAPH_1.getSelectedMember();MemberNachdem 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

After the user clicked an element/category of the slopegraph, this function will return the members for the specified dimension dimensionKey. This member provides several fields like text, internalKey and externalKey.

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 Design Studio-Dokumentation

Returns the selection string which represents the selected data from the data source. For further information please use the Design Studio Documentation.

getShowCategoryLabels()GRAPHOMATESLOPEGRAPH_1.getShowCategoryLabels();booleanfalseGibt zurück, ob Kategorielabel angezeigt werdenReturns a flag to describe whether or not the category labels are visible.
getFontSize()GRAPHOMATESLOPEGRAPH_1.getFontSize();float14Gibt die Schriftgröße zurückReturns the font size.
getTextColor()GRAPHOMATESLOPEGRAPH_1.getTextColor();String#ff0000Gibt die Schriftfarbe zurückReturns the font color.
getFocusTextColor()GRAPHOMATESLOPEGRAPH_1.getFocusTextColor();String#BADA55Gibt die Fokus-Schriftfarbe zurück, die zur Runtime beim Hovern mit der Maus über einen Slope angezeigt wirdReturns the focus font color, which is used during runtime when the mouse is hovering over a slope.
getFontFamily()GRAPHOMATESLOPEGRAPH_1.getFontFamily();StringComic SansGibt die Schriftfamilie zurückReturns the font family.
getOnlyLeadingDescription()GRAPHOMATESLOPEGRAPH_1.getOnlyLeadingDescription();booleantrueGibt zurück, ob nur die führenden Label der Slopes angezeigt werden

Returns whether or not only leading labels are shown for the slopes.

getNumberFormat()GRAPHOMATESLOPEGRAPH_1.getNumberFormat();String0bGibt das Nummernformat zurückReturns the number format.
getSlopeColor()GRAPHOMATESLOPEGRAPH_1.getSlopeColor();String#777Gibt die Slope-Farbe zurückReturns the slope color.
getFocusSlopeColor()GRAPHOMATESLOPEGRAPH_1.getFocusSlopeColor();String#1CE1CEGibt die Slope-Fokus-Farbe zurück, die zur Runtime beim Hovern mit der Maus über einen Slope angezeigt wird

Returns the slope focus color which is used during runtime when the mouse is hovering over a slope.

getPositiveSlopeColor()GRAPHOMATESLOPEGRAPH_1.getPositiveSlopeColor();String#facadeGibt die Farbe für steigende Slopes zurück (wird nur angezeigt, wenn

Returns the color for the ascending slopes (which are only visible if Show Trend in Slopes

aktiv ist

is active).

getNegativeSlopeColor()GRAPHOMATESLOPEGRAPH_1.getNegativeSlopeColor();String#911Gibt die Farbe für fallende Slopes zurück (wird nur angezeigt, wenn

Returns the color for descending slopes (which is only visible if Show Trend in Slopes

aktiv ist

is active).

getNegativeIsGood()GRAPHOMATESLOPEGRAPH_1.getNegativeIsGood();booleanfalseGibt zurück, ob die steigenden Slopes negativ interpretiert werden und entsprechend farblich anders dargestellt werden (und umgekehrt

Returns whether or not ascending slopes are interpreted as negative and are colored correspondingly (and vice versa).

getShowTrendInSlopes()GRAPHOMATESLOPEGRAPH_1.getShowTrendInSlopes();booleantrueGibt zurück, ob die Trends angezeigt werden sollen (durch farbliche Markierung mit den Trend-Farben, s. oben

Returns whether or not trends should be shown (using the specified trend colors, see above).

getSlopeThickness()GRAPHOMATESLOPEGRAPH_1.getSlopeThickness();float1.5Gibt die Dicke der Slopes-Linien zurück

Returns the thickness of the slope lines.

getUseRanks()GRAPHOMATESLOPEGRAPH_1.getUseRanks();booleanfalseGibt zurück, ob die Slopes anhand der Rangfolge und nicht des Wertes skaliert werden

Returns whether or not slope are ordered using their rank instead of their value.

getRankDotRadius()GRAPHOMATESLOPEGRAPH_1.getRankDotRadius();float3Gibt die Dicke des

Returns the radius used for the Rank Dot Radius

zurück

(

nur

only relevant

, wenn

if Use Ranks

aktiv ist

is active).

getAscendingOrder()GRAPHOMATESLOPEGRAPH_1.getAscendingOrder();booleantrueGibt zurück, ob die Slopes aufsteigend gezeichnet werden

Returns whether or not the slopes are shown in ascending order.


Setter NameBeispielBeschreibung
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 Design Studio-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.


...