Skip to content

The Console, Dialogs and Other Utilities

Phil Beauvoir edited this page Jul 20, 2018 · 15 revisions

Some script snippets assume that you run them on Archisurance.archimate. In this documentation, "object" is used for any type of information (ArchiMate concept or view, but also Canvas, Folders...).

Table of contents


The Console

Output can be sent to jArchi's Console window using the following functions:

console.show();
console.hide();
console.setText("Clear previous text and display this text");
console.log("Hello World");
console.log(object);
console.log("One thing: ", object, another, ...);
console.error(error);
console.clear();
console.setTextColor(redValue, greenValue, blueValue);
console.setDefaultTextColor();

Prompt, Alert and File Dialogs

Alert

window.alert("Hello World");

Confirm

var response = window.confirm("Are you sure?");

Prompt

var name = window.prompt("Please enter your name", "Default Name");

Prompt to open a file

var filePath = window.promptOpenFile({ title: "Open Model", filterExtensions: [ "*.archimate" ], "default.archimate" });

Prompt to open a directory

var dirPath = window.promptOpenDirectory({ title: "Open Folder", "/defaultPath" });

Prompt to save a file

var filePath = window.promptSaveFile({ title: "Save Model", filterExtensions: [ "*.archimate" ], "default.archimate" });

Including Other Script Files

You can include other Archi script or JavaScript files:

load(absolute_path)
load(url)

There is no support for relative locations, so the following format is used:

load(__DIR__ + "path/file.js")
__DIR__ contains the absolute path of the directory containing the current script.
__FILE__ contains the absolute path of current script.
__LINE__ contains the line number in which __LINE__ is used.