GuiAPI

Description

GUI API interface.

Access to elements in the graphical user interface.

Object name: cnGuiAPI.

Since

1.0, 05.2025

Functions
TREE VIEWS
Closes the application. Since 1.0.0, ...
ApiJsonResponse	getDynamicColumns (QString &domainCode, QString &window)
ApiJsonResponse	setDynamicColumns (QString &domainCode, QString &window, QStringList &columns)
STARTPAGE
ApiJsonResponse	openStartPage ()
ApiJsonResponse	closeStartPage ()
INFOHUB
ApiJsonResponse	showLoginDialog ()
ApiJsonResponse	showConnectDialog ()
PROJECT
ApiJsonResponse	newProject ()
ApiJsonResponse	openProject (QString filepath=QString())
ApiJsonResponse	openUrl (QString &url, QString &target=QString())
3D VIEWER
ApiJsonResponse	createViewpoint ()
MENU BAR
ApiJsonResponse	menuBarSetConfiguration (QVariantMap configuration)
ApiJsonResponse	menuBarGetConfiguration ()
ApiJsonResponse	menuBarReset ()
ACTIONS
ApiJsonResponse	getAvailableActions ()
ApiJsonResponse	triggerAction (QString &actionName, QVariantMap &params=QVariantMap())

Function Documentation

closeStartPage

ApiJsonResponse closeStartPage ( )

slot

Close ColneoPro start page.

Since

1.0.0

createViewpoint

ApiJsonResponse createViewpoint ( )

slot

Opens a dialog to create a new viewpoint.

Since

1.0, 05.2025, jh

getAvailableActions

ApiJsonResponse getAvailableActions ( )

slot

Get list of available actions.

Returns

data : string[]

Since

1.0, Jan 2025

getDynamicColumns

ApiJsonResponse getDynamicColumns ( QString & domainCode, QString & window )

slot

Gets the dynamic (user-defined) columns for a given domain and tree view.

Each domain contains a least two tree views: the model tree and the SmartSets tree.

Parameters

domainCode	Domain short code (e.g. "geo"). A list of available domains can be found here.
window	Identifies the target view. Possible values: "objects" (objects hierarchy of domain) "smartsets"

Returns

Array of columns (property type ids) in the displayed order (e.g. "cnGuid##xs:ID")

data: Array<string>

Since

1.0, Nov 2025

menuBarGetConfiguration

ApiJsonResponse menuBarGetConfiguration ( )

slot

Return the current configuration of the menubar as JSON-Object.

Returns

{
    'status' : 200,
    'data' : {}
}

Since

1.0.0

menuBarReset

ApiJsonResponse menuBarReset ( )

slot

Reset the menubar to the default configuration.

Returns

{
    'status'    : 200
}

Since

1.0, 07.2025

menuBarSetConfiguration

ApiJsonResponse menuBarSetConfiguration ( QVariantMap configuration )

slot

Changes the menubar according to the given configuration

Parameters

configuration

Returns

{
    'status' : 200
}

Since

1.0.0

newProject

ApiJsonResponse newProject ( )

slot

Creates an empty project.

Since

1.0, Jan 2026

openProject

ApiJsonResponse openProject ( QString filepath = QString() )

slot

Shows an OpenFileDialog, if no file path is specified or 'filepath' is not a valid file path, and opens selected project. Unlike the cnProjectAPI.open(string) function, a progress dialog may be displayed.

Parameters

filepath

Full file path

Returns

ApiResponse object

 {
   status: number (error code)
   message: string (error message)
   data: string (selected filepath, optional)
}

Since

1.0, Jan 2026

openStartPage

ApiJsonResponse openStartPage ( )

slot

Open ColneoPro start page.

Since

1.0.0

openUrl

ApiJsonResponse openUrl ( QString & url, QString & target = QString() )

slot

Save project, show a SaveFileDialog if project was not saved before (newly created and no file path is available).

Returns

ApiResponse

            data :
            \endcoide
          
            \since 1.0, Jan 2026
         /
        ApiJsonResponse saveProject();
 
        /*!
         * Shows a SaveFileDialog and saves the project.
         * \return ApiResponse object
         * \since 1.0, Jan 2026
         */
        ApiJsonResponse saveProjectAs();
 
        /*!
         * Shows import dialog and call import methods.
         * \return ApiResponse object
         * \since 1.0, Jan 2026
         */
        ApiJsonResponse importFiles();
 
          * @}
#pragma endregion
 
#pragma region WEBMODULES
      * @{ \name WEBMODULES
 
        /*!
            \brief Opens a web URL or local file/folder using the platform desktop services.
 
            This function attempts to interpret the given url and open it using
            the appropriate system handler (web browser, file manager, etc.).
            The input can be a web URL or a local file path. The function automatically
            detects and normalizes missing URL schemes (e.g. http(s), file).
 
            \param url
                A web URL or a local file/folder path. Missing URL schemes are added.
                Web URLs (http, https) are opened in the default web browser. File URLs (file) are opened in the Windows Explorer.
 
            \param target
                Optional UI target for opening the URL. If empty, the default system browser or file manager is used.
                Note: Custom targets are not yet implemented.
 
            \returns
                Returns a JSON response of the form:
                \code
                {
                    "url": "<normalized-url>"
                }

On failure, the response contains an error code and message.

Since

1.0, Nov 2025

setDynamicColumns

ApiJsonResponse setDynamicColumns ( QString & domainCode, QString & window, QStringList & columns )

slot

Sets the dynamic (user-defined) columns of a tree view in a domain.

Parameters

domainCode	Domain short code (e.g. "geo"). A list of available domains can be found here.
window	Identifies the target view. Possible values: "objects" (objects hierarchy of domain) "smartsets"
columns	List of columns (property type ids) which should be shown. An empty list clears all dynamic columns.

Returns

Array of columns which could be set.

data: Array<string>

Since

1.0, Dec 2025

showConnectDialog

ApiJsonResponse showConnectDialog ( )

slot

Open dialogue which shows the webb app 'connect' to connect this CN pro project to a coordination model on the CN infohub

Since

1.0, 01.2026, jh

showLoginDialog

ApiJsonResponse showLoginDialog ( )

slot

Shows the Login dialog.

Opens the COLNEO Infohub login dialog if the user is not already logged in (get access token).

Returns

The user ID if login was successfully.

    data : string
}

Since

1.0, 10.2025, jh

triggerAction

ApiJsonResponse triggerAction ( QString & actionName, QVariantMap & params = QVariantMap() )

slot

Triggers an action.

Parameters

actionName	Name of the action
params	Optional parameters, depending on the action. Example: { dockWidgetArea : 'left' | 'right' | 'top' | 'bottom' | 'float' }

Returns

data:

See also

getAvailableActions();

Since

1.0, Jan 2025