Einführung

Die graphomate treemaps 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.

Ereignisse

Die nachfolgend aufgelisteten Ereignisse stehen zur Verfügung. Auf diesen können im Standard-Properties-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:

getSelectedMemberKey()
getSelectedMemberText()
getClickedElementIndex()
getClickedSeriesIndex()

On New Data Arrival

Wird ausgelöst, wenn die Treemap aktualisierte Daten erhält. Dies geschieht zum Beispiel, nachdem sich die Dimensionen einer Data Source geändert haben oder wenn Filter verändert wurden.Eine Anpassung der Datenarten (Data Types) wäre an dieser Stelle zum Beispiel möglich.

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
getColorScheme()	GRAPHOMATETREEMAP_1.getColorScheme();	String	Spectral,9	Gibt das aktuell für die Treemap ausgewählte ColorBrewer-Farbschema zurück. Die Rückgabe enthält das Schema und – durch ein Komma separiert – die Anzahl der Klassen.
getColorCalculationMethod()	GRAPHOMATETREEMAP_1.getColorCalculationMethod();	String	hierarchy	Gibt zurück, welche Methode zur Einfärbung der Rechtecke der Treemap verwendet wird.
getDepth()	GRAPHOMATETREEMAP_1.getDepth();	int	3	Gibt zurück, auf wie viele Level die Beschränkung der Hierarchie-Tiefe festgelegt ist.
getDescriptionArea()	GRAPHOMATETREEMAP_1.getDescriptionArea();	boolean	false	Gibt zurück, ob in den Beschriftungen der Rechtecke die Area-Dimension und der Wert des Members gezeichnet werden.
getDescriptionDeviation()	GRAPHOMATETREEMAP_1.getDescriptionDeviation();	boolean	false	Gibt zurück, ob in den Beschriftungen der Rechtecke die Color-Dimension und der Wert des Members gezeichnet werden.
getDescriptionName()	GRAPHOMATETREEMAP_1.getDescriptionName();	boolean	false	Gibt zurück, ob in den Beschriftungen der Rechtecke der Name des Members angezeigt wird.
getDescriptionPath()	GRAPHOMATETREEMAP_1.getDescriptionPath();	boolean	true	Gibt zurück, ob in den Beschriftungen der Rechtecke die Hierarchie-Ebenen angezeigt werden.
getDescriptionVisible()	GRAPHOMATETREEMAP_1.getDescriptionVisible();	boolean	true	Gibt zurück, ob zur Laufzeit Beschriftungen in den Rechtecken angezeigt werden.
getEmbedded()	GRAPHOMATETREEMAP_1.getEmbedded();	boolean	false	Gibt zurück, ob der embedded-Modus (Rahmen zur Anzeige der Hierarchie-Ebene) der Treemap eingeschaltet ist.
getExtendedNumberFormat()	GRAPHOMATETREEMAP_1.getExtendedNumberFormat();	String	-\|\|.\|,\|1\|1\|	Gibt das Nummernformat für den Extended-Modus zurück. Der Formatstring kann im Handbuch nachgelesen werden.
getExtendedNumberFormatPercentage()	GRAPHOMATETREEMAP_1.getExtendedNumberFormatPercentage();	String	-\|\|.\|,\|1\|1\|%25	Gibt das Nummernformat für die Prozentwerte im Extended-Modus zurück. Der Formatstring kann im Handbuch nachgelesen werden.
getHideOverflowingDescriptions()	GRAPHOMATETREEMAP_1.getHideOverflowingDesicription();	boolean	true	Gibt zurück ob die Option zum Entfernen überlaufender Beschriftungen angewählt wurde.
getLabelFormatMode()	GRAPHOMATETREEMAP_1.getLabelFormatMode();	String	extended	Gibt zurück, welcher Modus für die Label-Formatierung verwendet wird.
getLimitDepth()	GRAPHOMATETREEMAP_1.getLimitDepth();	boolean	true	Gibt zurück, ob die Begrenzung der Hierarchie-Tiefe, die in der Treemap dargestellt wird, möglich ist.
getLocale()	GRAPHOMATETREEMAP_1.getLocale();	String	fr	Gibt die Einstellung zurück, die aktuell für locale gewählt ist.
getNegativeDeviationIsGood()	GRAPHOMATETREEMAP_1.getNegativeDeviationIsGood();	boolean	true	Gibt zurück, ob die negativen Abweichungen als positiv, oder als negativ interpretiert werden.
getNumberFormat()	GRAPHOMATETREEMAP_1.getNumberFormat();	String	0,0.0	Gibt das Nummernformat für den Basic-Modus zurück. Der Formatstring entspricht dem Format von numeral.js, siehe Handbuch.
getNumberFormatPercentage()	GRAPHOMATETREEMAP_1.getNumberFormatPercentage();	String	0 %	Gibt das Nummernformat für die Prozentwerte im Basic-Modus zurück. Der Formatstring entspricht dem Format von numeral.js, siehe Handbuch.
getRestPadding()	GRAPHOMATETREEMAP_1.getRestPadding();	int	3	Gibt die Breite der linken, rechten und unteren Seite des Rahmens zurück, der im embedded-Modus gezeichnet wird.
getSelectedMember(Dimension dimensionKey)	GRAPHOMATETREEMAP_1.getSelectedMember("0D_NWI_RCOD");	Member		Nachdem der User ein Element/eine Kategorie der Treemap 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.
getSelectedMemberKey(String dimensionKey)	GRAPHOMATETREEMAP_1.getSelectedMemberKey("0D_NWI_RCOD");	String	10274	Nachdem der User ein Element/eine Kategorie der Treemap geklickt hat, gibt diese Funktion den Schlüssel (Key) des Members der spezifizierten Dimension dimensionKey zurück. Die Schlüssel der Dimensionen sind in der Initial View ersichtlich.
getSelectedMemberText(String dimensionKey)	GRAPHOMATETREEMAP_1.getSelectedMemberText("0D_NWI_RCOD");	String	North West	Nachdem der User ein Element/eine Kategorie der Treemap geklickt hat, gibt diese Funktion den Text des Members der spezifizierten Dimension dimensionKey zurück. Die Rückgabe ist analog zu der Funktion getSelectedMemberKey().
getShowLegend()	GRAPHOMATETREEMAP_1.getShowLegend();	boolean	true	Gibt zurück, ob die Legende (oben links über der Treemap) angezeigt wird.
getShowTitle()	GRAPHOMATETREEMAP_1.getShowTitle();	boolean	true	Gibt zurück, ob der Titel angezeigt wird.
getTopPadding()	GRAPHOMATETREEMAP_1.getTopPadding();	int	15	Gibt die Breite der oberen Seite des Rahmens zurück, der im embedded-Modus gezeichnet wird.
getTitle()	GRAPHOMATETREEMAP_1.getTitle();	String	Sales in Mio. EUR\|2013 ACT and BUD\|North West	Gibt den Titel der Treemap als String wieder. Zeilenumbrüche werden durch einen senkrechten Strich (\|) repräsentiert.
getTooltipArea()	GRAPHOMATETREEMAP_1.getTooltipArea();	boolean	false	Gibt zurück, ob in den Tooltips die Area-Dimension und der Wert des Members der entsprechenden Fläche gezeichnet werden.
getTooltipDeviation()	GRAPHOMATETREEMAP_1.getTooltipDeviation();	boolean	false	Gibt zurück, ob in den Tooltips die Color-Dimension und der Wert des Members der entsprechenden Fläche gezeichnet werden.
getTooltipName()	GRAPHOMATETREEMAP_1.getTooltipName();	boolean	false	Gibt zurück, ob in den Tooltips der Name des Members der entsprechenden Fläche angezeigt wird.
getTooltipPath()	GRAPHOMATETREEMAP_1.getTooltipPath();	boolean	true	Gibt zurück, ob in den Tooltips die Hierarchie-Ebenen angezeigt werden.
getTooltipVisible()	GRAPHOMATETREEMAP_1.getTooltipVisible();	boolean	true	Gibt zurück, ob zur Laufzeit Tooltips zur Treemap angezeigt werden.
getUseFormattedData()	GRAPHOMATETREEMAP_1.getUsedFormattedData();	boolean	true	Gibt zurück, ob in der Query vorformatierte Daten zur Anzeige in den treemaps verwendet werden.

Setter Name	Beispiel	Beschreibung
setColorCalculationMethod(String val)	GRAPHOMATETREEMAP_1.setColorCalculationMethod("hierarchy");	Setzt die Methode nach der die Rechtecke der Treemap eingefärbt werden. Zulässige Werte für method sind: hierarchy, areaIdentity, colorIdentity, absoluteDeviation, percentDeviation.
setColorScheme(String val)	GRAPHOMATETREEMAP_1.setColorScheme("Set1, 4");	Ermöglicht das Setzen eines neuen ColorBrewer-Farbschemas und der Anzahl der Klassen. Beide Angaben müssen durch ein Komma separiert und in einem String übergeben werden.
setDepth(int level)	GRAPHOMATETREEMAP_1.setDepth(2);	Beschränkt die in der Treemap dargestellte Hierarchie-Tiefe auf den Wert level.
setDescriptionpArea(boolean val)	GRAPHOMATETREEMAP_1.setDescriptionArea(true);	Setzt, ob in den Beschriftungen der Rechtecke die Area-Dimension und der Wert des Members der entsprechenden Fläche angezeigt werden.
setDescriptionDeviation(boolean val)	GRAPHOMATETREEMAP_1.setDescriptionDeviation(true);	Setzt, ob in den Beschriftungen der Rechtecke die Color-Dimension und der Wert des Members der entsprechenden Fläche angezeigt werden.
setDescriptionName(boolean val)	GRAPHOMATETREEMAP_1.setDescriptionName(true);	Setzt, ob in den Beschriftungen der Rechtecke der Name des Members der entsprechenden Fläche angezeigt wird.
setDescriptionPath(boolean val)	GRAPHOMATETREEMAP_1.setDescriptionPath(false);	Setzt, ob in den Beschriftungen der Rechtecke die Hierarchie-Ebenen angezeigt werden.
setDescriptionVisible(boolean val)	GRAPHOMATETREEMAP_1.setDescriptionVisible(true);	Setzt, ob in den Treemaps Beschriftungen in den Rechtecken angezeigt werden.
setEmbedded(boolean val)	GRAPHOMATETREEMAP_1.setEmbedded(true);	Ermöglicht das Ein- und Ausschalten des embedded-Modus (Rahmen zur Anzeige der Hierarchie-Ebene).
setExtendedNumberFormat(String val)	GRAPHOMATETREEMAP_1.setExtendedNumberFormat("-\|\|.\|,\|1\|1\|");	Setzt das Nummernformat für den Extended Modus. Der Formatstring kann im Handbuch nachgelesen werden.
setExtendedNumberFormatPercentage(String val)	GRAPHOMATETREEMAP_1.setExtendedNumberFormatPercentage("-\|\|.\|,\|1\|1\|%25");	Setzt das Nummernformat für die Prozentwerte im Extended -Modus. Der Formatstring kann im Handbuch nachgelesen werden.
setHideOverflowingDescriptions(boolean val)	GRAPHOMATETREEMAP_1.setHideOverflowingDesicription(false);	Setzt, ob die überlaufenden Beschriftungen entfernt werden sollen.
setLabelFormatMode(String val)	GRAPHOMATETREEMAP_1.setLabelFormatMode("extended");	Setzt als String, welcher Modus für die Label-Formatierung verwendet wird. Hierbei stehen basic und extended zur Verfügung.
setLimitDepth(boolean val)	GRAPHOMATETREEMAP_1.setLimitDepth(false);	Setzt, ob die Begrenzung der Hierarchie-Tiefe angeschaltet ist.
setLocale(String val)	GRAPHOMATETREEMAP_1.setLocale("de");	Setzt einen neuen locale-Wert. Zulässige Werte für das locale sind: de, en, fr und auto. Wird auto ausgewählt, dann wird das locale aus der Query für die Formatierung der Texte hergenommen.
setNegativeDeviationIsGood(boolean val)	GRAPHOMATETREEMAP_1.setNegativeDeviationIsGood(true);	Setzt, ob die negativen Abweichungen als positiv, oder als negativ interpretiert werden sollen.
setNumberFormat(String val)	GRAPHOMATETREEMAP_1.setNumberFormat("0,0.0");	Setzt das Nummernformat für den Basic-Modus. Der Formatstring entspricht dem Format von numeral.js, siehe Handbuch.
setNumberFormatPercentage(String val)	GRAPHOMATETREEMAP_1.setNumberFormatPercentage("0 %");	Setzt das Nummernformat für die Prozentwerte im Basic-Modus. Der Formatstring entspricht dem Format von numeral.js, siehe Handbuch.
setRestPadding(int val)	GRAPHOMATETREEMAP_1.setRestPadding(1);	Setzt die Breite der linken, rechten und unteren Seite des Rahmens im embedded-Modus.
setShowLegend(boolean val)	GRAPHOMATETREEMAP_1.setShowLegend(true);	Setzt, ob die die Legende angezeigt werden soll.
setShowTitle(boolean val)	GRAPHOMATETREEMAP_1.setShowTitle(true);	Setzt, ob der Titel angezeigt werden soll.
setTopPadding(int val)	GRAPHOMATETREEMAP_1.setTopPadding(1);	Setzt, die Breite der oberen Seite des Rahmens im embedded-Modus.
setTitle(String val)	GRAPHOMATETREEMAP_1.setTitle("Sales in Mio. EUR\|2013 ACT and BUD\|North West");	Setzt den Titel der Treemap. Erwartet value als String. Zeilenumbrüche (\n) werden auch als solche interpretiert.
setTooltipArea(boolean val)	GRAPHOMATETREEMAP_1.setTooltipArea(true);	Setzt, ob in den Tooltips die Area-Dimension und der Wert des Members der entsprechenden Fläche angezeigt werden.
setTooltipDeviation(boolean val)	GRAPHOMATETREEMAP_1.setTooltipDeviation(true);	Setzt, ob in den Tooltips die Color-Dimension und der Wert des Members der entsprechenden Fläche angezeigt werden.
setTooltipName(boolean val)	GRAPHOMATETREEMAP_1.setTooltipName(true);	Setzt, ob in den Tooltips der Name des Members der entsprechenden Fläche angezeigt wird.
setTooltipPath(boolean val)	GRAPHOMATETREEMAP_1.setTooltipPath(false);	Setzt, ob in den Tooltips die Hierarchie-Ebenen angezeigt werden.
setTooltipVisible(boolean val)	GRAPHOMATETREEMAP_1.setTooltipVisible(true);	Setzt, ob in den Treemaps Tooltips angezeigt werden.
setUseFormattedData(boolean val)	GRAPHOMATETREEMAP_1.setUseFormattedData(true);	Setzt, ob die aus Designer vorformatierten Daten für die Tabelle verwendet werden. Dies ist nur möglich für die Werte, die aus der Query übergeben werden. Werte, die in der Tabelle selbst berechnet werden z.B. für die Abweichungen verwenden zur Formatierung weiterhin entweder das Basic oder das Extended Nummernformat.