Scripting Documentation

Scripting Documentation of graphomate trellis for SAP Lumira Designer 

Rev 1.0 as of September 2018

PDF

Introduction

The graphomate trellis 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 trellis 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 Standard-Properties-Sheet under the group Events.

Event NameDescription
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:

  • getSelectedMember() 

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 NameExampleReturn typeExample Return ValueDescription
getSelectedMember(Dimension dimensionKey)

GRAPHOMATETRELLIS_1.getSelectedMember("0D_NWI_RCOD");

Member
After the user clicked on an element in the trellis, this function returns the member of the specified dimension dimensionKey. The member provides different properties such as text, internalKey and externalKey. Only dimensions specified in the module configurations are available.