Script Documentation of graphomate bullet graphs for SAP BusinessObjects Design Studio
Author: Jens Beckmann
Rev 1.5 as of December 2016
Introduction
The graphomate bullet graphs extension supports the SAP Design Studio scripting language. This enables the user to dynamically interact with the add-on during runtime. Script commands include manipulation of the graphomate bullet graphs layout or setting of data. This document features a list of all currently available script commands. Please do not hesitate to contact us if any feature is missing. For this, you can use our online form.
Events
The following events are available. User-made scripts can be deposited on the Property Sheet under the group Events.
| Event Name | Description |
|---|---|
| On Element Clicked | Is triggered when the user clicks on an element of the chart at runtime. 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:
|
Functions
The following functions are available. They can be addressed in the scripting editor of Design Studio. We differentiate between getter and setter functions as they get information from the extension or set its properties.
| Getter Name | Example | Return type | Example Return Value | Description |
|---|---|---|---|---|
| getCalculateQualitativeRanges() | GRAPHOMATEBULLETGRAPHS_1 .getCalculateQualitativeRanges(); | boolean | true | Returns whether the Qualitative Ranges are calculated or not. |
| getChartTitle() | GRAPHOMATEBULLETGRAPHS_1 .getChartTitle(); | String | "Title" | Returns the title of the Bullet Graphs component. |
| getChartSubtitle() | GRAPHOMATEBULLETGRAPHS_1 .getChartSubtitle(); | String | "Subtitle" | Returns the subtitle of the Bullet Graphs component. |
| getComparison1() | GRAPHOMATEBULLETGRAPHS_1 .getComparison1(); | String | '{"Keyfigures": "0D_NWI_IQTY", "0D_NWI_CHAN": "4"}' | Returns the selection string of Comparative Measure 1. |
| getComparison2() | GRAPHOMATEBULLETGRAPHS_1 .getComparison2(); | String | '{"Keyfigures": "0D_NWI_IQTY", "0D_NWI_CHAN": "5"}' | Returns the selection string of Comparative Measure 2. |
| getComparisonGroup() | GRAPHOMATEBULLETGRAPHS_1 .getComparisonGroup(); | String | "A" | Returns the comparison group the bullet graph component is currently registered in. A return value of "" means that the component is currently not part of any comparison group. |
| getDatatypes(String seriesType) | GRAPHOMATEBULLETGRAPHS_1 .getDatatypes(“performance1”); | String | "AC,AC,AC,AC" | Returns the datatypes for the passed series type. Allowed values for seriestype are: performance1, performance2, comparative1, comparative2 ,quality1, quality2, quality3 |
| getDisplayCategoryLabels() | GRAPHOMATEBULLETGRAPHS_1 .getDisplayCategoryLabels(); | boolean | true | Returns whether category labels are shown. |
| getDisplayValueAxis() | GRAPHOMATEBULLETGRAPHS_1 .getDisplayValueAxis(); | String | "Once" | Returns whether the value axis is displayed. Possible return values are Always, Once or Never. |
| getDeviationFromComparison1() | GRAPHOMATEBULLETGRAPHS_1 .getDeviationFromComparison1(); | boolean | false | Returns whether deviations of Comparative Measure 1 from Performance Measure 1 are displayed or not. |
| getNormalizeToTarget() | GRAPHOMATEBULLETGRAPHS_1 .getNormalizeToTarget(); | String | "None" | Returns if the data in a bullet graph component are normalized to a target value. Return value are either None, Performance Measure 1, Performance Measure 2, Comparative Measure 1 or Comparative Measure 2. |
| getNumeraljsFormatString() | GRAPHOMATEBULLETGRAPHS_1 .getNumeraljsFormatString(); | String | "0.0a" | Returns the current numeral.js format string. |
| getPercentageQuality1() | GRAPHOMATEBULLETGRAPHS_1 .getPercentageQuality1(); | Float | 0.75 | Returns the current percentage which is used to calculate Qualitative Range 1. |
| getPercentageQuality3() | GRAPHOMATEBULLETGRAPHS_1 .getPercentageQuality3(); | Float | 1.25 | Returns the current percentage which is used to calculate Qualitative Range 3. |
| getPerformance1() | GRAPHOMATEBULLETGRAPHS_1 .getPerformance1(); | String | '{"Keyfigures": "0D_NWI_IQTY", "0D_NWI_CHAN": "6"}' | Returns the selection string of Performance Measure 1. |
| getPerformance2() | GRAPHOMATEBULLETGRAPHS_1 .getPerformance2(); | String | '{"Keyfigures": "0D_NWI_IQTY", "0D_NWI_CHAN": "1"}' | Returns the selection string of Performance Measure 2. |
| getPerformanceBarHeight() | GRAPHOMATEBULLETGRAPHS_1 .getPerformanceBarHeight(); | int | 25 | Returns the current height of the performance bars. |
| getQualitativeBarHeight() | GRAPHOMATEBULLETGRAPHS_1 .getQualitativeBarHeight(); | int | 35 | Returns the current height of the qualitative ranges. |
| getQuality1() | GRAPHOMATEBULLETGRAPHS_1 .getQuality1(); | String | '{"Keyfigures": "0D_NWI_IQTY", "0D_NWI_CHAN": "2"}' | Returns the selection string of Qualitative Range 1. |
| getQuality2() | GRAPHOMATEBULLETGRAPHS_1 .getQuality2(); | String | '{"Keyfigures": "0D_NWI_IQTY", "0D_NWI_CHAN": "3"}' | Returns the selection string of Qualitative Range 2. |
| String getQuality3() | GRAPHOMATEBULLETGRAPHS_1 .getQuality3(); | '{"Keyfigures": "0D_NWI_IQTY", "0D_NWI_CHAN": "4"}' | Returns the selection string of Qualitative Range 3. | |
| getReverseQualitativeRanges() | GRAPHOMATEBULLETGRAPHS_1 .getReverseQualitativeRanges(); | Boolean | false | Returns the drawing direction of the Qualitative Ranges. |
| getReverseQuantity() | GRAPHOMATEBULLETGRAPHS_1 .setReverseQuantity(); | Boolean | false | Returns the current drawing direction of the value axis. |
| getUseIndividualScales() | GRAPHOMATEBULLETGRAPHS_1 .setUseIndividualScales(); | Boolean | false | Returns if every bullet graph is scaled individually, or if all are scaled identically. |
| getVerticalAlign() | GRAPHOMATEBULLETGRAPHS_1 .getVerticalAlign(); | Boolean | false | Returns whether the bulletgraphs are aligned vertically (true) or horizontally (false) |
| getSelectedMember(String dimensionKey) | GRAPHOMATEBULLETGRAPHS_1 .getSelectedMember("0D_NWI_RCOD").text; | Member | "West" | After the user clicked on an element in the bullet graph, this function returns the member of the specified dimension dimensionKey. The member provides different properties such as text, internalKey and externalKey. |
| getSelectedMemberKey(String dimensionKey) | GRAPHOMATEBULLETGRAPHS_1 .getSelectedMemberKey("0D_NWI_RCOD"); | String | "10273" | After the user clicked on an element in the bullet graph, this function returns the key of the member of the dimension dimensionKey. |
| getSelectedMemberText(String dimensionKey) | GRAPHOMATEBULLETGRAPHS_1 .getSelectedMemberText("0D_NWI_RCOD"); | String | "West" | After the user clicked on an element in the bullet graph, this function returns the text of the member of the selected dimension dimensionKey. |
| Setter Name | Example | Description |
|---|---|---|
| setCalculateQualitativeRanges(boolean value) | GRAPHOMATEBULLETGRAPHS_1 .setCalculateQualitativeRanges(true); | If this option is true, Qualitative Ranges 1 and 3 will be calculated from Qualitative Range 2. If set to false, Qualitative Ranges 1 and 3 will have to be assigned to a Data Series to be displayed. |
| setChartTitle(String value) | GRAPHOMATEBULLETGRAPHS_1 .setChartTitle("Sales in Mio. EUR|2013 ACT and BUD"); | Sets the title of the component. |
| setChartSubtitle(String value) | GRAPHOMATEBULLETGRAPHS_1 .setChartSubtitle("Region Nord"); | Sets the subtitle of the component; works analogous to setChartTitle(). |
| setComparison1(String value) | GRAPHOMATEBULLETGRAPHS_1 .setComparision1('{"Keyfigures":"0D_NWI_NSAL"}'); | Sets the Data Series of Comparative Measure 1. Expects a JSON string which describes either a column or a line of the Data Source. |
| setComparison2(String value) | GRAPHOMATEBULLETGRAPHS_1 .setComparision2('{"Keyfigures":"0D_NWI_NSAL"}'); | Sets the Data Series of Comparative Measure 2. Expects a JSON string which describes either a column or a line of the Data Source. |
| setComparisonGroup(String comparisonGroup) | GRAPHOMATEBULLETGRAPHS_1 .setComparisonGroup('A'); | Registers the bullet graph component in the Comparison Group with the passed id. A value of "" removes the component from any Comparison Group it is currently registered in. |
| setDatatypes(String seriestype, String value) | GRAPHOMATEBULLETGRAPHS_1 .getDisplayCategoryLabels(); | Sets the datatypes of the passed series type to the passed value. The input for seriestype has to be one of the following: performance1, performance2, comparative1, comparative2, quality1, quality2, quality3 value is a JSON string which descripes to datatypes to be set. The following format has to be used: ‘[“AC“,“PP“,“BU“]‘ |
| setDisplayCategoryLabels(boolean value) | GRAPHOMATEBULLETGRAPHS_1 .setDisplayCategoryLabels(true); | Shows or hides the Category Labels. |
| setDisplayValueAxis(String value) | GRAPHOMATEBULLETGRAPHS_1 .setDisplayValueAxis("Never"); | Shows or hides the Value Axis. Valid values are Always (each bullet graph get its own axis), Once (only one axis is drawn, all bullet graphs are scaled identically) or Never (no axis is displayed). |
| void setDeviationFromComparison1(boolean val) | GRAPHOMATEBULLETGRAPHS_1 .setDeviationFromComparison1(true); | This function can be used to toggle the display of the deviation bar between Performance Measure 1 and Comparative Measure 1 on or off. |
| setNormalizeToTarget(String val) | GRAPHOMATEBULLETGRAPHS_1 .setNormalizeToTarget ("None"); | With this function, all values in a bullet graph component can be normalized to a target value. Valid parameter values are None, Performance Measure 1, Performance Mesure 2, Comparative Meaure 1 or Comparative Measure 2. |
| setNumeraljsFormatString(String value) | GRAPHOMATEBULLETGRAPHS_1 .setNumeraljsFormatString("0,0.0"); | A string that describes the format of the axis labelling. A description of valid strings can be found at numeraljs.com. |
| setPercentageQuality1(float value) | GRAPHOMATEBULLETGRAPHS_1 .setPercentageQuality1(0.2); | This value is used to calculate Qualitative Range 1, if the option Calculate Qualitative Ranges is enabled. |
| setPercentageQuality3(float value) | GRAPHOMATEBULLETGRAPHS_1 .setPercentageQuality3(1.8); | This value is used to calculate Qualitative Range 3, if the option Calculate Qualitative Ranges is enabled. |
| setPerformance1(String value) | GRAPHOMATEBULLETGRAPHS_1 .setPerformance1('{"Keyfigures":"0D_NWI_NSAL"}'); | Sets the Data Series of Performance Measure 1. Expects a JSON string which describes either a column or a line of the Data Source. |
| setPerformance2(String value) | GRAPHOMATEBULLETGRAPHS_1 .setPerformance2('{"Keyfigures":"0D_NWI_NSAL"}'); | Sets the Data Series of Performance Measure 2. Expects a JSON string which describes either a column or a line of the Data Source. |
| setPerformanceBarHeight(integer value) | GRAPHOMATEBULLETGRAPHS_1 .setPerformanceBarHeight(20); | Sets the height/width of Performance Bar, according the alignment. |
| setQualitativeBarHeight(integer value) | GRAPHOMATEBULLETGRAPHS_1 .setQualitativeBarHeight(30); | Sets the height/width of the Qualitative Bars, according the alignment. |
| setQuality1(String value) | GRAPHOMATEBULLETGRAPHS_1 .setQuality1('{"Keyfigures":"0D_NWI_NSAL"}'); | Sets the Data Series of Qualitative Range 1. Expects a JSON string which describes either a column or a line of the Data Source. |
| setQuality2(string value) | GRAPHOMATEBULLETGRAPHS_1 .setQuality2('{"Keyfigures":"0D_NWI_NSAL"}'); | Sets the Data Series of Qualitative Range 2. Expects a JSON string which describes either a column or a line of the Data Source. |
| setQuality3(string value) | GRAPHOMATEBULLETGRAPHS_1 .setQuality3('{"Keyfigures":"0D_NWI_NSAL"}'); | Sets the Data Series of Qualitative Range 3. Expects a JSON string which describes either a column or a line of the Data Source. |
| setReverseQualitativeRanges(boolean value) | GRAPHOMATEBULLETGRAPHS_1 .setReverseQualitativeRanges(true); | Specifies the drawing direction of the Qualitative Ranges. |
| setReverseQuantity(boolean value) | GRAPHOMATEBULLETGRAPHS_1 .setReverseQuantity(true); | Reverses the scale of the bullet graphs. If true, the scaling ranges from n to 0, if false, it ranges from 0 to n. |
| setUseIndividualScales(boolean value) | If this option is true, each bullet graph axis will be calculated individually. Otherwise, all bullet graphs will be scaled identically. | |
| setVerticalAlign(boolean value) | GRAPHOMATEBULLETGRAPHS_1 .setVerticalAlign(false); | Sets the alignment of the bullet graph. If true, the bars will be aligned vertically. |