Scripting Documentation of graphomate matrix for SAP Lumira Designer
Author:
Rev 2020.4 as of October 2020
Introduction
The graphomate matrix supports the Designer scripting language. This enables the user to dynamically interact with the add-on during runtime. Script commands include manipulation of the graphomate matrix layout or setting of data. This document features a list of all currently available script commands.
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 |
|---|---|---|---|---|
| getBadColor() | GRAPHOMATEBUBBLE_1 .getBadColor(); | String | #FF0000 | Returns the hexadecimal color value of bad deviations. |
| getPadding() | GRAPHOMATEBUBBLE_1 .getPadding(); | int | 25 | Returns the chart padding in [px]. |
| getUseFormattedData() | GRAPHOMATEBUBBLE_1 .getUseFormattedData(); | boolean | false | Returns whether the preformatted values from the data source are used in the chart. |
| Setter Name | Example | Description |
|---|---|---|
| setBadColor(String value) | GRAPHOMATEBUBBLE_1 .setBadColor("#FF0000"); | Sets the hexadecimal color value for negative deviations. |