The script editor is a tool within analytics designer to specify the actions taking place when an event is triggered by an application user. By adding a script to a widget, you can influence the behavior of this widget and thus enable user interaction, also referred to as events, at runtime. A script typically consists of several statements. A statement is a programmatic instruction within a script. The execution of a statement is typically triggered by user interaction with the widget.
Creating and Editing Event-Based Scripts
Scripts are presented in the outline pane, at the left-hand side of the analytics designer editor environment. Find them by hovering over the widget name in the outline, or as a menu entry in the quick action menu of each widget. The icon indicates the event. By clicking on it, the script editor opens the selected function.
If a widget has multiple available events, you are presented with a choice in the hover menu.
If there is an event with an attached script, you can see the icon in the outline pane. If there are no attached script, there is no visible icon. In the following figure, the onSelect event of Dropdown_1 has a script, but there are no scripts attached to Chart_1.
If a widget has multiple events and at least one has a script attached, then the icon will be displayed.
Creating and Editing Functions in Global Script Objects
Functions are found under the global script objects portion of the outline pane. Before you can add functions, you will need to add your first script object. Do this by clicking the plus sign, next to the Script Objects header.
Within a script object, you can add several functions by invoking Add Script Function in the context menu. Keep in mind that the script object container is an organizational aid for you.
Individual functions are nested within global script objects. For example, in the figure below Error! Reference source not found. you see the function1 nested within a script object called ScriptObject_1.
Like canvas widgets, the scripts attached to a function are created by clicking the icon in the hover menu of that function. Functions that have and don’t have scripts are visible in the outline, just as with widgets.
Once you have a script attached to a function, you can call it whenever you please, from any other script. The script objects are accessible by name and individual functions are accessible within the objects. If you wanted to invoke the function1 script within ScriptObject_1, you would call is like this:
Script Editor Layout
Once an open script is in the editor, it shows up as a tab along the top of the canvas. You can open several script editor tabs at the same time.
The script editor has three areas:
- the widget and event
- the documentation
- the main body of the script itself
Write script in the main body using the inbuild help features like code completion and value help.
The script editor provides several keyboard shortcuts, which let you, for example, undo or redo your editing operations.
Find a list of keyboard shortcuts in the help page “Using Keyboard Shortcuts in the Script Editor”:
4.3.5 Info Panel: Errors and Reference List
All errors are listed in the Errors tab of the Info panel. Search for errors and filter out only warnings or errors. Double-click an error to open the script in a new tab and jump directly to the error location in the script.
Find all places where a widget or a scripting object is used with the Find References feature. You can find it in the context menu per object in the outline. The result is displayed in the Reference list tab of the Info Panel.
Info panel: errors and reference list
Renaming Widgets, Script Variables, and Script Functions
While creating an analytic application in analytics designer you can change the name of an analytics designer widget, gadget (a technical component), script variable, script object, script object function, and script object function arguments. Analytics designer then applies the new name to all relevant places, for example in analytics designer scripts.
You can change the name of a widget, gadget, script variable, script object, or script object function by selecting it in the Outline, clicking the More button, selecting Rename, and entering a new name.
You can change the name of a widget or gadget by selecting it in the Outline, then entering in the Styling Panel a new name in the Name input field.
You can change the name of a script variable, script object, or script object function by selecting it in the Outline, entering in the Styling Panel a new name in the Name input field, then clicking button Done.
You can change the name of a script object function argument by selecting the script object function in the Outline, clicking the Edit button of the function argument in the Styling Panel, entering a new name in the Name input field, then clicking button Done.
To learn more about scripting in Analytics designer, check out Analytics Designer Handbook