Main   Error Codes   Domains 
Functions | List of all members
WebFormsAPI Reference

Functions

double getZoomFactor ()
 
void setZoomFactor (double value)
 
void tpApiAuth (string callbackFunctionName)
 
void authorize (object config, string callbackFunctionName)
 
Header, Footer
void showNavigation (bool visible)
 
void showConsole (bool show)
 
Printing
string createPdfByTemplate (string templateFileName, string pdfFileName, object printTextBlocks, bool openPdf=true)
 
void setPaperSize (int paperSize)
 
void setOrientation (int orientation)
 
void setPageMargins (double l, double r, double t, double b)
 
double getPageMarginTop ()
 
double getPageMarginBottom ()
 
double getPageMarginLeft ()
 
double getPageMarginRight ()
 
double getLogicalDpi ()
 
URL, Page
void reloadPage ()
 
void loadUrl (string url)
 
void addSuffix (string suffix)
 
void resetSuffixList ()
 
void clearHistory ()
 
void clearHTTPCache ()
 
void redirectUrl (string originalUrl, string redirectUrl)
 
Progress
void showProgress (object valuesMap)
 
void hideProgress ()
 
void clearProgressMessage ()
 
void showProgressMessage (string msg)
 
void showProgressMessageLabel (string msg)
 
void showProgressValue (double value)
 
void showProgressMessageConsole (string msg)
 
int getProgressState ()
 
void processEvents ()
 
void enableInterruptJavaScriptMsg (bool enabled)
 
- Functions inherited from AdvancedProjectAPI
var callScriptByName (string scriptName, string code_prefix=string())
 
void blockSignals (bool block, int msecsDelay=0)
 
- Functions inherited from ProjectAPI
int message (string)
 
bool sendRemoteMessage (string message)
 
var getViewportSettings ()
 
void setViewportSettings (var settings)
 
var getLocation ()
 
void setLocation (var location)
 
var getImportSettings ()
 
void setImportSettings (var settings)
 
void startEXE (string prg, string args)
 
void openLink (string url, bool useDesktopService)
 
string showOpenFileDialog (string caption="", string directory="", string filter="")
 
string showSaveFileDialog (string caption="", string directory="", string filter="")
 
void openProject (string url, bool useSessionData=false)
 
int saveProject ()
 
int saveProjectArchive (string filename, string packBookmark)
 
array< object > import3DModels (var sourceFilePaths, var options)
 
array< object > importTimeSchedules (var sourceFilePaths)
 
array< object > importBillsOfQuantities (var sourceFilePaths)
 
var getDefaultExportSettings ()
 
var export3DModels (string filePath, array< string > modelIDs, var settings)
 
string exportBCF (array< string > sourceIds, string targetPath, string targetFileBaseName, string bcfVersion="2.1")
 
var exportCheckRuns (array< string > sourceIds, string targetFilePath, object options)
 
var importCheckRuns (var sourceFilePaths)
 
var importBCF (string sourceFilePath)
 
int redirectDocument (string modelId, string newSourceFilePath)
 
void showAll (bool repaint, string domainCombination="geometry")
 
void showAllElements (var domains=var())
 
void hideAll (bool repaint, string domainCombination="geometry")
 
void hideAllElements (var domains=var())
 
void showElements (var elementIDs, bool includeBlocked=false, var domains=var())
 
void showElementsOnly (var elementIDs, var domains=var())
 
void hideElements (var elementIDs, bool includeBlocked=false, var domains=var())
 
void setElementsVisible (bool visible, var elementIDs)
 
void setAllElementsVisible (bool visible, var domains)
 
void clearSelection (bool repaint, string domainCombination="geometry")
 
void selectElements (string idList, bool flag, string domainCombination="geometry")
 
void setElementsSelected (bool selected, var elementIDs)
 
void setAllElementsSelected (bool selected, var domains)
 
void zoomToSelected ()
 
void zoomToVisible ()
 
void zoomToObjects (string objIDs)
 
void zoomToAllDocuments ()
 
void zoomToSelectedDocuments ()
 
void zoomToVisibleDocuments ()
 
void zoomToDocuments (array< string > idList)
 
void zoomToLocationGK (double rw, double hw, double h)
 
void zoomToLocationGps (double lat, double lon)
 
void moveToLocationGps (double lat, double lon)
 
void zoomTopView ()
 
string getVisible (string domainFilter="geometry")
 
array< string > getVisibleElements (string domainFilter="geometry")
 
bool hasVisible (string domainFilter="all")
 
int countVisible (string domainFilter="geometry")
 
string getSelected (string domainFilter="geometry")
 
array< string > getSelectedElements (string domainFilter="geometry")
 
bool hasSelected (string domainFilter="all")
 
int countSelected (string domainFilter="geometry")
 
object showElementsOOBBSide (string IDList, double prec=1.e-2)
 
object showElementsOOBBTop (string IDList, double prec=1.e-2)
 
object showElementsOOBBFront (string idList, double prec=1.e-2)
 
void showDimensionsPainter (bool showAABB, bool showOOBB)
 
void hideDimensionsPainter ()
 
void showHomeView ()
 
int showViewpointByID (string id)
 
void addToViewPoint (string vpID, string objIdList)
 
void removeFromViewPoint (string vpID, string objIdList)
 
var createViewpointFromCurrentView (string parentID, object options)
 
string getCurrentViewAsImage (int width=1920, int height=1080)
 
bool saveCurrentViewToFile (string filename, int width=1920, int height=1080)
 
object getViewpointData (string vpID, array< string > filterKeys, bool whitelist=true)
 
bool setViewpointData (string viewpointID, object data)
 
void setViewpointDataToCurrentView (object data)
 
object getViewpointDataFromCurrentView (array< string > filterKeys, bool whitelist=true)
 
int activateObjTooltip (string name)
 
void deactivateObjTooltip ()
 
void setDocumentsTooltipsVisible (bool v)
 
bool getDocumentsTooltipsVisible ()
 
void set4dIsActive (bool active)
 
bool get4dIsActive ()
 
bool set4dDateTime (date dt)
 
date get4dDateTime ()
 
object get4dOptions ()
 
void set4dOptions (object opt)
 
date get4dProjectStart ()
 
date get4dProjectFinish ()
 
array< string > get4dActiveTaskList (date dt, bool linkedToObjectsOnly=false)
 
array< string > get4dActiveTaskListByInterval (date dtStart, date dtEnd, bool linkedToObjectsOnly=false)
 
array< string > get4dFinishedTaskList (date, bool linkedToObjectsOnly=false)
 
array< string > get4dProspectiveTaskList (date, bool linkedToObjectsOnly=false)
 
string get4dTaskColor (string taskID, date dt, string defaultColorName="#000")
 
void setBsPlanUnderlayActive (bool active)
 
bool getBsPlanUnderlayActive ()
 
object getHandlerMode ()
 
bool setHandlerMode (object handlerInfo)
 
var createObjectsFromMeasurements (object options)
 
object getPickedPoint ()
 
object getAllPickedPoints ()
 
object getPickedPointGPS ()
 
object getPickedPointGK ()
 
object getPickedFaces ()
 
void clearMeasureItems ()
 
bool showClashList (var clashIds)
 
object getWebFormLocations ()
 
void createWebFormBookmark (string url, string name)
 
int removeWebFormBookmark (string url)
 
var import3DModelIntoVersionComparison (string sourceFilePath, string referenceModelID)
 
void clearVersionComparison ()
 
object getVersionComparisonOptions ()
 
bool setVersionComparisonOptions (object options)
 
bool runVersionComparison ()
 
object getVersionComparisonResults (array< string > filterKeys)
 
var getPropertyValueFromVersionComparison (string objectID, string propertyName, string propertyType, bool checkInheritance=true)
 
void showAllElementsInVersionComparison ()
 
void showElementsInVersionComparison (var elementIDs)
 
void hideAllElementsInVersionComparison ()
 
void hideElementsInVersionComparison (var elementIDs)
 
- Functions inherited from AutomationAPI
int setProjectNumber (string s, bool overwriteExisting=false)
 
int setProjectShortDescription (string s, bool overwriteExisting=false)
 
int setProjectLongDescription (string s, bool overwriteExisting=false)
 
void setTempValue (string name, var value)
 
var getTempValue (string name)
 
array< string > getListOfTempValues ()
 
void clearListOfTempValues ()
 
string getModelByElement (string id, string domainFilter="all")
 
array< string > getModelListByName (string name, string domain="geometry")
 
array< string > getModelListByDomain (string domainFilter="all")
 
string getRootNodeByModel (string modelID)
 
array< string > getRootNodeListByDomain (string domainFilter="all")
 
array< string > getRootContainerList (string modelName)
 
string createModel (string name, bool createRootContainer=true, string domain="geometry")
 
object getModelMetaData (string modelID)
 
int deleteModel (string id)
 
bool hasModel (string modelID)
 
var getModelImportSettings (string modelID)
 
var isModelReadOnly (string modelID)
 
var removeModelReadOnly (string modelID)
 
array< string > getAllElements (string domainFilter="geometry")
 
bool hasElement (string id)
 
array< string > filterByProperty (array< string > inputList, string propertyName, string propertyDatatype, string filterPattern, bool checkInherited=true, string domains="geometry")
 
array< string > filterByStatus (array< string > inputList, string status, bool value=true, string domains="geometry")
 
string findContainerByName (string parentId, string name, string lookupDomain="all")
 
bool isContainer (string id)
 
int startProjectTransaction (string domain="geometry")
 
int endProjectTransaction (string domain="geometry")
 
var createObject (string parentID, object objectMap)
 
string createObjectFromXml (string parentId, string objectXML)
 
int deleteObjects (string idList)
 
object getAsJSON (string objId)
 
int setAsComposite (string id, bool composite)
 
int setLinkedObjects (string elementID, string IDList)
 
int removeAllLinkedObjects (string id)
 
int removeLinkedObjects (string id, string linkedIdList)
 
int updateRuleBasedLinks (string domainName, bool visibleOnly=false)
 
int removeRuleBasedLinks (string domainName)
 
array< string > getListOfObjTooltips ()
 
void addObjectListToTooltip (string idList, string tooltipname)
 
void removeObjectListFromTooltip (string idList, string tooltipname)
 
int createPropertyType (string propName, string propDatatype, string uomCode, bool isInh, int target, string domainName="all")
 
int setPropertyTypeMetaData (string pName, string ptype, object metadata)
 
int deletePropertyType (string propertyName, string propertyDatatype, string domainName="all")
 
array< var > getPropertyTypeBookmarkList ()
 
object getPropertyTypeBookmark (string name)
 
object getPropertyTypeBookmarkByID (string id)
 
int activatePropertyTypeBookmark (string bookmark)
 
bool setPropertyTypeActive (string pName, string ptype, string domain, bool active)
 
int setAllPropertyTypesActive ()
 
bool removePropertyTypeBookmark (string name)
 
int removePropertyTypeBookmarkByID (string id)
 
string addPropertyTypeBookmark (object bookmarkData)
 
int setPropertyValue (string objId, string propName, string propDataType, var value)
 
int deleteProperty (string objId, string propName, string propDatatype)
 
array< var > getPropertyValues (string propName, string propDatatype, int maxValues=0, string domainName="all", bool getNullValues=false)
 
array< var > getPropertyValuesByObjectList (string propertyName, string propertyDatatype, bool checkInherited, var objectIdList, int maxValues=0, string domains="all", bool getNullValues=false)
 
object getPropertyListAsJSON (object options)
 
void setPropertyListAsJSON (object propmap, object opt)
 
object getPropertyScriptList () const
 
string getPropertyScriptCode (string domain, string pname, string datatype) const
 
string getPropertyScriptFgColor (string domain, string pname, string datatype) const
 
string getPropertyScriptBgColor (string domain, string pname, string datatype) const
 
int setPropertyScriptCode (string domain, string pname, string datatype, string code)
 
int setPropertyScriptFgColor (string domain, string pname, string datatype, string code)
 
int setPropertyScriptBgColor (string domain, string pname, string datatype, string code)
 
object addPropertyScript (string domain, string pname, string datatype, string code=string())
 
int removePropertyScript (string domain, string pname, string datatype)
 
void propertyScriptClearCache (string domain="all", string pname="", string datatype="")
 
object getPropertyScriptOptions (string domain, string pname, string datatype)
 
int setPropertyScriptOptions (string domain, string pname, string datatype, object opt)
 
int synchronizeDocumentContainer (string containerId, bool waitForCompletion=false)
 
void resetDocumentMetaData (string objId)
 
array< object > findDocumentsByLocationGps (double lat, double lon, double distance, array< string > idList=array< string >())
 
array< object > findDocumentsByLocationRangeGps (array< string > gpsCoordinates, double distance, array< string > idList=array< string >())
 
array< object > findDocumentsByLocationGk (double rw, double hw, double distance, array< string > idList=array< string >())
 
array< string > findDocumentsByDate (date start, date end, array< string > idList=array< string >(), bool useRef=false)
 
string createCalendar (string name, string comment)
 
int removeCalendar (string calendarID)
 
array< string > getCalendarList ()
 
string getCalendarByName (string name)
 
string getDefaultCalendar ()
 
string getCalendarByTask (string taskID, bool checkInh=true)
 
int setCalendar (string taskID, string calendarID)
 
int removeCalendarFromTask (string taskID)
 
int setCalendarOptions (string calendarID, object options)
 
object getCalendarOptions (string calendarID)
 
array< object > getCalendarExceptions (string calendarID)
 
int addCalendarExceptions (string calendarID, array< object > exceptions)
 
int removeCalendarException (string calendarID, var date)
 
int clearCalendarExceptions (string calendarID)
 
int setCalendarWorkingTime (string calendarID, object workingTime)
 
object getCalendarWorkingTime (string calendarID)
 
int calcWorkInMinutes (date start, date finish, string calendarID=string())
 
array< string > getTaskRestrictionsList ()
 
string getTaskRestrictionsByName (string name)
 
int setTaskRestrictions (string taskID, string restrictionsID)
 
int removeTaskRestrictions (string taskID)
 
object getVisualisationList ()
 
int setVisualisationByID (string taskIDList, string visID)
 
int removeVisualisation (string taskIDList)
 
int setTaskMode (string taskID, int mode)
 
int recalculateActivityProject (string taskID=string(), bool visibleOnly=false)
 
object calcPropertyValuesOverTime (string propName, string propType, object options)
 
int createTimeSchedule (object config)
 
int hasContact (string objId1, string objId2, object options=object())
 
string createContactObject (string parentId, string objId1, string objId2, string matId, object options=object())
 
array< string > cutObject (string parentId, string objId, object plane=object(), bool closeCuts=true, bool splitUnconnectedParts=true)
 
string mergeObjects (string parentContainerId, var idList, bool skipClosed=false, bool keepTransparency=false, bool keepCommonProperties=false, bool replaceParent=false)
 
bool isIncludedIn (string objId1, string objId2)
 
int isPointIncludedIn (double x, double y, double z, string objId, double tol=1.e-5)
 
int checkIntersection (string objId1, string objId2)
 
int transformObject (string objId, string transformation)
 
int setAsOpening (string objId, string openingIDList)
 
string getProjectionAsSvg (var idList, object options=object())
 
double calcDistance (string objId1, string objId2)
 
var calculateDistance (string meshID1, string meshID2)
 
int swapOrientationOfTriangles (array< object > idList)
 
array< string > getMaterialList ()
 
var addMaterial (string modelID, var materialData)
 
var setMaterialData (string materialID, var materialData)
 
var getMaterialData (string materialID)
 
var removeMaterial (string materialID)
 
bool hasMaterial (string materialID)
 
string getMaterialIDByName (string matName)
 
array< string > getColorSchemeList ()
 
var addColorScheme (var colorSchemeData)
 
var removeColorScheme (string colorSchemeID)
 
bool hasColorScheme (string colorSchemeID)
 
var setColorSchemeData (string colorSchemeID, var colorSchemeData)
 
var getColorSchemeData (string colorSchemeID)
 
var removeElementsFromColorScheme (string colorSchemeID, array< string > elementIDs)
 
var removeAllElementsFromColorScheme (string colorSchemeID)
 
var getColorItemsFromColorScheme (string colorSchemeID)
 
var setActiveColorScheme (string colorSchemeID)
 
string getActiveColorScheme ()
 
var addColorItem (string colorSchemeID, var colorItemData)
 
var removeColorItem (string colorItemID)
 
bool hasColorItem (string colorItemID)
 
var setColorItemData (string colorItemID, var colorItemData)
 
var getColorItemData (string colorItemID)
 
var addElementsToColorItem (string colorItemID, array< string > elementIDs)
 
var getElementsFromColorItem (string colorItemID)
 
double getBBoxMinX ()
 
double getBBoxMaxX ()
 
double getBBoxMinY ()
 
double getBBoxMaxY ()
 
double getBBoxMinZ ()
 
double getBBoxMaxZ ()
 
int calcOOBB (var objectIds, double eps=0.001)
 
int updateOOBB (var objectIds, double eps=0.001)
 
int calcOOBBxy (var objectIds, double eps=0.001)
 
int updateOOBBxy (var objectIds, double eps=0.001)
 
object getBoundingBoxCommon (var objectIds)
 
object getOOBBCommon (var objectIds)
 
object getOOBBxyCommon (var objectIds)
 
double checkOverlapOBB (string id1, string id2, double eps=0.001)
 
string createSelectionSets (string propertyTypes, string rootName, object config=object())
 
array< string > getRootNodeListSelectionSets (string domainFilter="all")
 
int addToSelectionSetGeometry (string setId, string objectIDList)
 
int removeFromSelectionSetGeometry (string setId, string objectIDs)
 
string createSelectionSet (string name, string parentID=string())
 
bool removeSelectionSet (string selsetID)
 
int updateSmartSets (array< string > smartSetIDs=array< string >())
 
string addRegionToAlignment (string alignmentId, object setting)
 
int removeAllRegionsFromAlignment (string alignmentId)
 
int addRangeToRegion (string regionId, double fromStation, double toStation, string alignmentId=string())
 
int removeRangeFromRegion (string regionId, double fromStation, double toStation, string alignmentId=string())
 
int removeAllRangesFromRegion (string regionId, string alignmentId=string())
 
int createDirectory (string path, string dirName)
 
bool writeFile (string filePath, string content, string encoding=string())
 
bool appendToFile (string filePath, string content, string encoding=string())
 
bool removeFile (string filePath)
 
bool copyFile (string fnFrom, string fnTo)
 
bool moveFile (string fnFrom, string fnTo)
 
bool checkIfFileExists (string filePath)
 
bool openFile (string filePath, string encoding=string())
 
bool writeToFile (string content)
 
bool closeFile ()
 
array< string > readTextFile (string filename, bool ignoreLineBreakesInDoubleQuotes=false, string encoding=string())
 
string readTextFileAsString (string filePath, string encoding=string())
 
var readFileInChunks (string filePath, object options)
 
object readCsvFile (string filePath, string delimiter=";", string encoding="Windows-1252")
 
int csvOpen (string filePath, string delimiter=";", string encoding="Windows-1252")
 
array< string > csvNextLine ()
 
bool csvHasNextLine ()
 
bool csvClose ()
 
string readImageFile (string filename, string targetFormat="", bool applyExifRotation=false)
 
array< object > getDirectoryEntryList (string dirPath, bool filesOnly=false, string orderBy="Name")
 
bool dbIsLocalCopy ()
 
string dbGetFilepath () const
 
int dbOpen (const var connectionData=var())
 
bool dbClose ()
 
void dbCheckIn ()
 
void dbCheckOut (array< string > propList)
 
bool dbQueryExec (string sqlQuery)
 
object dbQueryRecordset (string sqlQuery, string key, int maxNumberOfRows=0)
 
bool dbEndQueryExec ()
 
bool dbQueryNext ()
 
var dbQueryValue (int column)
 
string dbQueryLastError ()
 
int setPropertyValueDB (string objIdList, string propName, string propDataType, string propDomain, var value, bool createType=true)
 
int writePropertyValueDB (string objIdList, string propName, string propDataType, string propDomain, var value, bool createType=true)
 
bool startTransaction ()
 
bool endTransaction ()
 
bool dbGetImmediateUpdate ()
 
void dbSetImmediateUpdate (bool)
 
int dbClearCache (string propName, string propType)
 
void dbClearCacheAll ()
 
int dbDeleteProperty (string objIdList, string propName, string propType)
 
int dbAssertTable (string tableName, array< string > columnsList)
 
bool setCheckActive (string checkRunID, bool active)
 
var getCheckActive (string checkRunID) const
 
int runCheck (string checkRunID)
 
int clearCheckResults (string checkRunID)
 
int setCheckOptions (string checkRunID, object options)
 
object getCheckOptions (string checkRunID) const
 
bool setClashRunSettings (string clashRunID, var settings)
 
var getClashRunSettings (string clashRunID) const
 
int setCheckFilterList (string checkRunID, array< object > filterList, bool rightSet=false)
 
array< object > getCheckFilterList (string checkRunID, bool rightSet=false) const
 
int setCheckItems (string checkRunID, array< string > elementIDist, bool rightSet=false)
 
array< string > getCheckItems (string checkRunID, bool rightSet=false) const
 
int setPostProcessingCode (string checkRunID, string code)
 
string addCheckRule (string checkRunID, object rule, string parentRuleID=string())
 
int removeCheckRule (string checkRunID, string type, string ruleID)
 
int clearCheckRules (string checkRunID, string ruleTypeFilter=string())
 
object getCheckRules (string checkRunID, string ruleTypeFilter=string())
 
void enableGeoLocation (int msecInterval=60)
 
void disableGeoLocation ()
 
object currentGeoPosition ()
 
int setBoQBreakdownStructure (string boqModelID, string templateStr)
 
int sortContainerByProperty (string containerId, string propName, string propType, bool ascending=true, int maxDepth=0)
 
int validateIfcCompatibiliy (string bsModelID)
 
- Functions inherited from CoreAPI
string addDays (string dateStr, int nrDays)
 
int getCalendarWeek (date dt)
 
string createID ()
 
long calcHashcode (string str)
 
string compressToIfcGuid (string id)
 
string uncompressFromIfcGuid (string ifcGuid)
 
bool checkRegExp (string value, string pattern)
 
double calcSlantedArea (string objId, double angleMin=0.0, double angleMax=45.0)
 
object calcGpsCoordsByStation (string objId, double station)
 
object calcGpsCoordsByModelCoords (double x, double y)
 
object calcModelCoordsByGpsCoords (double lat, double lon)
 
object calcGkCoordsByModelCoords (double x, double y, double z)
 
object calcModelCoordsByGkCoords (double r, double h)
 
object calcGkCoordsByGpsCoords (double lat, double lon)
 
object calcGpsCoordsByGkCoords (double rw, double hw)
 
object convertCoordinates (object coordinates)
 
string idListToStr (array< string > idList)
 
array< string > strToIdList (string strIDList)
 
var mapToExternalIDs (const array< string > cpIDs)
 
var mapFromExternalIDs (const array< string > cpExternalIDs)
 
var getFileInfo (string filePath)
 
string getAbsolutePath (string filePath)
 
string getBaseName (string filePath)
 
string getFileName (string filePath)
 
string getApplicationDirectory ()
 
string getApplicationFilename ()
 
string getApplicationLanguage ()
 
string getVersionAsString ()
 
object getVersion ()
 
bool requireVersion (int major, int minor, int patch)
 
string getDomainByElement (string objId)
 
string getUserName ()
 
string getProjectName ()
 
string getProjectDirectory ()
 
object getProjectLocation () const
 
object getProjectInfo ()
 
array< string > getContainedElements (string containerId, int maxDepth, bool loadExternal=true)
 
int countContainedElements (string containerId, int maxDepth, bool loadExternal=true)
 
string getParent (string objId)
 
array< string > getOpenings (string objId)
 
array< string > getParts (string objId)
 
array< string > getLinkedObjects (string objectIDList, string resultDomains="all", string objectLookupDomains="all")
 
bool isVisible (string objId)
 
bool isSelected (string objId)
 
var getPropertyValue (string objId, string propName, string propType, bool inh=true)
 
array< object > getPropertyValuesByObject (string objId, string filterpattern="*")
 
var getPropertySource (string objId, string propName, string propType, bool inh=true)
 
string getPropertyUnit (string propName, string propType)
 
object getPropertyTypeMetaData (string propName, string propType)
 
array< object > getPropertyTypeList (string domain="all", string filterPattern="*", bool activeOnly=false)
 
array< object > getPropertyTypeListByObject (string objId, string filterPattern="*")
 
bool isPropertyInherited (string objId, string propName, string propType)
 
string getPropertyValueRange (string idList, string propName, string propType, string domainFilter="geometry")
 
var evaluateFormula (string code, string id, string id_otherdomain=string())
 
string prepareJsCode (string code, string id, int dec=-1, string frmt="%L1", int fieldWidth=10, QChar fillChar=QChar())
 
array< string > extractPropertyNames (string code, string startTag="[[", string endTag="]]")
 
array< object > getGlobalProjectProperties ()
 
array< object > getPointList (string objId)
 
object getPointOnAlignmentAtStation (string alignmentId, double d)
 
double getStationOfProjectedPoint (string alignmentId, double x, double y, double z=0.0)
 
array< string > getRegionsOfAlignment (string alignmentId)
 
array< object > getRangesOfRegion (string alignmentID, string regionID)
 
double getValueOfAlignmentRegion (string alignmentID, string regionID)
 
int getTaskMode (string taskID)
 
string getTaskVisualisation (string taskID)
 
string getTaskRestrictionsByTask (string taskID)
 

Additional Inherited Members

- Signals inherited from AdvancedProjectAPI
void selectionChanged ()
 
void selectionChangedByDomain (string domain)
 
void visibilityChanged ()
 
void visibilityChangedByDomain (string domain)
 
void dataUpdated ()
 
void simulationDateChanged (date)
 
void simulationActivated (bool)
 
- Signals inherited from AutomationAPI
void synchronizationFinished (bool success)
 
void fileChunkReceived (string data)
 
void geoPositionUpdated (object pos)
 

Function Documentation

◆ addSuffix

void addSuffix ( string  suffix)
function

Add a file name extension to the list of suffixes handled by calling windows desktop services when clicked instead of handling within VDC Manager. All documents ending with one of the file name extensions in this list are handled by calling the desktop services, i.e. using the standard application set in the operating system.

Parameters
suffixfile name extension e.g. '.html'
Remarks
Files with extension '.cpa', '.cpzip', '.pdf' and '.zip' are always forwarded to the operating system.
href-urls starting with 'desiteProject://' are handled as a relative link to a file within the current project folder.
E.g. the following code will try to open the file callback.html within project folder:
<a href='desiteProject://callback.html'>Click here</>
update 2.3.1, 05 dec 2018, ar, url schema 'desiteProject' added

◆ authorize

void authorize ( object   config,
string   callbackFunctionName 
)
function

Trigger a generic authorization flow.
A separate browser window will open for the login process.
If successful, authorization token data will be returned via a callback function, which must take one string parameter (JSON).
Supported authorization methods are OAuth2 and OAuth2 with PKCE.

Important note: It is not recommended to use OAuth2 without PKCE because it requires you to pass a client secret (clientIdentifierSharedKey).
This will obviously be visible in your code, so use it only for tests or if you won't share your WebForm with others!

Parameters
configObject with the following keys:
  • authorizationMethod - allowed values:
    • "oauth2"
    • "oauth2_pkce"
    • "oauth2_tpcde" (a predefined OAuth2 config for the tp CDE API; all other settings will be ignored when using this)
  • scope (usually "openid")
  • authorizationUrl
  • accessTokenUrl
  • clientIdentifier
  • clientIdentifierSharedKey (only required for OAuth2 without PKCE, be aware of the security risk!)
  • callbackUrl
  • callbackPort
  • audience (optional)
  • window (optional)
    • title (default "Authorization required")
    • width (default 500)
    • height (default 900)
callbackFunctionNameName (as a string) of the callback function. That function must take one string parameter (JSON).
Since
3.1.0, 11 Jun 2022

◆ clearHistory

void clearHistory ( )
function
Since
2.0.19, 02 mar 2018, jh

◆ clearHTTPCache

void clearHTTPCache ( )
function

Clear the HTTP cache entries

Since
3.1.0, 17 Aug 2022

◆ clearProgressMessage

void clearProgressMessage ( )
function

Clear progress widget text.

Since
1.4.11

◆ createPdfByTemplate

string createPdfByTemplate ( string  templateFileName,
string  pdfFileName,
object   printTextBlocks,
bool  openPdf = true 
)
function

Create a PDF from a html print template.
Page settings can be configured by setPapersize(), setOrientation() and setMargins(). Page settings configured by the dialog are taken into account as well.

Parameters
templateFileNameText containing the html print template
pdfFileNameSave file name for the PDF. If empty, a file dialog to choose the save file name will be opened.
printTextBlocksReplaces [[printTextBlock##name]] with given key-value pairs
e.g. replace [[printTextBlock##exampleTable]] and [[printTextBlock##exampleUser]] in the given print template.
{
exampleTable: "<table width=100%><tr><td>user</td><td>anonymous</td></tr></table>",
exampleUser: "anonymous"
}
openPdfIf true, the created PDF will be opened after the creation (optional, default: true).
Returns
File Name
'Error' if file could not be printed.
Since
2013
Remarks
2.8.2, optional parameter 'openPdf', allows creation of several PDF without opening them automatically.
2.9.0, parameter 'printTextBlocks', text blocks will now be passed in instead of returning them through getPrintTextBlock method.

◆ enableInterruptJavaScriptMsg

void enableInterruptJavaScriptMsg ( bool  enabled)
function

By default, the browser engine will show an interrupt message if scripts take a long time to complete.
You can enable or suppress that message with this call.
To have an effect, this must be done on page initialization (e.g. in the "onLoad" event handler).

Parameters
enabledtrue: An interrupt message is shown if a script runs for a long period of time.
false: No message is displayed, the script will run without interruption.
Since
1.5.0, 09 feb 2016, mm

◆ getPageMarginBottom

double getPageMarginBottom ( )
function
Since
2013

◆ getPageMarginLeft

double getPageMarginLeft ( )
function
Since
2013

◆ getPageMarginRight

double getPageMarginRight ( )
function
Since
2013

◆ getPageMarginTop

double getPageMarginTop ( )
function
Since
2013

◆ getProgressState

int getProgressState ( )
function

Get state of the progress widget.

See also
showProgress();
hideProgress();
Returns
0 : undefined / not created
1 : open 2 : closed
Since
1.4.11

◆ getZoomFactor

double getZoomFactor ( )
function
Since
2.0.19, 02 mar 2018, jh

◆ hideProgress

void hideProgress ( )
function

Hide progress widget.

Since
1.4.11

◆ loadUrl

void loadUrl ( string  url)
function

Clear webpage cache and open URL.

◆ processEvents

void processEvents ( )
function

Enforce the processing of the event queue.

Deprecated:
This method will be removed in future versions of VDC Manager and should not be used for new scripts anymore.

◆ redirectUrl

void redirectUrl ( string  originalUrl,
string  redirectUrl 
)
function

Let the WebForms browser redirect a URL.
Note that this works by simple string replacement, so incomplete/partial addresses will work, and passed parameters will be preserved.

Since
2.5.3, 2019-12-06, ah

◆ reloadPage

void reloadPage ( )
function

Load start page.

◆ resetSuffixList

void resetSuffixList ( )
function

Clear the list of file name extensions handled by calling desktop services.

◆ setOrientation

void setOrientation ( int  orientation)
function

Portrait 0 the page's height is greater than its width. Landscape 1 the page's width is greater than its height.

◆ setPageMargins

void setPageMargins ( double  l,
double  r,
double  t,
double  b 
)
function

Set page margins in mm.

Left, Right, Top, Bottom

◆ setPaperSize

void setPaperSize ( int  paperSize)
function

Set paper size. These values are available

A0 5 841 x 1189 mm
A1 6 594 x 841 mm
A2 7 420 x 594 mm
A3 8 297 x 420 mm
A4 0 210 x 297 mm, 8.26 x 11.69 inches
A5 9 148 x 210 mm
A6 10 105 x 148 mm
A7 11 74 x 105 mm
A8 12 52 x 74 mm
A9 13 37 x 52 mm
B0 14 1000 x 1414 mm
B1 15 707 x 1000 mm
B2 17 500 x 707 mm
B3 18 353 x 500 mm
B4 19 250 x 353 mm
B5 1 176 x 250 mm, 6.93 x 9.84 inches
B6 20 125 x 176 mm
B7 21 88 x 125 mm
B8 22 62 x 88 mm
B9 23 33 x 62 mm
B10 16 31 x 44 mm
C5E 24 163 x 229 mm
Comm10E 25 105 x 241 mm, U.S. Common 10 Envelope
DLE 26 110 x 220 mm
Executive 4 7.5 x 10 inches, 190.5 x 254 mm
Folio 27 210 x 330 mm
Ledger 28 431.8 x 279.4 mm
3 8.5 x 14 inches, 215.9 x 355.6 mm
Letter 2 8.5 x 11 inches, 215.9 x 279.4 mm
Tabloid 29 279.4 x 431.8 mm
Custom 30 Unknown, or a user defined size.
Since
1.3.0, 15 nov 2013, jh

◆ setZoomFactor

void setZoomFactor ( double  value)
function
Since
2.0.19, 02 mar 2018, jh

◆ showConsole

void showConsole ( bool  show)
function

Show/hide debug console.

◆ showNavigation

void showNavigation ( bool  visible)
function
Since
2.5.3, 22 Nov 2019

◆ showProgress

void showProgress ( object   valuesMap)
function

Show progress widget.

Parameters
valuesMapConfig as JSON

Config:

{
text: true,
bar: true,
label: true,
closeButton: false,
title: "Write data"
}

"text" is for the main window content (multi-line), "label" is a single-line output above the progress bar.

Since
1.4.11
Remarks
2.2.4, 2018-10-09, ah; added "closeButton" option. Previously, the button was always shown but did nothing.

◆ showProgressMessage

void showProgressMessage ( string   msg)
function

Add a message to the progress widget.

Since
1.4.11

◆ showProgressMessageConsole

void showProgressMessageConsole ( string  msg)
function

Print to console.

◆ showProgressMessageLabel

void showProgressMessageLabel ( string   msg)
function

Set the progress label text (shows at the bottom, above the progress bar)

Since
1.4.11

◆ showProgressValue

void showProgressValue ( double  value)
function

Set value of the progress bar as a floating point number.
Value range [0,1]

Since
1.4.11

◆ tpApiAuth

void tpApiAuth ( string   callbackFunctionName)
function
Deprecated:
This method will be removed in future versions of VDC Manager and should not be used for new scripts anymore.

Open the Thinkproject SSO page for authorization for the tp CDE API.
The authorization workflow is asynchronous, therefore the result is reported back through a callback function.

Parameters
callbackFunctionNameName (as a string) of the callback function. That function must take one string parameter (JSON).
See also
authorize()
Since
2.7.1, 13 Oct 2020
2.9.0, 12 Nov 2021 : moved from NavigatorProjectAPI and changed return value to callback
Remarks
Deprecated since 3.1.0, 14 Jun 2022
Deprecated:
Call authorize() with the predefined authorizationMethod for the tp CDE API:
desiteAPI.authorize({"authorizationMethod":"oauth2_tpcde"}, callbackFunction.name);
Created: Sat May 10 2025 00:07:14