MainPage   Files   Related pages 
desite API Documentation
Overview

ceapoint desite MD provides an API to augment and script the application.

Scripting is provided by three levels:

These three levels are reflected by the provided classes in this API.
Level 1 can handle property values only. Level 2 can also get and set selection/visibility of objects, call viewpoints and material mappings. In this level navigation modes can be set and objects can be filtered. Level 3 also provides signals to notify linked objects in a forms about changes in selection and visibility objects in the 3D-model.

Level 1 - User Defined Properties

Class: desiteCore::CoreAPI
Available JavaScript objects: desiteThis, desiteAPI

JavaScript object: desiteThis
Access to the current object. The current object is passed by desite to the running script.

Available methods:

// ID of current object
desiteThis.ID()
// Name of current object
desiteThis.Name()

JavaScript object: desiteAPI
Access to functionality of desite.

desiteAPI provide the methods of class desiteCore::CoreAPI

Example:

// get the id of the current object
var id = desiteThis.ID();
// get the value of property 'cpVolume'
var V = desiteAPI.getPropertyValue( id, 'cpVolume', 'xs:double' );
// the return value of the script, i.e. the value of the expression
Level 2 - Scripting the Project

Class: desiteCore::ProjectAPI
Available JavaScript objects: desiteThis, desiteAPI

Level 3 - Scripting 'Input Forms'

JavaScript object 'desiteAPI' provides the methods of class desiteCore::NavigatorProjectAPI.

JavaScript object: desiteMD

Access to the input forms. Details see class desiteCoreGui::DataBaseWebInterfaceWidget.

Available methods:

dataChanged ()
reloadPage ()
string createPdfByTemplate (string templateFileName, string pdfFileName)


Version of this file
Date
2014-12-12 17:30:39 +0100 (Fr, 12 Dez 2014)
Rev
615

Created: Wed Jan 6 2016 14:55:50