Versions Compared

Old Version 1

changes.mady.by.user Stefanie Schröder

Saved on

compared with

New Version Current

changes.mady.by.user Stefanie Schröder

Saved on

Key

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



Sets the hexadecimal color value for negative deviations

.

Div
classpdfExportLandscape

Scripting Documentation of graphomate matrix for SAP Lumira Designer


Author:



Rev

2020

2021.

4

2 as of

October 2020

May 2021

Div
classnoPrint

PDF Export


Info

Scripting Documentation https://public.graphomate.com/matrix/lumira-scripting-doc/interfaces/doc_scriptingapi.scriptingapi.html


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

  • getSelectedMembergetSelectedData() 


Functions

The following functions are availableYou can find an overview of all functions here. They can be addressed in the scripting editor of Design StudioDesigner. We differentiate between getter and setter functions as they get information from the extension or set its properties.

Getter NameExampleReturn typeExample Return ValueDescription
getBadColor()

GRAPHOMATEBUBBLE_1 .getBadColor();

String#FF0000Returns the hexadecimal color value of bad deviations.
getPadding()GRAPHOMATEBUBBLE_1 .getPadding();int25Returns the chart padding in [px].
getUseFormattedData()GRAPHOMATEBUBBLE_1 .getUseFormattedData();booleanfalseReturns whether the preformatted values from the data source are used in the chart.
Setter NameExampleDescription
setBadColor(String value)GRAPHOMATEBUBBLE_1 .setBadColor("#FF0000");