Script Editor

For complex Lua scripts, the Peakboard Designer provides its own script editor. In the following figure, you can see how the script editor looks like, using a timer script as an example. However, the structure is almost identical for all Peakboard script types.

Script editor

When you open the script editor, you can decide whether you want to work in the building block mode, or switch to the classic text-based editor (1).

Above the workspace (2) you will find a button to [comment out] (3) and a button to [uncomment] (4).

The magnifying glass button (5) or the key combination [Ctrl+F] will take you to [Search] and [Replace].


For more helpful keyboard shortcuts, see the end of this article.


The script tree (6) is intended to make working with scripts easier. It contains predefined functions and examples, which you can insert at the cursor position by simply double-clicking. In addition to the elements of the explorer you previously created in the Peakboard Designer, such as [Data], [Dataflows], [Variables], [Reload flows], [Resources] and [Controls]/[Screens], it also contains [Timer scripts], [Logic & loops], [Math] and many other functions, as well as, among other things, all connections from your current project under [Publish in external system].

Using the folders on the left side of the script editor (7) you can navigate through your previously created scripts in the current project without having to leave the editor. Scripts from dataflows are not listed there. Missing or wrong elements are listed in the error list (8).

After you have entered a script in the script editor workspace, you can use the [Test script] button to check whether it is correct using the preview data. If you use peakboard.log('...') to log content, this will also be displayed, as well as other return values.

Test script

Helpful keyboard shortcuts

CTRL + F Opens the search dialog window
CTRL + space Opens the Intellisense
CTRL + arrow keys Jumps through the text
CTRL + shift + arrow keys Selects complete text sections
CTRL + pos1/end Jumps to the beginning/end of the text
CTRL +Shift + pos1/end Selects the text to the beginning/end
ALT + Up/Down Move a line of text
ALT + Mouse selection Selecting the cursor in multiple lines
Tab Autocomplete

We are learning from you!

Did you find this article helpful?

Be enlightened!

Do you need more support?

Peakboard Youtube icon Visit our YouTube channel

Our numerous videos for beginners and advanced users explain exactly how to design your dashboard.

Peakboard Templates icon Visit the Peakboard Templates

Download our templates for various use cases for free.

Peakboard icon Visit

Find out all about Peakboard and browse our different use cases and success stories.