Versions Compared

Old Version 4

changes.mady.by.user Tomke Reibisch

Saved on

compared with

New Version 5

changes.mady.by.user Stefanie Schröder (Unlicensed)

Saved on

Key

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


Div
classpdfExportLandscape

Script documentation for the graphomate slopegraphs for SAP BusinessObjects Design Studio

Author: Gregor Große-Bölting

Version 1.0 – March 2017

Introduction

The graphomate slopegraphs support Design Studios scripting language, so it is possible to interactively use the extension during runtime. One could, for example, set new data, manipulate the title or change the scaling. This documentation will provide a list of the currently available functions including examples of their usage. We are trying to enhance the extend of our functionality, so please don't hesitate to let us know if you are in need of a certain functionality using out contact page.

Events

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

Event NameDescription
On Element Clicked

Triggered if the user clicks some element of the component during runtime. To enable drilldowns one will have to react to the user input. Therefor the return value for the following function will be updated with this event:

  • getSelectedMember() 

Functions

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

Getter NameExampleReturn typeExample return valueDescription
getSelectedMember(Dimension dimensionKey)GRAPHOMATESLOPEGRAPH_1.getSelectedMember();Member

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

getData()GRAPHOMATESLOPEGRAPH_1.getData();String

{"(MEASURES_DIMENSION)": "0D_NWI_NSAL", "0D_NWI_RCOD": "80503"}

Returns the selection string which represents the selected data from the data source. Please refer to the Design Studio documentation for further information.

getShowCategoryLabels()GRAPHOMATESLOPEGRAPH_1.getShowCategoryLabels();booleanfalseReturns a flag to describe whether or not the category labels are visible.
getFontSize()GRAPHOMATESLOPEGRAPH_1.getFontSize();float14Returns the font size.
getTextColor()GRAPHOMATESLOPEGRAPH_1.getTextColor();String#ff0000Returns the font color.
getFocusTextColor()GRAPHOMATESLOPEGRAPH_1.getFocusTextColor();String#BADA55Returns the focus font color, which is used during runtime when the mouse is hovering over a slope.
getFontFamily()GRAPHOMATESLOPEGRAPH_1.getFontFamily();StringComic SansReturns the font family.
getOnlyLeadingDescription()GRAPHOMATESLOPEGRAPH_1.getOnlyLeadingDescription();booleantrue

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

getNumberFormat()GRAPHOMATESLOPEGRAPH_1.getNumberFormat();String0bReturns the number format.
getSlopeColor()GRAPHOMATESLOPEGRAPH_1.getSlopeColor();String#777Returns the slope color.
getFocusSlopeColor()GRAPHOMATESLOPEGRAPH_1.getFocusSlopeColor();String#1CE1CE

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

getPositiveSlopeColor()GRAPHOMATESLOPEGRAPH_1.getPositiveSlopeColor();String#facade

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

getNegativeSlopeColor()GRAPHOMATESLOPEGRAPH_1.getNegativeSlopeColor();String#911

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

getNegativeIsGood()GRAPHOMATESLOPEGRAPH_1.getNegativeIsGood();booleanfalse

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

getShowTrendInSlopes()GRAPHOMATESLOPEGRAPH_1.getShowTrendInSlopes();booleantrue

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

getSlopeThickness()GRAPHOMATESLOPEGRAPH_1.getSlopeThickness();float1.5

Returns the thickness of the slope lines.

getUseRanks()GRAPHOMATESLOPEGRAPH_1.getUseRanks();booleanfalse

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

getRankDotRadius()GRAPHOMATESLOPEGRAPH_1.getRankDotRadius();float3

Returns the radius used for the Rank Dot Radius (only relevant if Use Ranks is active).

getAscendingOrder()GRAPHOMATESLOPEGRAPH_1.getAscendingOrder();booleantrue

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


Setter NameExampleDescription
setData(String val)GRAPHOMATESLOPEGRAPH_1.setData({"(MEASURES_DIMENSION)": "0D_NWI_NSAL", "0D_NWI_RCOD": "80503"});

Sets the selection string, which specifies the data visualized by the slopegraphs. Please refer to the Design Studio documentation for more information.

setShowCategoryLabels(boolean val)GRAPHOMATESLOPEGRAPH_1.setShowCategoryLabels(true);Sets whether or not category labels should be visible.
setFontSize(float val)GRAPHOMATESLOPEGRAPH_1.setFontSize(12);Sets the font size.
setTextColor(String val)GRAPHOMATESLOPEGRAPH_1.setTextColor("#eee");Sets the font color.
setFocusTextColor(String val)GRAPHOMATESLOPEGRAPH_1.setFocusTextColor("#ff0000);Sets the focus font color which is used during runtime if a user hovers over a text.
setFontFamily(String val)GRAPHOMATESLOPEGRAPH_1.setFontFamily("Wingdings");Sets the font color.
setOnlyLeadingDescription(boolean val)GRAPHOMATESLOPEGRAPH_1.setOnlyLeadingDescription(false);Sets whether or not only leading slope labels should be shown.
setNumberFormat(String val)GRAPHOMATESLOPEGRAPH_1.setNumberFormat("0.0a");Sets the number format.
setSlopeColor(String val)GRAPHOMATESLOPEGRAPH_1.setSlopeColor("#00ff00");Sets the slope color.
setFocusSlopeColor(String val)GRAPHOMATESLOPEGRAPH_1.setFocusSlopeColor("#0000ff");

Sets the focus slope color which is used during runtime if a user hovers over a slope.

setPositiveSlopeColor(String val)GRAPHOMATESLOPEGRAPH_1.setPositiveSlopeColor("#123456");

Sets the color for ascending slopes (which is only shown if Show Trend in Slopes is active).

setNegativeSlopeColor(String val)GRAPHOMATESLOPEGRAPH_1.setNegativeSlopeColor("#654321");

Sets the color for descending slopes (which is only shown if Show Trend in Slopes is active).

setNegativeIsGood(boolean val)GRAPHOMATESLOPEGRAPH_1.setNegativeIsGood(true);

Sets whether or not ascending slopes are interpreted as negative and therefor be colored differently (and vice versa).

setShowTrendInSlopes(boolean val)GRAPHOMATESLOPEGRAPH_1.setShowTrendInSlopes(false);

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

setSlopeThickness(float val)GRAPHOMATESLOPEGRAPH_1.setSlopeThickness(2);Sets the slope thickness.
setUseRanks(boolean val)GRAPHOMATESLOPEGRAPH_1.setUseRanks(true);

Sets whether or not slopes should be scaled using their rank instead of their value.

setRankDotRadius(float val)GRAPHOMATESLOPEGRAPH_1.setRankDotRadius(5);Sets the Rank Dot Radius (only relevant if Use Ranks is active).
setAscendingOrder(boolean val)GRAPHOMATESLOPEGRAPH_1.setAscendingOrder(false);Sets whether or not the slopes are shown in ascending order.


...