Is triggered if the user clicks on an element on the chart at run-time. In order to allow a drilldown, it is necessary to react on the user input at this point.

The return values of the following functions are updated at the moment of the event:

• getSelectedMemberKey(), getSelectedMemberText(), getClickedElementIndex(), getClickedSeriesIndex()

Is triggered when the chart receives updated data. This is happening, for example, when the dimension of a Data Source or if a filter has been changed.
This would be the appropriate point to change Data Types or the Waterfall Calculation Path.

 getAxisLabels()

GRAPHOMATECHART_1.getAxisLabels();

String

Budget, Actual

Returns axis labels as a comma-separated string value.

getAxisThickness()

GRAPHOMATECHART_1.getAxisThickness();

Integer

3.0

Returns the axis thickness as an integer value.

getBarWidth()

GRAPHOMATECHART_1.getBarWidth();

Float

5.0

Returns the width of the bars as a float value.

getBaseChartVisible()

GRAPHOMATECHART_1.getBaseChartVisible();

Boolean

true

Returns whether the base chart is visible.

getCalculationPath()

GRAPHOMATECHART_1.getCalculationPath();

String

+,+,+,-,-,=, ,s+,+,=,-,-

Returns the waterfall calculation path as a comma-separated string value.

getCalculateDeviationsFromNull()

GRAPHOMATECHART_1.getCalculateDeviationsFromNull();

Boolean

true

Returns whether NULL values are used to calculate deviations.

getCategoryAxisVisible()

GRAPHOMATECHART_1.getCategoryAxisVisible();

Boolean

true

Returns whether the category axis is visible.

getCategoryCount()

GRAPHOMATECHART_1.getCategoryCount();

Integer

12

Returns whether the number of to be displayed categories is limited. Returns an integer value. A value of 0 means that there is no limitation.

getCategoryLabelRotation()

GRAPHOMATECHART_1.getCategoryLabelRotation();

Integer

45

Returns the rotation angle of the category labels.

getCategoryWidth()

GRAPHOMATECHART_1.getCategoryWidth();

Integer

20

Returns the width of the categories as an integer value if the Category Width is fixed.

getChartType()

GRAPHOMATECHART_1.getChartType();

String

line

Returns the chart type as a string-value.

getClickedElementIndex()

GRAPHOMATECHART_1.getClickedElementIndex();

Integer

3

Returns the index of the last clicked element/category.

getClickedPositionValue()

GRAPHOMATECHART_1.getClickedPositionValue();

Float

234234.432

Returns the relative value of the clicked position in the chart.
This can be utilized to create a zoom function, when the clicked value is passed back to the chart as the manual scale minimum.

getClickedSeriesIndex()

GRAPHOMATECHART_1.getClickedSeriesIndex();

Integer

1

Returns the index of the last clicked Data Series.

getComparisonGroup()

GRAPHOMATECHART_1.getComparisionGroup();

String

A

Returns the Comparison Group as a string value.

getDatatypes(Integer seriesIndex)

GRAPHOMATECHART_1.getDatatypes(1);

String

PY,PY,PY,PY,AC,AC,AC,AC,PL,PL,PL,PL

This function returns the Data Types of the selected Data Series seriesIndex as a comma-separated string.

getDeviationBadColor()

GRAPHOMATECHART_1.getDeviationBadColor();

String

#ff3300

This function returns the color used for "bad" deviations.

getDeviationGoodColor()

GRAPHOMATECHART_1.getDeviationGoodColor();

String

#2e2e2e

This function returns the color used for "good" deviations.

getDeviationVisibility()

GRAPHOMATECHART_1.getDeviationVisibility();

String

0,1,4

Returns a list of indexes of visible deviation charts as a comma-separated string.

getElementsOffset()

GRAPHOMATECHART_1.getElementsOffset();

Float

2.0

This function returns the offset between the elements of a category as a float value.

getEndingLineOverlap()

GRAPHOMATECHART_1.getEndingLineOverlap();

Integer

3

Returns how far the Ending Lines protrude over the bars.

 getEndingLineThickness()

GRAPHOMATECHART_1.getEndingLineThickness();

Integer

2

Returns the thickness of the Ending Lines.

getEndingLineVisible()

GRAPHOMATECHART_1.getEndingLineVisible();

Boolean

false

Returns whether to display Ending Lines above the bars.

getExtendedNumberFormat()

GRAPHOMATECHART_1.getExtendedNumberFormat();

String

-||.|,|1|1|%25

Returns the number format for the Extended Mode. The format string can be found in the manual.

-||.|,|1|1|%25

getFixedCategoryWidth()

GRAPHOMATECHART_1.getFixedCategoryWidth();

Boolean

true

This function returns a boolean value whether the Category Width is fixed.

getHighlightMode()

GRAPHOMATECHART_1.getHighlightMode();

String

single

This function returns the current setting for the highlight mode.

getLabelFormatMode()

GRAPHOMATECHART_1.getLabelFormatMode();

String

extended

Returns which mode is used for the label format.

getLabelPositioningMode()

GRAPHOMATECHART_1.getLabelPositioningMode();

String

auto

Returns the current label positioning mode.

getLockData()

GRAPHOMATECHART_1.getLockData();

Boolean

true

Returns whether this component ignores data updates.

getManualScalePercentMax()

GRAPHOMATECHART_1.getManualScalePercentMax();

Float

80.5

Returns the manual percentage scaling maximum as a float value.

getManualScalePercentMin()

GRAPHOMATECHART_1.getManualScalePercentMin();

Float

-80.5

Returns the manual percentage scaling maximum as a float value.

[{"startElement":1,"endElement":2,"startSeries":1,"endSeries":1}, {"startElement":3,"endElement":4,"startSeries":1,"endSeries":1}, {"startElement":5,"endElement":6,"startSeries":1,"endSeries":1}]

Returns a list of the current mulit highlights (highlighted values above the chart). Returns a JSON-string, which contains an array consisting of an object for each multi highlight. The following elements are part of an object (the order of these elements must be maintained): {"startElement":1,"endElement":2,"startSeries":1,"endSeries":1}.

getNegativeDeviationIsGood()

GRAPHOMATECHART_1.getNegativeDeviationIsGood();

Boolean

true

Returns whether the negative deviations are interpreted as positive or negative.

getNegativeOutlierThreshold()

GRAPHOMATECHART_1.getNegativeOutlierThreshold();

Float

-80.0

Returns the negative outlier threshold as a float value.

getNumberFormat()

GRAPHOMATECHART_1.getNumberFormat();

String

0,0.0

Returns the number format for the Basic Mode. The format string corresponds to the format numeral.js (see http://www.numeraljs.com).

getNumberFormatPercentage()

GRAPHOMATECHART_1.getNumberFormatPercentage();

String

0%

Returns the number format for the percentage values in the Basic Mode. The format string corresponds to the format numeral.js (see http://www.numeraljs.com).

getPositiveOutlierThreshold()

GRAPHOMATECHART_1.getPositiveOutlierThreshold();

Float

80.0

Returns the positive outlier threshold as a float value.

getSelectedMember(Dimension dimensionKey)

GRAPHOMATECHART_1.getSelectedMember();

Member

0D_NWI_RCOD

After the user clicked on an element/a category in the chart, this function returns the member of the specified dimension dimensionKey. The member provides different properties such as text, internalKey and externalKey.

getSelectedMemberKey(String dimensionKey)

GRAPHOMATECHART_1.getSelectedMemberKey("0D_NWI_RCOD");

String

10273

After the user clicked on an element/a category in the chart, this function returns the Key of the member of the selected dimension dimensionKey. 

getSelectedMemberText(String dimensionKey)

GRAPHOMATECHART_1.getSelectedMemberText("0D_NWI_RCOD");

String

North West

After the user clicked on an element/a category in the chart, this function returns the text of the member of the selected dimension dimensionKey. The return value is similar to the function getSelectedMemberKey().

getSeparatorLength()

GRAPHOMATECHART_1.getSeparatorLength();

Integer

5

Returns the length of the Seperators in pixels.

getSeparatorMode()

GRAPHOMATECHART_1.getSeparatorMode();

String

datatypes

Returns the Separator Mode.

getSeparatorPositions()

GRAPHOMATECHART_1.getSeparatorPositions();

String

2,4,6

Returns a list of (manual) set positions of Separators as comma-separated string value. 

getSeparatorSourceRowIndex()

GRAPHOMATECHART_1.getSeparatorSourceRowIndex();

Integer

3

Returns the index of the row/series, from which the Separators can be derived. This function is dependent on the Separator Mode (setSeperatorMode ()).

getSeparatorThickness()

GRAPHOMATECHART_1.getSeparatorThickness();

Integer

2

Returns the thickness of the Serators in pixels.

getSeries(Integer seriesIndex)

GRAPHOMATECHART_1.getSeries(1);

String

{"Keyfigures":"0D_NWI_NSAL"}

Returns the data description of the selected Data Series seriesIndex as JSON string.

getSeriesLabels()

GRAPHOMATECHART_1.getSeriesLabels();

String

Budget,Actual,Target 

Returns the series label of the chart as comma-separated string.

getShowAxisLabelsLeft()

GRAPHOMATECHART_1.getShowAxisLabelsLeft();

Boolean

true

Returns whether the Axis Labels are displayed on the left.

getShowAxisLabelsRight()

GRAPHOMATECHART_1.getShowAxisLabelsRight();

Boolean

true

Returns whether the Axis Labels are displayed on the right.

getShowCategoryLabels()

GRAPHOMATECHART_1.getShowCategoryLabels();

Boolean

false

Returns whether the Category Labels are displayed.

getShowDatatypesInAxis()

GRAPHOMATECHART_1.getShowDatatypesInAxis();

Boolean

true

Returns whether the Data Types are displayed in the axis or in the elements.

getShowTitle()

GRAPHOMATECHART_1.getShowTitle();

Boolean

true

Returns whether the title is displayed.

getSpaceFactorBaseChart()

GRAPHOMATECHART_1.getSpaceFactorBaseChart();

Float

0.8

Returns the proportional Space Factor of the Base Chart (relative to the other Space Factors).

getSpaceFactorDeviationChart()

GRAPHOMATECHART_1.getSpaceFactorDeviationChart();

Float

0.2

Returns the proportional Space Factor of the deviation chart (relative to the other Space Factors).

getStackedBarLabelPosition()

GRAPHOMATECHART_1.getStackedBarLabelPosition();

String

middle

Returns the position of the labels in the stacked bar chart.

getStackedBarNegativeValues()

GRAPHOMATECHART_1.getStackedBarNegativeValues();

Boolean

true

This function returns whether negative values are allowed in stacked bar charts.

getStackedBarSumsVisible()

GRAPHOMATECHART_1.getStackedBarSumsVisible();

Boolean

true

This function returns wehter sums are displayed in the stacked bars.

getStructureMode()

GRAPHOMATECHART_1.setStructureMode();

Boolean

true

This function returns whether a chart is currently in structure mode (identical to showStructureMode()).

getSuppressRepeatingCategoryLabels()

GRAPHOMATECHART_1.getSuppressRepeatingCategoryLabels();

String

true,true,false,false,true 

Returns the configuration of the property Suppress Repeating Category Labels. Returns a comma separated string value.

getSuppressZeroLabels()

GRAPHOMATECHART_1.getSuppressZeroLabels();

Boolean

true

Returns whether Zero Labels are displayed.

getSynchronizeAxesPosition()

GRAPHOMATECHART_1.getSynchronizeAxesPosition();

Boolean

true

This function returns a boolean value whether the axes positions are synchronized with the Comparison Group.

getSynchronizePadding()

GRAPHOMATECHART_1.getSynchronizePadding();

Boolean

false

This function returns a boolean value whether the padding of the chart is synchronized with the Comparison Group.

getSynchronizeScaling()

GRAPHOMATECHART_1.getSynchronizeScaling();

Boolean

true

The function returns a boolean value whether the scaling of the chart is synchronized with the Comparison Group.

getTitle()

GRAPHOMATECHART_1.getTitle();

String

Sales in Mio. EUR|

2013 ACT and BUD|

North West

Returns the title of the chart as a string value. A line break is represented with a pipe (|).

getUseOutlierThreshold()

GRAPHOMATECHART_1.getUseOutlierThreshold();

Boolean

true

Returns whether the Outlier Threshold is used.

Returns whether the Outlier Threshold is used.Returns whether the Outlier Threshold is used.getUserHighlightColor()

GRAPHOMATECHART_1.getUserHighlightColor();

String

#ff0000,#00ff00,#0000ffGibt eine

Liste der hinterlegten User Highlight Farben als kommaseparierten String zurück. Die Farben werden in der angegebenen Reihenfolge bei den User Highlights (zur Laufzeit hervorgehobene Werte) durchgeschaltet, bis die Wunschfarbe eingestellt istReturns a list of deposited colors for the User Hightlights as comma separated string-value. The colors are switched at each click (during runtime) until the desired color is set.

getUserHighlightList()

GRAPHOMATECHART_1.getUserHighlightList();

String

[[1,3],[2,3][1,5]]

Gibt eine Liste der aktuellen User Highlights (zur Laufzeit hervorgehobene Werte) als JSON-String zurück, der die Positionen der Highlights jeweils mit zwei Zahlen übergibt. Dabei gibt die erste Zahl die Datenreihe an, während die zweite Zahl die Position des Wertes in der Datenreihe darstelltReturns a list of the current user highlights (highlighted values at runtime). Returns a JSON-string, which passes the positions of each highlight with two numbers; the first number indicates the data series, while the second number represents the position of the value in the data series.

getValueAxisVisible()

GRAPHOMATECHART_1.getValueAxisVisible();

Boolean

trueGibt zurück, ob die Value Axis dargestellt wird oder nicht

Returns whether the value axis is visible or not.

getVisibleSeries()

GRAPHOMATECHART_1.getVisibleSeries();

String

0,1,4

Gibt eine Auflistung der Indices sichtbarer Serien als kommaseparierten String wiederReturns a list of indexes of visible series as comma-separated string. 

setCategoryAxisVisible(Boolean)

setCategoryWidth(Integer)

GRAPHOMATECHART_1.setCategoryWidth(3);

setComparisonGroup(String id)

Setzt die Sets the Comparison Group des Charts als String. Charts mit der gleichen Comparison Group werden gleich skaliert und ausgerichtet. Weitere Feinheiten können über die folgenden Parameter eingestellt werdenof the chart as a string. Charts with the same Comparison Group are equal scaled and aligned. More details can be set using the following parameters:
getSynchronizePadding(), setSynchronizePadding(), getSynchronizeScaling(), setSynchronizeScaling(), getSynchronizeAxesPosition(), setSynchronizeAxesPosition()

setDatatypeAt(Integer series, Integer index, String datatype)

Diese Funktion setzt die übergebene Datenart für ein einzelnes Element einer DatenserieThis function sets the passed datatype for a single element of the passed data series.

setDatatypeForSeries(Integer series, Integer count, String datatype)

GRAPHOMATECHART_1.setDatatypeForSeries(1, 5, "AC");Diese

Funktion setzt die übergebenen Datenarten für die übergebene Datenserie. Die Anzahl der generierten Datenarten-Einträge entspricht dem Übergabeparameter count.
Der AufrufThis function sets the passed datatype for the data series with the passed index. The number of datatype entries generated is governed by the parameter count.
The function call
GRAPHOMATECHART_1.setDatatypeForSeries(1, 5, "AC");
ist äquivalent mitis equivalent to
GRAPHOMATECHART_1.setDatatypeForSeries(1, "AC,AC,AC,AC,AC");

setDatatypes (Integer seriesIndex, String)

Beispiel: Datenarten der ersten fünf Elemente der ersten Datenserie auf „PP“ setzen

GRAPHOMATECHART_1.setDatatypes(1, "PP,PP,PP,PP,PP");

Mit dieser Funktion werden die Datenarten (Data Types) der angegebenen Datenserie seriesIndex gesetzt. Erwartet value als kommaseparierten String.
Beispiel: Datenarten der ersten fünf Elemente der ersten Datenserie auf „PP“ setzenThis function sets the Data Types of the selected Data Series seriesIndex. Expects value as comma-separated string.

GRAPHOMATECHART_1.setDeviationBadColor("#ff3300");Diese Funktion

setzt die Farbe, welche für “schlechte” Abweichungen benutzt wird. Es wird ein String im Format #ff3300 erwartetThis function sets the color used for „bad“ deviations. Expects a string value in the format #ff3300.

setDeviationGoodColor(String)

GRAPHOMATECHART_1.setDeviationGoodColor("#2e2e2e");

Diese Funktion setzt die Farbe, welche für “gute” Abweichungen benutzt wird. Es wird ein String im Format #2e2e2e erwartet.

setDeviationLabels(String labels, Boolean visibleOnly)

GRAPHOMATECHART_1.setDeviationLabels("Abs. Dev. FC,Perc. Dev. BUD", true);

Diese Funktion setzt die Beschriftungen aller Abweichungsserien. Wenn der zweite Wert auf true gesetzt wird, werden nur die sichtbaren/eingeblendeten Abweichungsserien berücksichtigt.

GRAPHOMATECHART_1.setDeviationVisibility("0,1");

Setzt die Auflistung der Indices sichtbarer Abweichungscharts. Erwartet value als kommaseparierten String.

setElementsOffset(Float)

Diese Funktion setzt das Offset zwischen den Elementen einer Kategorie. Werte kleiner oder gleich 1 werden als Prozent interpretiert.

setEndingLineOverlap(Integer)

GRAPHOMATECHART_1.setEndingLineOverlap(5)

Setzt, wie weit die Ending Lines über die Balken überstehen.

setEndingLineThickness(Integer)

GRAPHOMATECHART_1.setEndingLineThickness(3);

setEndingLineVisible(Boolean)

GRAPHOMATECHART_1.setEndingLineVisible(true);

Setzt, ob über den Balken Ending Lines angezeigt werden sollen.

setExtendedNumberFormat(String)

GRAPHOMATECHART_1.setExtendedNumberFormat("-||.|,|1|1|");

Setzt das Nummernformat für den Extended -Modus. Der Formatstring kann im Handbuch nachgelesen werden.

setExtendedNumberFormatPercentage(String)

GRAPHOMATECHART_1.setExtendedNumberFormatPercentage("-||.|,|1|1|%25");

Setzt das Nummernformat für die Prozentwerte im Extended -Modus. Der Formatstring kann im Handbuch nachgelesen werden.

setFixedCategoryWidth(Boolean)

GRAPHOMATECHART_1.setFixedCategoryWidth(true);

Diese Funktion setzt, ob die Kategoriebreite fix sein soll. Ist dieser Wert nicht gesetzt, wird die Breite automatisch ermittelt.

GRAPHOMATECHART_1.setHighlightEndIndex(4);

Setzt den Kategorienindex value des Endwertes der Hervorhebung. Analog zu setHightlightStartIndex().

die manuelle Skalierung auf 1.000.000 begrenzen
GRAPHOMATECHART_1.setManualScaleMaximum(1000000);

Setzt das Maximum der Skalierung des Base Charts auf den Integer-Wert max. Damit der Wert zum Tragen kommt, ist es erforderlich, dass der Skalierungsmodus auf Manual gesetzt ist
(siehe auch setScaleModeManual() und unter Scaling der Eigenschaftenbeschreibung).

die manuelle Skalierung bei 1.000.000 beginnen
GRAPHOMATECHART_1.setManualScaleMinimum(1000000);

Die MultiHighlights werden als JSON-String gesetzt, welcher ein Array enthält, in welchem für jedes Multihighlight ein Objekt enthalten ist. Das Objekt ist nach dem Schema
{"startElement":1,"endElement":2,"startSeries":1,"endSeries":1} aufgebaut.
Ein fertiger JSON-String kann dann beliebig viele Multi-Highlights enthalten.

setScaleModeAutomatic()

die Datenbeschreibung der ersten Datenserie auf den übergebenen Wert setzen
GRAPHOMATECHART_1.setSeries(1, '{"Keyfigures":"0D_NWI_NSAL"}');

Setzt die Datenbeschreibung der spezifizierten Datenserie seriesIndex. Erwartet value als JSON- String. Dieser String beschreibt entweder eine Zeile oder eine Spalte in der Initial View.
Der String kann ausgelesen werden, nachdem man mit der graphomate charts Extension im Property Sheet Daten für eine Datenserie selektiert hat.

GRAPHOMATECHART_1.setShowAxisLabelsLeft(true);

den Titel auf den übergebenen String setzen
GRAPHOMATECHART_1.setTitle("Sales in Mio. EUR|2013 ACT and BUD|North West");

nur die Datenserien mit den Indices 1 und 2 anzeigen
GRAPHOMATECHART_1.setVisibleSeries("1,2");