Overview

COLNEO pro (COLNEO pro, COLNEO console) provides an API to manipulate objects in a project.
The API provides also access to project data and enables control of the application's GUI.
The supported programming language is JavaScript and HTML (ECMAScript 2022 / HTML 5). The internal web browser of COLNEO pro is based on Chromium 92.

API

API Objects List

These API objects are provided:

cnCoreAPI - Access to the core object model
cnProjectAPI - Functions related to project data
cnGuiAPI - Handles GUI related functionalities
cnView3dAPI - Access to the 3D viewer
cnApplicationAPI - Handles all application related functionalities

Note: Only read (or non-time-critical) functions can be used in script properties. These are marked accordingly in the documentation.

Usage

Within the COLNEO pro macro editor or in script properties, the API functions can be used directly and are processed synchronously. The return value of a macro is the result of the code execution.

In web forms, however, you must wait until the API has been initialized. This is done by inserting the following code block at the end of the html body to wait for the 'cnapiready' event.

<script>
    addEventListener('cnapiready', async function (event) {
        console.log("COLNEO API READY.");
        doOnLoad(); 
    });
</script>

Processing also is asynchronous. When using the API functions, either the the await-async syntax is used or the functions are called with a callback function as the last parameter.

Command Line Interface / COLNEO console

To automate actions COLNEO pro can be started at the command line without any GUI.

$> colneoconsole -h

These command line arguments are supported:

-h, –help	Print available options
-v, –version	Print current version
-s, –script	Executes JavaScript that can contain commands from the COLNEO pro API and accesses variables in the parameter file
-p, –param	Adds parameters for the execution of JavaScript files
-l, –log	Logs all actions of console in a log file

List of domains

You find a list of supported domain here : Domains