Overview

VDC Manager provides a JavaScript-API to enrich and to manipulate actions in the application.
VDC API scripts can be used in any "script" interface in VDC Manager as well as in VDC Manager WebForms, which are web pages that run in the application's internal browser.
Scripts can also be used to automate actions triggered by certain events, e.g. after a model has been added.

The vdcApp object

The main JavaScript object to access VDC API functionality is vdcApp (alternatively, desiteAPI for backwards compatibility, but you should use the new naming when writing new scripts).
Its underlying class hierarchy constitutes different feature levels, depending on context.
API classes higher up in the hierarchy can use all functionality of the lower levels, but not vice versa.

API Class	Context
WebFormsAPI	WebForms (note that the legacy name of this object was `desiteMD`)
AdvancedProjectAPI
ProjectAPI	Macros and Automation Scripts, Details Widgets
AutomationAPI	Postprocessing of Model Check and Clash Detection runs
CoreAPI	Property Scripts

Other API objects

Apart from vdcApp, additional JavaScript objects are available in certain contexts.

Object Name	Legacy Name (deprecated)	Context	Usage
`vdcTrigger`	N/A	Automation Scripts	Set or manipulate an automatic trigger for a script
`vdcContext.element`	`desiteThis` `desiteThis` `desiteChecked` `desiteThis`	Property Script Model Check Rule Definition Model Check Postprocessing Details Widget	The element that the property is being evaluated for The element that is currently being checked The element that has been checked The element of which detail information are being gathered
`vdcContext.elementLeft`	`desiteLeft`	Clash Detection Postprocessing	The left element of the clash
`vdcContext.elementRight`	`desiteRight`	Clash Detection Postprocessing	The right element of a clash
`vdcContext.result`	`desiteResult` `desiteThis` `desiteThis`	Model Check Rule Definition Model Check Postprocessing Clash Detection Postprocessing	The result element of the check, for setting result information The result element of the check, for retrieving result information The result element of the check, for retrieving result information

Every element reference provides two functions to identify the element: ID() and Name().

A simple example of a property script:

// get the id of the current object
const id = vdcContext.element.ID();
// get the value of property 'cpVolume'
const val = vdcApp.getPropertyValue( id, 'cpVolume', 'xs:double' );
// the return value of the script, i.e. the value of the expression
val;