Versions Compared

Old Version 2

changes.mady.by.user Konradin Schoemers

Saved on

compared with

New Version Current

changes.mady.by.user Tim Schauder

Saved on

Key

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

...

classpdfExportLandscape

Skript-Dokumentation der graphomate charts für SAP BusinessObjects Design Studio

Introduction

The graphomate charts extension supports the scripting language of Design Studio. Therefore, it is possible to determine properties of the extension at run-time. New data can be set, titles can be adapted and scales be changed. Furthermore, it is possible to use drilldown functionalities of the extension and thus create interactive dashboards.
This document provides a list of available functions, events and examples. We are steadily working on expanding the range of functions. If you miss certain functions, please give us a note. Therefore you can use our online form under http://www.graphomate.com/en/feedback.

Events

The following events are available. User-made scripts can be deposited on the Property Sheet under the point Events.

...

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.

Functions

The following functions are available in the graphomate charts extension. They can be addressed in the scripting editor of Design Studio.

Guideline to umlauts, special characters and blank spaces

In general umlauts, special characters and blank spaces Umlauts are percent encoded for technical reasons in the Advanced Property Sheet (see: http://en.wikipedia.org/wiki/Percent-encoding).

Example:
Nestlé - Development of sales in % compared to the previous year
becomes:
Nestl%C3%A9%20 %20Development%20of%20sales%20in%20%25%20compared%20to%20the%20previous%20year

This makes it necessary to percent encode string values even while transferring them from the scripting language or Standard PropertySheet. (On the Internet there are many free tools for en-/decoding, for example: http://www.url-encode-decode.com/.)

...

 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+,+,=,-,-

...




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.

Beispiele

Mit Hilfe einer Dropdown-Box eine Datasource dynamisch Filtern
Um auf einer Dimension einer Data Source dynamisch zu filtern, muss zuerst eine Dropdown-Box mit allen zulässigen Werten befüllt werden, damit der User aus dieser später dann seine Wahl treffen kann.
Dafür wird auf dem Canvas-Event On Startup von der gewünschten Data Source mit getMemberList eine Liste aller Member der Dimension 0D_NWI_ACOD geholt. Die Parameter von getMemberList werden dabei vom Autocomplete vorgeschlagen.
Die so erlangte Liste kann dann per setItem auf die Dropdown-Box gesetzt werden.
DROPDOWN_1.setItems (DS_1.getMemberList("0D_NWI_ACOD",
MemberPresentation.EXTERNAL_KEY, MemberDisplay.TEXT, 20);
Nun wird die Dropdown-Box beim Applikations-Start mit den Membern der Dimension 0D_NWI_ACOD befüllt.
Selektiert nun ein User ein Element aus der Liste, kann mit folgendem Skript, welches auf das Ereignis On Element Clicked der Dropdown-Box gelegt wird, der Filter der Data Source angepasst werden:
Div
classpdfExportLandscape

Scripting Documentation for graphomate charts for SAP Lumira Designer

Rev. 2021.2 as of May 2021

Div
classnoprint

PDF

Introduction

The graphomate charts extension supports the scripting language of Designer. Therefore, it is possible to determine properties of the extension at run-time. New data can be set, titles can be adapted and scales be changed. Furthermore, it is possible to use drilldown functionalities of the extension and thus create interactive dashboards.
This document provides a list of available functions, events and examples. We are steadily working on expanding the range of functions. If you miss certain functions, please give us a note. Therefore you can use our online form. 

Events

The following events are available. User-made scripts can be deposited on the Standard Properties Sheet under the point Events.


Event namedescription
On Element Clicked

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()

On new data arrival

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.

Functions

The following functions are available in the graphomate charts extension. They can be addressed in the scripting editor of Designer.

Guideline to umlauts, special characters and blank spaces

In general umlauts, special characters and blank spaces Umlauts are percent encoded for technical reasons in the Additional Properties Sheet (see: http://en.wikipedia.org/wiki/Percent-encoding).

Example:
Nestlé - Development of sales in % compared to the previous year
becomes:
Nestl%C3%A9%20 %20Development%20of%20sales%20in%20%25%20compared%20to%20the%20previous%20year

This makes it necessary to percent encode string values even while transferring them from the scripting language or Standard Properties Sheet. (On the Internet there are many free tools for en-/decoding, for example: http://www.url-encode-decode.com/.)


getSelectedMemberText(String dimensionKey)
Getter Nameexamplereturn typeexample return valuedescription

getAxisLabels()

GRAPHOMATECHART_1.getAxisLabels();

String

Budget, Actual

Returns axis labels as a comma-separated string value.

getCalculateDeviationsFromNullgetAxisThickness()

GRAPHOMATECHART_1.getCalculateDeviationsFromNullgetAxisThickness();

BooleanInteger

true

Returns whether NULL values are used to calculate deviations.

getCategoryAxisVisible3.0

Returns the axis thickness as an integer value.

getBarWidth()

GRAPHOMATECHART_1.getCategoryAxisVisiblegetBarWidth();

BooleanFloattrue

5.0

Returns whether the category axis is visible.getCategoryCountthe width of the bars as a float value.

getBaseChartVisible()

GRAPHOMATECHART_1.getCategoryCountgetBaseChartVisible();

IntegerBoolean

12true

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.getCategoryLabelRotationbase chart is visible.

getCalculationPath()

GRAPHOMATECHART_1.

getCategoryLabelRotation

getCalculationPath();

Integer

45

Returns the rotation angle of the category labels.

getCategoryWidthString

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

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

getCalculateDeviationsFromNull()

GRAPHOMATECHART_1.getCategoryWidthgetCalculateDeviationsFromNull();

IntegerBoolean

20

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

getChartTypetrue

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.getChartTypegetCategoryCount();

StringInteger

line12

Returns the chart type as a string-value.getClickedElementIndexwhether 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.getClickedElementIndexgetCategoryLabelRotation();

Integer

345

Returns the index rotation angle of the last clicked element/ category labels.

getClickedPositionValuegetCategoryWidth()

GRAPHOMATECHART_1.getClickedPositionValuegetCategoryWidth();

FloatInteger

234234.43220

Returns the relative value width 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.getClickedSeriesIndexcategories as an integer value if the Category Width is fixed.

getChartType()

GRAPHOMATECHART_1.getClickedSeriesIndexgetChartType();

IntegerString

1line

Returns the index of the last clicked Data Serieschart type as a string-value.

getComparisonGroupgetClickedElementIndex()

GRAPHOMATECHART_1.getComparisionGroupgetClickedElementIndex();

StringInteger

A3

Returns the Comparison Group as a string valueindex of the last clicked element/category.

getDatatypesgetClickedPositionValue(Integer seriesIndex)

GRAPHOMATECHART_1.getDatatypesgetClickedPositionValue(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.

getDeviationBadColorFloat

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.getDeviationBadColorgetClickedSeriesIndex();

StringInteger

#ff3300

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

getDeviationGoodColor1

Returns the index of the last clicked Data Series.

getComparisonGroup()

GRAPHOMATECHART_1.getDeviationGoodColorgetComparisionGroup();

String

#2e2e2eA

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

getDeviationVisibility(Returns the Comparison Group as a string value.

getContextMenuCustomEventName(Integer index)GRAPHOMATECHART_1.getDeviationVisibilitygetContextMenuCustomEventName(1);String0,Custom Entry 1,4Returns a list of indexes of visible deviation charts as a comma-separated string.getElementsOffset(the name of a specified custom event (Index-1 based) in the Context Menu.

getContextMenuCustomEventVisibility(Integer  index)

GRAPHOMATECHART_1.getElementsOffsetgetContextMenuCustomEventVisibility(1);FloatBoolean

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(trueReturns the visibility of a specified custom event (Index-1 based) in the Context Menu.

getContextMenuOptionVisibility(Integer index)

GRAPHOMATECHART_1.getEndingLineThicknessgetContextMenuOptionVisibility(1);IntegerBoolean2trueReturns the thickness visibility of the Ending Lines.

getEndingLineVisible()

GRAPHOMATECHART_1.getEndingLineVisible();

Boolean

false

Returns whether to display Ending Lines above the bars.

getExtendedNumberFormat(a specified option in the Context Menu. Use the following indices to access the options: 1 for Sorting, 2 for Filters, 3 for Context Sensitive Filters, 4 for Filter and Hide, 5 for Clear Filters, 6 for Drilldown, 7 for Drillup, 8 for Zero Display, 9 for Member Display, 10 for Position of Totals, 11 for Total Display.

getDatatypes(Integer seriesIndex)

GRAPHOMATECHART_1.getExtendedNumberFormatgetDatatypes(1);

String

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

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

getExtendedNumberFormatPercentage

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.

getExtendedNumberFormatPercentage

getDeviationBadColor();

String

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

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

getFixedCategoryWidth#ff3300

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

getDeviationGoodColor()

GRAPHOMATECHART_1.getFixedCategoryWidthgetDeviationGoodColor();

BooleanString

true#2e2e2e

This function returns a boolean value whether the Category Width is fixed.getHighlightModethe color used for "good" deviations.

getDeviationVisibility()

GRAPHOMATECHART_1.getHighlightModegetDeviationVisibility();

String

single

This function returns the current setting for the highlight mode.

getLabelFormatMode0,1,4

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

getDisplaySmallMultiples()GRAPHOMATECHART_1.getLabelFormatModegetDisplaySmallMultiples();String

extended

Returns which mode is used for the label format.

getLabelPositioningMode"row", "column" or "none"Returns the type of the first dimension at which the small multiples are to be calculated.

getElementsOffset()

GRAPHOMATECHART_1.getLabelPositioningModegetElementsOffset();

StringFloat

auto

Returns the current label positioning mode.

getLockData2.0

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

getEndingLineOverlap()

GRAPHOMATECHART_1.getLockDatagetEndingLineOverlap();

BooleanInteger

true

Returns whether this component ignores data updates.

getManualScalePercentMax3

Returns how far the Ending Lines protrude over the bars.

 getEndingLineThickness()

GRAPHOMATECHART_1.getManualScalePercentMaxgetEndingLineThickness();

FloatInteger

80.52

Returns the manual percentage scaling maximum as a float valuethickness of the Ending Lines.

getManualScalePercentMingetEndingLineVisible()

GRAPHOMATECHART_1.getManualScalePercentMingetEndingLineVisible();

Float

-80.5Boolean

false

Returns the manual percentage scaling maximum as a float value.

getMulitHighlights

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.

getExtendedNumberFormatPercentage()GRAPHOMATECHART_1.getMultiHighlightsgetExtendedNumberFormatPercentage();String

[{"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-||.|,|1|1|%25

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

getFixedCategoryWidth()

GRAPHOMATECHART_1.getFixedCategoryWidth();

Boolean

true

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

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

getHighlightMode()

GRAPHOMATECHART_1.getNegativeOutlierThresholdgetHighlightMode();

Float

-80.0

Returns the negative outlier threshold as a float value.

getNumberFormatString

single

This function returns the current setting for the highlight mode.

getLabelFormatMode()

GRAPHOMATECHART_1.getNumberFormatgetLabelFormatMode();

String

0,0.0extended

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

getLabelPositioningMode()

GRAPHOMATECHART_1.getLabelPositioningMode();

String

auto

Returns the current label positioning mode.

getLockData()

GRAPHOMATECHART_1.getNumberFormatPercentagegetLockData();

StringBoolean

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).

getPositiveOutlierThresholdtrue

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.getPositiveOutlierThresholdgetManualScalePercentMin();

Float

-80.05

Returns the positive outlier threshold manual percentage scaling maximum as a float value.getSelectedMember

getMultiHighlights(Dimension dimensionKey)GRAPHOMATECHART_1.getSelectedMembergetMultiHighlights();

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. 

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.

getSeparatorModeString

[{"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 multi 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.getSeparatorModegetNegativeDeviationIsGood();

StringBoolean

datatypestrue

Returns the Separator Modewhether the negative deviations are interpreted as positive or negative.

getSeparatorPositionsgetNegativeOutlierThreshold()

GRAPHOMATECHART_1.getSeparatorPositionsgetNegativeOutlierThreshold();

String

2,4,6

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

getSeparatorSourceRowIndexFloat

-80.0

Returns the negative outlier threshold as a float value.

getNumberFormat()

GRAPHOMATECHART_1.getSeparatorSourceRowIndexgetNumberFormat();

Integer

3String

0,0.0

Returns the index of the row/series, from which the Separators can be derived. This function is dependent on the Separator Mode (setSeperatorMode ()).getSeparatorThicknessnumber format for the Basic Mode. The format string corresponds to the format numeral.js (see http://www.numeraljs.com).

getNumberFormatPercentage()

GRAPHOMATECHART_1.getSeparatorThicknessgetNumberFormatPercentage();

IntegerString

20%

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(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.

getProperty(String)GRAPHOMATECHART_1.getSeriesLabelsgetProperty("labelFormatMode");StringBudget,Actual,Target any valueReturns the series label value of the chart as comma-separated stringgiven property as a string representation.
getShowAxisLabelsLeftgetRulesets()GRAPHOMATECHART_1.getShowAxisLabelsLeftgetRulesets();BooleanStringtrueRuleset1,Ruleset2Returns whether the Axis Labels are displayed on the left.getShowAxisLabelsRight(the list of rulesets used by the chart.

getSelectedMember(Dimension dimensionKey)

GRAPHOMATECHART_1.getShowAxisLabelsRightgetSelectedMember();

Boolean

true

Returns whether the Axis Labels are displayed on the right.

getShowCategoryLabels(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.getShowCategoryLabels(getSelectedMemberKey("0D_NWI_RCOD");

BooleanString

false10273

Returns whether the Category Labels are displayed.

getShowDatatypesInAxis(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.getShowDatatypesInAxis(getSelectedMemberText("0D_NWI_RCOD");

BooleanString

trueNorth West

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

getShowTitle()

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.getShowTitlegetSeparatorLength();

BooleanInteger

true5

Returns whether the title is displayedthe length of the Seperators in pixels.

getSpaceFactorBaseChartgetSeparatorMode()

GRAPHOMATECHART_1.getSpaceFactorBaseChartgetSeparatorMode();

FloatString

0.8datatypes

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

getSpaceFactorDeviationChartgetSeparatorPositions()

GRAPHOMATECHART_1.getSpaceFactorDeviationChartgetSeparatorPositions();

FloatString

0.2,4,6

Returns the proportional Space Factor of the deviation chart (relative to the other Space Factors).getStackedBarLabelPositiona list of (manual) set positions of Separators as comma-separated string value. 

getSeparatorSourceRowIndex()

GRAPHOMATECHART_1.getStackedBarLabelPositiongetSeparatorSourceRowIndex();

StringInteger

middle3

Returns the position index 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.

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

getSeparatorThickness()

GRAPHOMATECHART_1.getStackedBarSumsVisiblegetSeparatorThickness();

BooleanInteger

true

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

getStructureMode(2

Returns the thickness of the Serators in pixels.

getSeries(Integer seriesIndex)

GRAPHOMATECHART_1.setStructureModegetSeries(1);

Boolean

true

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

getSuppressRepeatingCategoryLabelsString

{"Keyfigures":"0D_NWI_NSAL"}

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

getSeriesLabels()

GRAPHOMATECHART_1.getSuppressRepeatingCategoryLabelsgetSeriesLabels();

String

trueBudget,true,false,false,true Actual,Target 

Returns the configuration series label of the property Suppress Repeating Category Labels. Returns a comma chart as comma-separated string value.

getSuppressZeroLabelsgetShowAxisLabelsLeft()

GRAPHOMATECHART_1.getSuppressZeroLabelsgetShowAxisLabelsLeft();

Boolean

true

Returns whether Zero the Axis Labels are displayed on the left.

getSynchronizeAxesPositiongetShowAxisLabelsRight()

GRAPHOMATECHART_1.getSynchronizeAxesPositiongetShowAxisLabelsRight();

Boolean

true

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

getSynchronizePaddingReturns whether the Axis Labels are displayed on the right.

getShowCategoryLabels()

GRAPHOMATECHART_1.getSynchronizePaddinggetShowCategoryLabels();

Boolean

false

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

getSynchronizeScalingReturns whether the Category Labels are displayed.

getShowDatatypesInAxis()

GRAPHOMATECHART_1.getSynchronizeScalinggetShowDatatypesInAxis();

Boolean

true

The function returns a boolean value Returns whether the scaling of the chart is synchronized with the Comparison Group.getTitleData Types are displayed in the axis or in the elements.

getShowTitle()

GRAPHOMATECHART_1.getTitlegetShowTitle();

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 (|).

getUseOutlierThresholdBoolean

true

Returns whether the title is displayed.

getShowTooltips()GRAPHOMATECHART_1.getUseOutlierThresholdgetShowTooltips();BooleantruefalseReturns whether the Outlier Threshold is used.Returns whether the Outlier Threshold is used.Returns whether the Outlier Threshold is used.getUserHighlightColortooltips are displayed in runtime mode.
getSmallMultiplesMinWidth()GRAPHOMATECHART_1.getUserHighlightColorgetSmallMultiplesMinWidth();

String

#ff0000,#00ff00,#0000ff

Returns 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.

getUserHighlightListInteger300Returns the minimum width in px for each "Small Multiple" instance.
getSmallMultiplesMinHeight()GRAPHOMATECHART_1.getSmallMultiplesMinHeight()Integer300Returns the minimum height in px for each "Small Multiple" instance.
getSmallMultiplesNCount()GRAPHOMATECHART_1.getUserHighlightListgetSmallMultiplesNCount();String

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

Returns 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"None",  "1", "2",  "3" or "4" , etc..Returns the number of top N members (without remainder and sum members).

getSpaceFactorBaseChart()

GRAPHOMATECHART_1.getValueAxisVisiblegetSpaceFactorBaseChart();

BooleanFloattrue

0.8

Returns whether the value axis is visible or not.getVisibleSeriesthe proportional Space Factor of the Base Chart (relative to the other Space Factors).

getSpaceFactorDeviationChart()

GRAPHOMATECHART_1.getVisibleSeriesgetSpaceFactorDeviationChart();

StringFloat

0,1,4.2

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

refresh(string value)
Redraws the chart. This is a workaround in case the chart has not been refreshed after data has changed at run-time by the impact of the scripting language on the Data Source. This could happen, for example, when filters have been changed, dimensions have been added or removed.

If the chart should unexpectedly not refresh, this command should help:
GRAPHOMATECHART_1.refresh(GRAPHOMATECHART_1.refreshValue());

It is absolutely necessary to pass the value of refreshValue() as parameter val!

refreshValue()
Help function for refresh(). It has no further use.

scalingHelperMode(string value)
Sets the Scaling Helper. Valid values are none, line, area.
Example: activate the Scaling Helper
GRAPHOMATECHART_1.scalingHelperMode("line");

Setter NameBeispielBeschreibung
scalingHelperMode(string value)activate the Scaling HelperSets the Scaling Helper. Valid values are none, line, area.
setAxisLabels(String)GRAPHOMATECHART_1.setAxisLabels("Net Sales,Returns");Sets the axes labels of the chart. Expects value as comma-separated string. The first value is interpreted as left axis label, the second as right axis label.
setAxisThickness(Integer) GRAPHOMATECHART_1.setAxisThickness(3);Sets the axes thickness.
setBarWidth(Float)GRAPHOMATECHART_1.setBarWidth(3);Sets the width of the bars as a float value. Values less than or equal to 1 are interpreted as percentages.
setBaseChartVisible(Boolean)GRAPHOMATECHART_1.setBaseChartVisible(true);Sets whether the base chart is visible.
setCalculationPath(String)GRAPHOMATECHART_1.setCalculationPath("+,+,+,-,-,=, ,s+,+,=,-,-");Sets the Waterfall Calculation Path. Expects value as comma-separated string.
setCalculateDeviationsFromNull (Booleanl)GRAPHOMATECHART_1.setCalculateDeviationsFromNull(true);This function sets whether NULL values are used to calculate deviations.

setCategoryAxisVisible(Boolean)

GRAPHOMATECHART_1.setCategoryAxisVisible(true);Sets whether the base chart is visible.
setCategoryCount(Integer)GRAPHOMATECHART_1.setCategoryCount(12);Sets a limit on the number of displayed category. A value of 0 removes the restriction.
setCategoryLabelRotation(int rotation)GRAPHOMATECHART_1.setCategoryLabelRotation(45);Rotates the category labels according to the passed angle. Rotation takes place counter-clockwise.

setCategoryWidth(Integer)

GRAPHOMATECHART_1.setCategoryWidth(3);

This function sets the width of the categories. But it is only interpreted when fixedCategoryWidth is set.
setChartType(String)GRAPHOMATECHART_1.setChartType("line");Sets the chart type. The following string values are allowed: bar, line, offsetbar, waterfall, pin, stackedbar.

setComparisonGroup(String id)

GRAPHOMATECHART_1.setComparisonGroup("A");

Sets the Comparison Group of 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)

GRAPHOMATECHART_1.setDatatypeAt(1, 1, "AC");

This 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");

This 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");
is 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");

This function sets the Data Types of the selected Data Series seriesIndex. Expects value as comma-separated string.

setDeviationBadColor(String)

GRAPHOMATECHART_1.setDeviationBadColor("#ff3300");

This 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.

setDeviationVisibility (String)

GRAPHOMATECHART_1.setDeviationVisibility("0,1");

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

setElementsOffset(Float)

GRAPHOMATECHART_1.setElementsOffset(5);

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);

Setzt, wie dick die Ending Lines sind.

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.

setHighlightEndIndex(Integer) 

GRAPHOMATECHART_1.setHighlightEndIndex(4);

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

setHighlightEndSeries(Integer) GRAPHOMATECHART_1.setHighlightEndSeries(3);Setzt den Serienindex value der Endserie der Hervorhebung. Analog zu setHightlightStartSeries().
setHighlightMode(String)GRAPHOMATECHART_1.setHighlightMode("single");Mit dieser Funktion kann der Highlight Mode geändert werden. Gültige Übergabewerte sind none, single und multi.
setHighlightStartIndex(Integer)GRAPHOMATECHART_1.setHighlightStartIndex(0);Setzt den Kategorienindex value des Startwertes der Hervorhebung. Analog zu setHightlightEndIndex().
setHighlightStartSeries(Integer) GRAPHOMATECHART_1.setHighlightStartSeries(1);Setzt den Serienindex value der Startserie der Hervorhebung. Analog zu setHightlightEndSeries().
setLabelFormatMode(String)GRAPHOMATECHART_1.setLabelFormatMode("extended");Setzt als String, welcher Modus für die Label-Formatierung verwendet wird. Hierbei stehen basic und extended zur Verfügung.
setLabelPositioningMode(String)GRAPHOMATECHART_1.setLabelPositioningMode("auto");Diese Funktion setzt den Label Positioning Mode. Gültige Übergabewerte sind none (Labels werden ausgeblendet), fix (Labels werden direkt am dazugehörigen Element positioniert, können sich aber ggf. überschneiden) und auto (Labels überschneiden sich nicht, werden aber ggf. verschoben bzw. ausgeblendet).
setLockData(Boolean)GRAPHOMATECHART_1.setLockData(true);Setzt, ob die Komponente Daten-Updates ignorieren soll.
setManualScaleMaximum(Integer max)

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).

setManualScaleMaximumFloat(Float max)GRAPHOMATECHART_1.setManualScaleMaximumFloat(1000000);Setzt das Maximum der Skalierung des Base Charts auf den Float-Wert max. Damit der Wert zum Tragen kommt, ist es erforderlich, dass der Skalierungsmodus auf Manual gesetzt ist (siehe auch setScaleModeManual() und den Punkt Scaling der Eigenschaftenbeschreibung). Diese Funktion ist eine Alternative zu setManualScaleMaximum(), falls nur Float-Werte zur Verfügung stehen.
setManualScaleMinimum(Integer min)

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

Setzt das Minimum der Skalierung des Base Charts auf den Integer-Wert min. Damit der Wert zum Tragen kommt, ist es erforderlich, dass der Skalierungsmodus auf Manual gesetzt ist (siehe auch setScaleModeManual() und den Punkt Scaling der Eigenschaftenbeschreibung).
setManualScaleMinimumFloat(Float minGRAPHOMATECHART_1.setManualScaleMinimumFloat(1000000);Setzt das Minimum der Skalierung des Base Charts auf den Float-Wert min. Damit der Wert zum Tragen kommt, ist es erforderlich, dass der Skalierungsmodus auf Manual gesetzt ist (siehe auch setScaleModeManual() und den Punkt Scaling der Eigenschaftsbeschreibung). Diese Funktion ist eine Alternative zu setManualScaleMinimum(), falls nur Float-Werte zur Verfügung stehen.
setManualScalePercentMax(Float)GRAPHOMATECHART_1.setManualScalePercentageMax(80);Setzt das manuelle prozentuale Skalierungsmaximum als Float-Wert.
setManualScalePercentMin(Float)GRAPHOMATECHART_1.setManualScalePercentageMin(-80);Setzt das manuelle prozentuale Skalierungsminimum als Float-Wert.
setMulitHighlights(String)GRAPHOMATECHART_1.setMultiHighlights("[{"startElement":1,"endElement":2,"startSeries":1,"endSeries":1}, {"startElement":3,"endElement":4,"startSeries":1,"endSeries":1}, {"startElement":5,"endElement":6,"startSeries":1,"endSeries":1}] ");

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.

setNegativeDeviationIsGood(Boolean)GRAPHOMATECHART_1.setNegativeDeviationIsGood(true);Setzt, ob die negativen Abweichungen als positiv, oder als negativ interpretiert werden sollen.
setNegativeOutlierThreshold(Float)GRAPHOMATECHART_1.setNegativeOutlierThreshold(-80);Setzt die negative Ausreißergrenze.
setNumberFormat(String)GRAPHOMATECHART_1.setNumberFormat("0,0.0");Setzt das Nummernformat für den Basic-Modus. Der Formatstring entspricht dem Format von numeral.js, einzusehen unter http://www.numeraljs.com.
setNumberFormatPercentage(String)GRAPHOMATECHART_1.setNumberFormatPercentage("0 %");Setzt das Nummernformat für die Prozentwerte im Basic-Modus. Der Formatstring entspricht dem Format von numeral.js, einzusehen unter http://www.numeraljs.com.
setPositiveOutlierThreshold(Float)GRAPHOMATECHART_1.setPositiveOutlierThreshold(80);Setzt die positive Ausreißergrenze.

setScaleModeAutomatic()

GRAPHOMATECHART_1.setScaleModeAutomatic();Setzt den Skalierungsmodus des Base Charts auf Automatic.
setScaleModeManual()GRAPHOMATECHART_1.setScaleModeManual();Setzt den Skalierungsmodus des Base Charts auf Manual.
setScalingHelperValue(Integer)GRAPHOMATECHART_1.setScalingHelperValue(500);Setzt die Position des Skalierungshelfers. Erwartet die Position value als Integer-Wert.
setScalingHelperValueFloat(Float) GRAPHOMATECHART_1.setScalingHelperValueFloat(500);Setzt die Position des Skalierungshelfers. Erwartet die Position value als Float-Wert.
setSeparatorLength(Integer)GRAPHOMATECHART_1.setSeparatorLength(5);Setzt die Länge der Trennzeichen (Separators) in Pixeln.
setSeparatorMode(String)GRAPHOMATECHART_1.setSeparatorMode("datatypes");Setzt den Separator Mode. Gültige Werte sind: none, categorylabels, datatypes, manually.
setSeparatorPositions(String)GRAPHOMATECHART_1.setSeparatorPositions("100,200,300");Setzt die Trennzeichenpositionen des Charts. Erwartet value als kommaseparierten String.
setSeparatorSourceRowIndex(Integer)GRAPHOMATECHART_1.setSeparatorSourceRowIndex(3);Setzt den Index der Zeile/Serie, aus der sich die Trennzeichen (Separators) ableiten. Abhängig vom Separator-Mode (setSeperatorMode()).
setSeparatorThickness(Integer)GRAPHOMATECHART_1.setSeparatorThickness(3);Setzt die Dicke der Trennzeichen (Separators) in Pixeln.
setSeries(Integer seriesIndex, String)

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.

setSeriesLabels(String)GRAPHOMATECHART_1.setSeriesLabels("Series1,Series2");Setzt die Serienlabels des Charts. Erwartet value als kommaseparierten String.
setShowAxisLabelsLeft(Boolean)

GRAPHOMATECHART_1.setShowAxisLabelsLeft(true);

Setzt, ob die Achsenbeschriftungen auf der linken Seite angezeigt werden sollen.
setShowAxisLabelsRight(Boolean)GRAPHOMATECHART_1.setShowAxisLabelsRight(true);Setzt, ob die Achsenbeschriftungen auf der rechten Seite angezeigt werden sollen.
setShowCategoryLabels(Boolean)GRAPHOMATECHART_1.setShowCategoryLabels(true);Setzt, ob die Kategoriebeschriftungen (Category Labels) angezeigt werden sollen.
setShowDatatypesInAxis(Boolean)GRAPHOMATECHART_1.setShowDatatypesInAxis(true);Setzt, ob die Datenarten (Data Types) in der Achse angezeigt werden sollen.
setShowTitle(Boolean)GRAPHOMATECHART_1.setShowTitle(true);Setzt, ob der Titel angezeigt werden soll.
setSpaceFactorBaseChart(Float)GRAPHOMATECHART_1.setSpaceFactorBaseChart(0.8);Setzt den Platz-Faktor, welchen das Base Chart anteilig (im Verhältnis zu den anderen Platz-Faktoren) einnimmt.
setSpaceFactorDeviationChart(Float)GRAPHOMATECHART_1.setSpaceFactorDeviationChart(0.2);Setzt den Platz-Faktor, welchen ein Abweichungschart anteilig (im Verhältnis zu den anderen Platz-Faktoren) einnimmt.
setStackedBarLabelPosition(String)GRAPHOMATECHART_1.setStackedBarLabelPosition("middle");Setzt die Position der Labels im Stapel. Gültige Werte sind middle und right.
setStackedBarNegativeValues(Boolean)GRAPHOMATECHART_1.setStackedBarNegativeValues(true);Setzt, ob negative Stapel erlaubt sein sollen.
setStackedBarSumsVisible(Boolean)GRAPHOMATECHART_1.setStackedBarSumsVisible(true);Setzt, ob die Summen auf den Stapelbalken angezeigt werden sollen.
setStructureMode(Boolean)GRAPHOMATECHART_1.setStructureMode(true);Mit dieser Funktion kann ein Diagramm in den Structure Mode (true) bzw. den Time Mode (false) gesetzt werden.
setSuppressRepeatingCategoryLabels(String)GRAPHOMATECHART_1.setSuppressZeroLabels("true,false,false,true");Diese Funktion setzt die Einstellung für die Eigenschaft Suppress Repeating Category Labels. Es wird pro benötigter Zeile eine Angabe benötigt, die besagt, ob wiederholende Kategoriebeschriftungen ausgeblendet werden sollen.
setSuppressZeroLabels(Boolean)GRAPHOMATECHART_1.setSuppressZeroLabels(true);Diese Funktion setzt, ob Null-Labels angezeigt werden sollen.
setSynchronizeAxesPosition(Boolean)GRAPHOMATECHART_1.setSynchronizeAxesPosition(true);Diese Funktion setzt, ob die Achsenpositionen des Charts mit der Comparison Group abgeglichen werden sollen.
setSynchronizePadding(Boolean)GRAPHOMATECHART_1.setSynchronizePadding(true);Diese Funktion setzt, ob die Ränder des Charts mit der Comparison Group abgeglichen werden sollen.
setSynchronizeScaling(Boolean)GRAPHOMATECHART_1.setSynchronizeScaling(true);Diese Funktion setzt, ob die Skalierung des Charts mit der Comparison Group abgeglichen werden soll.
setTitle(String)

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

Setzt den Titel des Charts. Erwartet value als String. Zeilenumbrüche (\n) werden auch als solche interpretiert.
setUseOutlierThreshold(Boolean)GRAPHOMATECHART_1.setUseOUtlierThreshold(true);Diese Funktion setzt, ob die Ausreißergrenze verwendet werden soll.
setUserHighlightColor(String)GRAPHOMATECHART_1.setUserHighlightColor("#ff0000,#00ff00,#0000ff");Setzt eine Liste der hinterlegten User Highlight-Farben. Erwartet einen kommaseparierten String. Die gesetzten Farben werden dabei in der angegebenen Reihenfolge bei den User Highlights (zur Laufzeit hervorgehobene Werte) durchgeschaltet, bis die Wunschfarbe eingestellt ist.
setUserHighlightList(String)GRAPHOMATECHART_1.setUserHighlightList("[[1,3],[2,3][1,5]]");Setzt ein oder mehrere User Highlights (zur Laufzeit hervorgehobene Werte). Erwartet einen JSON-String bestehend aus einem oder mehreren Arrays mit jeweils zwei Zahlen. Dabei gibt die erste Zahl die Datenreihe an, während die zweite Zahl die Position des Wertes in der Datenreihe darstellt.
setValueAxisVisible(Boolean)GRAPHOMATECHART_1.setValueAxisVisible(true);Diese Funktion schaltet die Anzeige der Value Axis an bzw. aus.
setVisibleSeries(String)

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

Setzt die Auflistung der Indices sichtbarer Serien des Charts. Erwartet value als kommaseparierten String.
showStructureMode (Boolean)GRAPHOMATECHART_1.showStructureMode(true);Setzt die Ausrichtung des Charts. Wenn der Wert value TRUE ist, wird das Chart im Strukturmodus angezeigt, sonst im Zeitmodus.

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.

getUserHighlightColor()

GRAPHOMATECHART_1.getUserHighlightColor();

String

#ff0000,#00ff00,#0000ff

Returns 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]]

Returns 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

true

Returns whether the value axis is visible or not.

getVisibleElementLabels()GRAPHOMATECHART_1.getVisibleElementLabels()String1,3,5Retrieves the visible element labels as a comma separated list of indices.

getVisibleSeries()

GRAPHOMATECHART_1.getVisibleSeries();

String

0,1,4

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

refresh(string value)
Redraws the chart. This is a workaround in case the chart has not been refreshed after data has changed at run-time by the impact of the scripting language on the Data Source. This could happen, for example, when filters have been changed, dimensions have been added or removed.

If the chart should unexpectedly not refresh, this command should help:

Code Block
languagejs
GRAPHOMATECHART_1.refresh(GRAPHOMATECHART_1.refreshValue());

It is absolutely necessary to pass the value of refreshValue() as parameter val!

refreshValue()
Help function for refresh(). It has no further use.

scalingHelperMode(string value)
Sets the Scaling Helper. Valid values are none, line, area.
Example: activate the Scaling Helper

Code Block
languagejs
GRAPHOMATECHART_1.scalingHelperMode("line");


Setter NameBeispielBeschreibung
addRuleset(String name)GRAPHOMATECHART_1.addRuleset("Ruleset2");Adds a ruleset to the list of rulesets. Does not create duplicates.
removeRuleset(String name)GRAPHOMATECHART_1.removeRuleset("Ruleset2");Removes a ruleset from the list of rulesets used by the chart. Does nothing, if the ruleset is not present.
scalingHelperMode(string value)activate the Scaling HelperSets the Scaling Helper. Valid values are none, line, area.
setAxisLabels(String)GRAPHOMATECHART_1.setAxisLabels("Net Sales,Returns");Sets the axes labels of the chart. Expects value as comma-separated string. The first value is interpreted as left axis label, the second as right axis label.
setAxisThickness(Integer) GRAPHOMATECHART_1.setAxisThickness(3);Sets the axes thickness.
setBarWidth(Float)GRAPHOMATECHART_1.setBarWidth(3);Sets the width of the bars as a float value. Values less than or equal to 1 are interpreted as percentages.
setBaseChartVisible(Boolean)GRAPHOMATECHART_1.setBaseChartVisible(true);Sets whether the base chart is visible.
setCalculationPath(String)GRAPHOMATECHART_1.setCalculationPath("+,+,+,-,-,=, ,s+,+,=,-,-");Sets the Waterfall Calculation Path. Expects value as comma-separated string.
setCalculateDeviationsFromNull (Booleanl)GRAPHOMATECHART_1.setCalculateDeviationsFromNull(true);This function sets whether NULL values are used to calculate deviations.

setCategoryAxisVisible(Boolean)

GRAPHOMATECHART_1.setCategoryAxisVisible(true);Sets whether the base chart is visible.
setCategoryCount(Integer)GRAPHOMATECHART_1.setCategoryCount(12);Sets a limit on the number of displayed category. A value of 0 removes the restriction.
setCategoryLabelRotation(int rotation)GRAPHOMATECHART_1.setCategoryLabelRotation(45);Rotates the category labels according to the passed angle. Rotation takes place counter-clockwise.

setCategoryWidth(Integer)

GRAPHOMATECHART_1.setCategoryWidth(3);

This function sets the width of the categories. But it is only interpreted when fixedCategoryWidth is set.
setChartType(String)GRAPHOMATECHART_1.setChartType("line");Sets the chart type. The following string values are allowed: bar, line, offsetbar, waterfall, pin, stackedbar.

setComparisonGroup(String id)

GRAPHOMATECHART_1.setComparisonGroup("A");

Sets the Comparison Group of 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()

setContextMenuCustomEventName(Integer index, String name)GRAPHOMATECHART_1.setContextMenuCustomEventName(1, "Script 1");Sets the name of a specified custom event (Index-1 based) in the Context Menu.

setContextMenuCustomEventVisibility(Integer  index, Boolean visibility)

GRAPHOMATECHART_1.setContextMenuCustomEventVisibility(1, false);Sets the visibility of a specified custom event (index-1 based) in the Context Menu.

setContextMenuOptionVisibility(Integer index, Boolean visibility)

GRAPHOMATECHART_1.setContextMenuOptionVisibility(1, false);Sets the visibility of a specified option in the Context Menu. Use the following indices to access the options: 1 for Sorting, 2 for Filters, 3 for Context Sensitive Filters, 4 for Filter and Hide, 5 for Clear Filters, 6 for Drilldown, 7 for Drillup, 8 for Zero Display, 9 for Member Display, 10 for Position of Totals, 11 for Total Display.

setDatatypeAt(Integer series, Integer index, String datatype)

GRAPHOMATECHART_1.setDatatypeAt(1, 1, "AC");

This 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");

This 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");
is 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");

This function sets the Data Types of the selected Data Series seriesIndex. Expects value as comma-separated string.

setDeviationBadColor(String)

GRAPHOMATECHART_1.setDeviationBadColor("#ff3300");

This function sets the color used for „bad“ deviations. Expects a string value in the format #ff3300.

setDeviationGoodColor(String)

GRAPHOMATECHART_1.setDeviationGoodColor("#2e2e2e");

This function sets the color used for „good“ deviations. Expects a string value in the format #2e2e2e

setDeviationLabels(String labels, Boolean visibleOnly)

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

Sets the labels for every deviation series. If the second value is true only visibile deviations are considered.

setDeviationVisibility (String)

GRAPHOMATECHART_1.setDeviationVisibility("0,1");

Sets a list of indexes of visible deviation charts. Expects value as comma-separated string. Empty string for no visible deviation chart.

setDisplaySmallMultiples(String)GRAPHOMATECHART_1.setDisplaySmallMultiples("row");Display of "Small Multiples" along the first row or column dimension.
Valid values: "none", "row" or "column".

setElementsOffset(Float)

GRAPHOMATECHART_1.setElementsOffset(5);

This function sets the offset between the elements of a category. Values less than or equal to 1 are interpreted as percentages.

setEndingLineOverlap(Integer)

GRAPHOMATECHART_1.setEndingLineOverlap(5)

Sets how far the Ending Lines protrude over the bars.

setEndingLineThickness(Integer)

GRAPHOMATECHART_1.setEndingLineThickness(3);

Sets the thickness of the Ending Lines.

setEndingLineVisible(Boolean)

GRAPHOMATECHART_1.setEndingLineVisible(true);

Sets whether to display Ending Lines above the bars.

setExtendedNumberFormat(String)

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

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

setExtendedNumberFormatPercentage(String)

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

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

setFixedCategoryWidth(Boolean)

GRAPHOMATECHART_1.setFixedCategoryWidth(true);

This functions sets whether the Category Width should be fixed. If it is not fixed, the width is determined automatically.

setHighlightEndIndex(Integer) 

GRAPHOMATECHART_1.setHighlightEndIndex(4);

Sets the category index value of the end value of the Highlight. Analogous to setHightlightStartIndex().

setHighlightEndSeries(Integer) GRAPHOMATECHART_1.setHighlightEndSeries(3);Sets the series index value of the end series of the Highlight. Analogous to setHightlightStartSeries().
setHighlightMode(String)GRAPHOMATECHART_1.setHighlightMode("single");This function can be used to change the highlight mode. Valid values are none, single or auto.
setHighlightStartIndex(Integer)GRAPHOMATECHART_1.setHighlightStartIndex(0);Sets the category index value of the start value of the Highlight Analogous to setHightlightEndIndex().
setHighlightStartSeries(Integer) GRAPHOMATECHART_1.setHighlightStartSeries(1);Sets the series index value of the start series of the Highlight. Analogous to setHightlightEndSeries().
setLabelFormatMode(String)GRAPHOMATECHART_1.setLabelFormatMode("extended");Sets a string value for the used label format mode. Available values are basic and extended.
setLabelPositioningMode(String)GRAPHOMATECHART_1.setLabelPositioningMode("auto");This function sets the label positioning mode. Valid arguments are none (no labels are displayed), fix (labels are displayed at the exact position; overlapping might occur) and auto (no overlapping, but labels may be moved or hidden).
setLockData(Boolean)GRAPHOMATECHART_1.setLockData(true);Sets whether the component ignores data updates.
setManualCategoryLabels(String labels)GRAPHOMATECHART_1.setManualCategoryLabels('[["2001","2001","2001","2001"],["Q1","Q2","Q3","Q4"]]')Sets the manual category labels. Expects value as two dimensional JSON array string. Examples:

[["Q1","Q2","Q3","Q4"],["2017","2017","2017","2017"]]
or
[["Q1","Q2","Q3","Q4","Q1","Q2","Q3","Q4"],["North","North","North","North","South","South","South","South"],["2017","2017","2017","2017","2017","2017","2017","2017"]]

setManualScaleMaximum(Integer max)

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

Sets the maximum of the scaling of the Base Chart to the integer value max. It is necessary to set the scale mode to Manual for the integer to become effective. (see also setScaleModeManual() and Scaling in the features description)

setManualScaleMaximumFloat(Float max)GRAPHOMATECHART_1.setManualScaleMaximumFloat(1000000);Sets the maximum of the scaling in the Base Chart to the float value max. It is necessary to set the scale mode to Manual. (see also setScaleModeManual() and Scaling in the features description). This function is an alternative function to setManualScaleMaximum(), in case only float values are available.
setManualScaleMinimum(Integer min)

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

Sets the minimum of the scaling of the Base Chart to the integer value min. It is necessary to set the scale mode to Manual for the integer to become effective. (see also setScaleModeManual() and Scaling in the features description)
setManualScaleMinimumFloat(Float minGRAPHOMATECHART_1.setManualScaleMinimumFloat(1000000);Sets the minimum of the scaling in the Base Chart to float value min. It is necessary to set the scale mode to Manual. (see also setScaleModeManual and Scaling in the features description) This function is an alternative function to setManualScaleMinimum(), in case only float values are available.
setManualScalePercentMax(Float)GRAPHOMATECHART_1.setManualScalePercentageMax(80);Sets the manual percentage scaling maximum as a float value.
setManualScalePercentMin(Float)GRAPHOMATECHART_1.setManualScalePercentageMin(-80);Sets the manual percentage scaling minimum as a float value.
setMultiHighlights(String)GRAPHOMATECHART_1.setMultiHighlights("[{"startElement":1,"endElement":2,"startSeries":1,"endSeries":1}, {"startElement":3,"endElement":4,"startSeries":1,"endSeries":1}, {"startElement":5,"endElement":6,"startSeries":1,"endSeries":1}] ");

Sets the list of multi highlights (highlighted values above the chart). Expects 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}.

setNegativeDeviationIsGood(Boolean)GRAPHOMATECHART_1.setNegativeDeviationIsGood(true);Sets whether negative deviations are interpreted as positive or negative.
setNegativeOutlierThreshold(Float)GRAPHOMATECHART_1.setNegativeOutlierThreshold(-80);Sets the negative outlier threshold.
setNumberFormat(String)GRAPHOMATECHART_1.setNumberFormat("0,0.0");Sets the number format for the Basic Mode. The format string corresponds to the format numeral.js (see http://www.numeraljs.com).
setNumberFormatPercentage(String)GRAPHOMATECHART_1.setNumberFormatPercentage("0 %");Sets the number format for the percentages in the Basic Mode. The format string corresponds to the format numeral.js (see http://www.numeraljs.com).
setPositiveOutlierThreshold(Float)GRAPHOMATECHART_1.setPositiveOutlierThreshold(80);Sets the positive outlier threshold.
setProperty(String, String)GRAPHOMATECHART_1.setProperty("suppressZeroLabels", "true");

Sets an arbitrary property.

The technical name of the property is required, in order to set the property.
You can get the technical name in the lower left corner in the status bar of Lumira Designer, after selecting the according property in the property sheet.

The new value of the property must be a string representation of the value, e.g. "Name", "2", "true", "#334455", "3.5" etc.

setRulesets(String newRulesetList);GRAPHOMATECHART_1.setRulesets("Ruleset1,Ruleset2");Sets the rulesets of the chart. Requires the server url to be set and valid.

setScaleModeAutomatic()

GRAPHOMATECHART_1.setScaleModeAutomatic();Sets the scale mode of the Base Chart to Automatic.
setScaleModeManual()GRAPHOMATECHART_1.setScaleModeManual();Sets the scale mode of the Base Chart to Manual.
setScalingHelperValue(Integer)GRAPHOMATECHART_1.setScalingHelperValue(500);Sets the position of the Scaling Helper. Expects the position value as integer value.
setScalingHelperValueFloat(Float) GRAPHOMATECHART_1.setScalingHelperValueFloat(500);Sets the position of the Scaling Helper. Expects the position value as float value.
setSeparatorLength(Integer)GRAPHOMATECHART_1.setSeparatorLength(5);Sets the length of the Separators in pixels.
setSeparatorMode(String)GRAPHOMATECHART_1.setSeparatorMode("datatypes");Sets the Separator Mode. Valid values are: none, categorylabels, datatypes, manually.
setSeparatorPositions(String)GRAPHOMATECHART_1.setSeparatorPositions("100,200,300");Sets a list of separator positions of the chart. Expects value as comma-separared string.
setSeparatorSourceRowIndex(Integer)GRAPHOMATECHART_1.setSeparatorSourceRowIndex(3);Sets the index of the row/series, from which the Separators can be derived. This function is dependent on the Separator Mode (setSeperatorMode ()).
setSeparatorThickness(Integer)GRAPHOMATECHART_1.setSeparatorThickness(3);Sets the thickness of the Separators in pixels.
setSeries(Integer seriesIndex, String)

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

Set the data description of the selected Data Series seriesIndex. Expects value as JSON string. This string either describes a row or a column in the Initial View. The string can be read out after data for a Data Series has been selected on the Property Sheet with the graphomate charts extension.

setSeriesLabels(String)GRAPHOMATECHART_1.setSeriesLabels("Series1,Series2");Sets the series labels of the charts. Expects value as comma-separated string.
setShowAxisLabelsLeft(Boolean)

GRAPHOMATECHART_1.setShowAxisLabelsLeft(true);

Sets whether the Axis Labels are displayed on the left..
setShowAxisLabelsRight(Boolean)GRAPHOMATECHART_1.setShowAxisLabelsRight(true);Sets whether the Axis Labels are displayed on the right.
setShowCategoryLabels(Boolean)GRAPHOMATECHART_1.setShowCategoryLabels(true);Sets wether the Category Labels are displayed. 
setShowDatatypesInAxis(Boolean)GRAPHOMATECHART_1.setShowDatatypesInAxis(true);Sets whether the Data Types are displayed in the Axis.
setShowTitle(Boolean)GRAPHOMATECHART_1.setShowTitle(true);Sets whether the title is displayed.
setShowTooltips(Boolean)GRAPHOMATECHART_1.setShowTooltips(true);Sets whether the tooltips in runtime mode are displayed.
setSmallMultiplesMinWidth(Integer)GRAPHOMATECHART_1.setSmallMultiplesMinWidth(300);

Sets the minimum width in px for each "Small Multiples" instance

setSmallMultiplesMinHeight(Integer)GRAPHOMATECHART_1.setSmallMultiplesMinHeight(300);Sets the minimum height in px for each "Small Multiples" instance
setSmallMultiplesNCount(String)GRAPHOMATECHART_1.setSmallMultiplesNCount("3");

Calculates top N sorted "Small Multiples" for the members of the Small Multiples dimension and combines the remaining members into a Rest Member, if possible. Sums members are excluded from the calculation and are placed at the end.

Possible values: "None", "1", "2", "3", "4", etc...

For the option "None" no rest member is calculated and no sorting takes place.

setSpaceFactorBaseChart(Float)GRAPHOMATECHART_1.setSpaceFactorBaseChart(0.8);Sets the proportional Space Factor of the Base Chart (relative to the other Space Factors).
setSpaceFactorDeviationChart(Float)GRAPHOMATECHART_1.setSpaceFactorDeviationChart(0.2);Sets the proportional Space Factor of the Base Chart (relative to the other Space Factors).
setStackedBarLabelPosition(String)GRAPHOMATECHART_1.setStackedBarLabelPosition("middle");Sets the position of the labels in the stacked bar chart. Valid values are middle and right.
setStackedBarNegativeValues(Boolean)GRAPHOMATECHART_1.setStackedBarNegativeValues(true);Sets the proportional Space Factor of the Base Chart (relative to the other Space Factors).
setStackedBarSumsVisible(Boolean)GRAPHOMATECHART_1.setStackedBarSumsVisible(true);Sets whether the sums in the stacked bars are displayed.
setStructureMode(Boolean)GRAPHOMATECHART_1.setStructureMode(true);This function can be used to toggle the structure mode on or off.
setSuppressRepeatingCategoryLabels(String)GRAPHOMATECHART_1.setSuppressZeroLabels("true,false,false,true");Sets the configuration of the  property Suppress Repeating Category Labels. Expects a comma separated string with one statement for each row of the Category Labels whether repeating category labels should be suppressed.
setSuppressZeroLabels(Boolean)GRAPHOMATECHART_1.setSuppressZeroLabels(true);This function sets whether Zero Labels are displayed.
setSynchronizeAxesPosition(Boolean)GRAPHOMATECHART_1.setSynchronizeAxesPosition(true);This function sets whether the axes position of the chart are synchronized with the Comparison Group.
setSynchronizePadding(Boolean)GRAPHOMATECHART_1.setSynchronizePadding(true);This function sets whether the padding of the chart is synchronized with the Comparison Group.
setSynchronizeScaling(Boolean)GRAPHOMATECHART_1.setSynchronizeScaling(true);This function sets whether the scaling oft he chart is synchronized with the Comparison Group.
setThresholdLinesConfig(String)

GRAPHOMATECHART_1.setThresholdLinesConfig('[{"visible":true,"label":"Mean","type":"Average","base":1,"lineSize":1,"color":"#0000FF","lineStyle":"solid"}]')

This function replaces the current threshold lines config with the given JSON. For an example of the configuration JSON, please copy an example from the standard property sheet. In the example shown here, the mean value for the series 1 with the label "Mean" is displayed.
setTitle(String)

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

Sets the title of the chart. Expects value as a string. Line breaks (\n) are interpreted as such.
setUseOutlierThreshold(Boolean)GRAPHOMATECHART_1.setUseOutlierThreshold(true);This function sets whether the outlier threshold is used. 
setUserHighlightColor(String)GRAPHOMATECHART_1.setUserHighlightColor("#ff0000,#00ff00,#0000ff");Sets a list of disposited colors for the User Highlights. Expects a comma separated string-value. The colors of the list are switched at each click (during runtime) until the desired color is set.
setUserHighlightList(String)GRAPHOMATECHART_1.setUserHighlightList("[[1,3],[2,3][1,5]]");Sets a list of disposited colors for the User Highlights. Expects a comma separated string-value. The colors of the list are switched at each click (during runtime) until the desired color is set.
setValueAxisVisible(Boolean)GRAPHOMATECHART_1.setValueAxisVisible(true);This function can be used to turn the visibility of the value axis on or off.
setVisibleElementLabels(String)GRAPHOMATECHART_1.setVisibleElementLabels("[1,2,4]");Sets the visible element labels. Expected is a comma separated list of series indices, e.g.
1,2,3,4,5,6,7,8,9
setVisibleSeries(String)

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

Sets the listing of indices of visible series in the chart. Expects value as comma-separated string. 
showStructureMode (Boolean)GRAPHOMATECHART_1.showStructureMode(true);Sets the orientation of the chart. If the value is TRUE, the chart will be shown in structure mode, otherwise in time mode.

Examples

Dynamically filter a Data Source using a dropdown box

In order to allow a user to dynamically filter on a dimension of a Data Source, we first have to fill a dropdown box with all valid value.
We first retrieve on the canvas event On Startup of the selected Data Source a list of all members of the dimension 0D_NWI_ACOD with the command getMemberList autocomplete proposes all parameters of getMemberList.

Using setItem puts the list in the dropdown box.

Code Block
languagejs
DROPDOWN_1.setItems (DS_1.getMemberList("0D_NWI_ACOD",
MemberPresentation.EXTERNAL_KEY, MemberDisplay.TEXT, 20);


On application start the dropdown box will be filled with the members of the dimension 0D_NWI_ACOD.
If a user selects an element of the list, we can adapt the filter of the Data Source with the following script, which is set on the event On Element Clicked of the dropdown box:

Code Block
languagejs
DS_1.setFilterExt("0D_NWI_ACOD", DROPDOWN_1.getSelectedValue());

Deleting filter of data source

The following command allows you to delete a filter of a Data Source:

Code Block
languagejs
DS_1.setFilterExt("0D_NWI_ACOD", DROPDOWN_1.getSelectedValue());

Die Filter einer Data Source entfernen

Sollen die Filter einer Data Source wieder entfernt werden, kann dies mit folgendem Aufruf getan werden:
DS_1.clearAllFilters();

Per Drilldown auf einem graphomate Chart eine Data Source filtern

Soll ein Drilldown mit den graphomate charts realisiert werden, muss vorher eine Bedingung erfüllt sein:
Es muss die Property categoryLabels befüllt sein! Die Kategorienbeschriftungen müssen dabei nicht sichtbar sein, können dies aber natürlich. Das ist notwendig, weil das Chart nur über diese Property Informationen über Dimensionen und Members erhalten kann.
Wenn diese Vorbedingung erfüllt ist, kann auf dem Event On Element Clicked des graphomate Charts mit folgendem Skript der Schlüssel (Key) des selektierten Dimensionsmember erhalten werden:
var key = 
Filter a Data Source via drilldown with graphomate charts

Setting a filter on a data source by drilldown

Before it is possible to make a drilldown with the graphomate charts, the following condition must be fulfilled: The property categoryLabels must be filled with data! The Category Labels therefore do not have to be visible, but can be visible. This is necessary, because the chart receives its information about dimension and members only from this property.

If this condition is fulfilled, it is possible to receive the Key of the selected dimension member with the following script, which is set on the event On Element Clicked of graphomate charts:


Code Block
languagejs
var key = GRAPHOMATECHART_1.getSelectedMemberKey("0D_NWI_RCOD");


Als Parameter muss der Schlüssel (Key) der gewünschten Dimension übergeben werden.Dieser so erlangte Memberkey kann nun - analog wie bei dem Beispiel der Dropdown-Box - als Filter auf eine Data Source gesetzt werden:
The Key of the selected dimension must be passed as a parameter.

This retrieved Memberkey can be set as a filter on a Data Source – similar to the example with the dropdown box:


Code Block
languagejs
DS_1.setFilter("0D_NWI_RCOD", key);
bzw. zusammengezogen:

or – in a combined command:

Code Block
languagejs
DS_1.setFilter("0D_NWI_RCOD", GRAPHOMATECHART_1.getSelectedMemberKey("0D_NWI_RCOD"));

Titel nach Drilldown setzen

Um auch den Titel des Charts an den Drilldown anzupassen – zum Beispiel um die selektierte Region anzuzeigen - kann parallel zum Memberkey auch der Membertext ausgelesen werden.
var region =

Set title after drilldown

In order to adapt the title to the drilldown – for example, to show the selected area, it is possible to read out the Membertext in the same way as Memberkey.

Code Block
languagejs
var region = GRAPHOMATECHART_1.getSelectedMemberText("0D_NWI_RCOD");


Dieser Text kann dann natürlich beliebig weiter verwendet werden oder wie hier in den Titel hinein geschrieben werden:This text can be arbitrarily used – here it is written in the title of the chart.

Code Block
languagejs
GRAPHOMATECHART_1.setTitle("Selected region: " + region);

Zooming-Funktion

Um eine Zoom-Funktionalität für ein Chart umzusetzen, muss der Skalierungsmodus des Charts auf Manual stehen. Dies kann entweder voreingestellt oder über die Skriptfunktion realisiert werden:
GRAPHOMATECHART_1.setScaleModeManual();
Danach wird das onElementClicked-Event des entsprechenden Charts mit folgendem Skript versehen:
var value =


Realize a zoom function

In order to implement a zoom functionality on a chart, the scaling mode must be set to Manual. This can be either preset or realized via scripting:

Code Block
languagejs
GRAPHOMATECHART_1.setScaleModeManual();


After that the following script must be attached to the onElementClicked event:

Code Block
languagejs
var value = GRAPHOMATECHART_1.getClickedPositionValue();


GRAPHOMATECHART_1.setManualScaleMinimumFloat(value);

Zunächst wird dabei der relative Wert der Klickposition ermittelt. In der zweiten Zeile wird dieser Wert dann als Minimum für die manuelle Skalierung eingesetzt und somit ein Zoom erreichtAt first the relative value of the clicked position is determined. In the second line, this value is then used as the manual scale minimum and by doing that a zooming function is established.