https://cadviewer.com/cadviewertechdocs/Recent content in CADViewer Documentation Overview on CADViewer Technical Documentation, Installation Guide and Reference Samples LibraryHugo -- gohugo.ioen-usSun, 18 Jan 2026 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/frontend/scriptlibraries/Sat, 04 Apr 2020 15:26:15 +0000https://cadviewer.com/cadviewertechdocs/frontend/scriptlibraries/In the front-end code, in addtion to the CADViewer core Java Script libraries, CADViewer uses a set of auxillary libraries and stylesheets. The setup depends on how CADViewer is installed, either with 1: npm installer or through 2: javascript library download. 1: npm install When using the npm install of CADViewer, all dependency javascript libraries are installed in the node_modules structure. Use the following import command to add CADViewer. import * as cadviewer from "cadviewer"; Then for all further initializations of CADViewer, the following general variables are used:https://cadviewer.com/cadviewertechdocs/frontend/htmlelement/Sat, 04 Apr 2020 15:26:15 +0000https://cadviewer.com/cadviewertechdocs/frontend/htmlelement/The initialization process of CADViewer, needs to be passed over an id of an <div> in which CADViewer will be running. Application programmers can choose any identifier name on this <div>, but we choose ‘floorPlan’ in all our samples. For the frameworks ReactJS, Angular and VueJS, the ‘floorPlan’ <div> will be placed in the src component structure. Note: that CADViewer supports multiple instances of CADViewer in the same document. In the case, multiple instances of CADViewer are used in the same document, the back-end converter API control call: cvjs_conversion_addAXconversionParameter(“POSTFIX”, “”); must be set, otherwise layers will not display properly if the multiple CADViewer instances are loading layers with the same name.https://cadviewer.com/cadviewertechdocs/blocks/create-blocks/Mon, 08 Aug 2022 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/blocks/create-blocks/Blocks are an integral part of a DWG drawing and our CAD converter AutoXchange 2023 has the ablity to parse blocks when processing a drawing for display in CADViewer. Process the blocks using a subset of the conversion parameters defined in: Database Linkages Database Parameters BLOCKNAME Block Name to process BLOCKNAMELAYER Layer to get Block Names from IA Invisible Attributes BA Blank Attributes BNA Block Name Attribute IB Ignoring AutoCAD-Blocks Apply the conversion parameters in CADViewer using:https://cadviewer.com/cadviewertechdocs/spacemanagement/interactive_insertion_standard/Wed, 07 Oct 2020 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/spacemanagement/interactive_insertion_standard/Space objects can be inserted in two ways, either through the Space Object Menu Interface, or directly through API commands: Menu Controlled Insertion of Space Objects Application programmers can through the API for Custom Space Object Menu add Space Objects as either standard SVG, layered Inkscape SVGs or standard bitmaps. The Custom Space Object Menu includes a scaling tool for insertion, and the funtional implementation of the call-back method cvjs_graphicalObjectOnChange can be used to extract the JSON definition of the space object and set it’s properties such as ID, name, etc.https://cadviewer.com/cadviewertechdocs/handlers_business/customendpointextension/Mon, 10 Aug 2020 13:52:18 +0700https://cadviewer.com/cadviewertechdocs/handlers_business/customendpointextension/Below is the sample application implementation for /routes/cvjs_customConversionEndpointExtension_6.9.xx in cadviewer-conversion-server. var config = require('../CADViewer_config.json'); var callapiconversion = require('./callapiconversion_cv6.9.04.js'); const request = require('request'); var bearerautentication = config.custom_bearerAutentication; // settings can be in general CADViewer config file, or loaded in here exports.cvjs_customConversionEndpointExtension = function (contentLocation, writeFile, outputFormat, parameters, tempFileName, res, action, fileFormat){ // USER CHANGES THIS CONTENT // var bearerautentication = "XX"; // from config file or set by user // contentLocation is passed over from REST API // writeFile is the location on server to write the file/blob // cvjs_standard_CV_AX_processing() is the call to continue the processing to convert and return to CADViewer var cadfilename = ""; // filename is passed over from cadviewer contentLocation, or pulled from user call var fileurl = ""; // we make branches depending on how the incoming stream is parsed var branch = 1; // simply request a URL and store in /converters/files/ folder and as server to convert // branch = 2 // sample to do a GET (or POST) with bearer authentication to get a blob and then save that to /converter/files/folder if (branch == 1){ contentLocation = decodeURIComponent(contentLocation); if (config.https://cadviewer.com/cadviewertechdocs/handlers/php/Fri, 10 Jul 2020 13:52:18 +0700https://cadviewer.com/cadviewertechdocs/handlers/php/Folder Structure For a CADViewer PHP installation, the base file-structure should be as below: windows: c:\xampp\htdocs linux: /var/www/html/ └─── cadviewer ├── app │ ├── cv │ │ ├── cv-pro │ │ │ ├── menu_config │ │ │ ├── language_table │ │ │ └── space │ │ │ ├── css │ │ │ └── html │ │ ├── cv-core │ │ │ ├── menu_config │ │ │ └── language_table │ │ └── cv-custom_commands │ ├── fonts │ ├── images │ ├── js │ ├── css │ └── user_resources ├── converters │ ├── ax2022 │ │ ├── windows │ │ │ └── fonts │ │ └── linux │ │ └── fonts │ ├── dwgmerge2022 │ │ ├── windows │ │ │ └── fonts │ │ └── linux │ │ └── fonts │ ├── linklist2022 │ │ ├── windows │ │ │ └── fonts │ │ └── linux │ │ └── fonts │ └── files ├── php ├── content ├── html └── temp_print Note that folders for advanced interaction, such as database connectivity and advanced REST-API connectivity features are not included in this folder tree, please see the Samples section for integration with this type of functionality.https://cadviewer.com/cadviewertechdocs/faq/npm_ssl_install/Sun, 12 Apr 2020 08:16:15 +0000https://cadviewer.com/cadviewertechdocs/faq/npm_ssl_install/If installing CADViewer through npm npm i cadviewer If, during installation, getting an “An unknown git error occurred” for unsupported option “accept-new”, then the issue is the SSH key, which in some environments can be troublesome to set up. To bypass this (on Windows/MAC/Linux) simply run: git config --global url."https://".insteadOf git:// This forces the use of https instead of SSH and will then be successful in installing CADViewer through npm.https://cadviewer.com/cadviewertechdocs/samples/json/Thu, 09 Apr 2020 15:26:15 +0000https://cadviewer.com/cadviewertechdocs/samples/json/Online Demo Link Try out this CADViewer Dynamic Modification of Title Block Output using JSON Sample on our onlinedemo.cadviewer.com server. Make sure to allow pop-up’s in your web-browser for this server. URL parameters This CADViewer sample uses the Url parameter interface to pass over the drawing to display, as well as the location of a JSON file which is used to modify the Drawings Title Block information when printing to PDF.https://cadviewer.com/cadviewertechdocs/redlines/modalsetup/Thu, 09 Apr 2020 15:26:15 +0000https://cadviewer.com/cadviewertechdocs/redlines/modalsetup/Redlines Modal Setup The initialization method cvjs_setRedlinesAbsolutePath() controls the path to the file location, that links with the Redline File Loader and Save Modal. /** * @param {string} path - abslute URL to the redlines location * @param {string} serverPath - absolute path to the redlines location, "/home/cadviewerjs/redlines/" * @param {boolean} dynamicPathFlag - dynamic location for each input file, input file name and path concatenated to path. */ cadviewer.cvjs_setRedlinesAbsolutePath(ServerBackEndUrl+'/content/redlines/v7/', ServerLocation+'/content/redlines/v7/',false); // The /content/redlines/ path is already set up with all the back-end CADViewer Servers on our GitHub Repositories.https://cadviewer.com/cadviewertechdocs/blocks/working-with-blocks/Mon, 08 Aug 2022 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/blocks/working-with-blocks/When working with blocks, we have compiled a set of Guides that can help you optimize the block content you would like to work with in your drawing: Declutter blocks Preparing CAD Drawings for Online Display - this resouce illustrates among others how to declutter a drawing by removing blocks. Extract attributes as JSON Online Hierarchy Display from AutoCAD Illustrates how to use LinkList 2023 to extract block and block attribute content out of a drawing, which can then be used to manipulate the blocks in the CADViewer front-end.https://cadviewer.com/cadviewertechdocs/spacemanagement/coordinate_insertion_standard/Wed, 07 Oct 2020 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/spacemanagement/coordinate_insertion_standard/The CADViewer API can programmatically be used to place out Image Space Objects or custom objects on the canvas at a defined location based on its coordinates. When placing out a space image objects at a coordinate location, the following three methods are used: function cvjs_setImageSpaceObjectParameters(), function cvjs_setGlobalSpaceImageObjectScaleFactor() (optional) , and function cvjs_addFixedSizeImageSpaceObjectXY(): where the JavaScript code is as follows: // place the icon on the canvas programmatically cvjs_setImageSpaceObjectParameters(loadSpaceImage_LocationOrbase64Object, loadSpaceImage_ID, loadSpaceImage_Type, loadSpaceImage_Layer); cvjs_setGlobalSpaceImageObjectScaleFactor(1.https://cadviewer.com/cadviewertechdocs/handlers/nodejs/Fri, 10 Jul 2020 13:52:18 +0700https://cadviewer.com/cadviewertechdocs/handlers/nodejs/This documents running a standard CADViewer top-level JavaScript instance with the NodeJS conversion server in the same folder tree. The NodeJS backend server: https://github.com/CADViewer/cadviewer-conversion-server, are typically the primary Back-end installation when installing CADViewer on ReactJS, Angular and VueJS. Folder Structure For a CADViewer NodeJS installation on Windows, the base file-structure should be as below: windows: c:/nodejs linux: /usr/bin/ └─── cadviewer-conversion-server ├── app │ ├── cv │ │ ├── cv-pro │ │ │ ├── menu_config │ │ │ └── language_table │ │ ├── cv-core │ │ │ ├── menu_config │ │ │ └── language_table │ │ └── cv-custom_commands │ ├── js │ └── css ├── converters │ ├── ax2022 │ │ ├── windows │ │ │ └── fonts │ │ └── linux │ │ └── fonts │ ├── dwgmerge2022 │ │ ├── windows │ │ │ └── fonts │ │ └── linux │ │ └── fonts │ ├── linklist2020 │ │ ├── windows │ │ │ └── fonts │ │ └── linux │ │ └── fonts │ └── files ├── content ├── html └── temp_print Note that folders for advanced interaction, such as database connectivity and advanced REST-API connectivity features are not included in this folder tree, please see the Samples section for integration with this type of functionality.https://cadviewer.com/cadviewertechdocs/faq/cv_dotnetcore/Sun, 12 Apr 2020 08:16:15 +0000https://cadviewer.com/cadviewertechdocs/faq/cv_dotnetcore/A typical error would be that the path settings in apsettings.json used by CADViewerController does not match the actual install location. Check the log files in the env.WebRootPath/temp_debug, typically cadviewer/wwwroot/temp_debug/, to see if there are any path errors in file creation, file save and file conversion. Folder wwwroot/temp_debug and compare those traces with the settings in: apsettings.json { "Logging": { "LogLevel": { "Default": "Warning" } }, "AllowedHosts": "*", "CADViewer": { "ServerLocation": "c:/cadviewer-testapp-dotnet-core-01/cadviewer/cadviewer/wwwroot/", "ServerUrl": "https://localhost:44374/", "fileLocation": "c:/cadviewer-testapp-dotnet-core-01/cadviewer/cadviewer/wwwroot/converters/files/", "fileLocationUrl": "https://localhost:44374/converters/files/", "converterLocation": "c:/cadviewer-testapp-dotnet-core-01/cadviewer/cadviewer/wwwroot/converters/ax2022/windows/", "ax2020_executable": "AX2023_W64_23_01_72.https://cadviewer.com/cadviewertechdocs/redlines/callbackmethod/Thu, 09 Apr 2020 15:26:15 +0000https://cadviewer.com/cadviewertechdocs/redlines/callbackmethod/CADViewer has two call back methods that is used with Redlines. Call-back method OnLoadEnd() When a drawing is loaded, the call-back method cvjs_OnLoadEnd() is executed. This method cvjs_OnLoadEnd() can be used to set the current User Name and ID for use with Redlines and Sticky Notes, these API methods are: cvjs_setCurrentStickyNoteValues_NameUserId() and cvjs_setCurrentRedlineValues_NameUserid(). If a Redline has to be loaded with a drawing, then in the cvjs_OnLoadEnd() callback, application programmers can add a method call to set the load path to the redline cvjs_setStickyNoteRedlineUrl(), and then trigger a direct load with cvjs_loadStickyNotesRedline().https://cadviewer.com/cadviewertechdocs/blocks/highlight-of-blocks/Mon, 08 Aug 2022 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/blocks/highlight-of-blocks/When blocks are converted into CADViewer as Space Objects, they share the exact same interface as standard Space Objects. A core functionality of the CADViewer Space Object API (for Blocks) is the ability to interactively control the higlight, hatching and text decoration of Space Objects. Please see the detailed guide: Guide - Style Hotspots & Images as well as: Highlight Operations on Blocks/Space Objects Layer Operations on Blocks/Space Objectshttps://cadviewer.com/cadviewertechdocs/spacemanagement/interactive_insertion_json/Wed, 07 Oct 2020 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/spacemanagement/interactive_insertion_json/The command links below will open the command documentation in the CADViewer JavaScript API. cvjs_addSpaceObject() - add a Space Object based on Size and JSON Object Please see the Guide Working with Layered Space Objects for adding layered objects. cvjs_addLayeredSpaceObject() - add a space object consistant of multiple layered images for dynamic change control of imagehttps://cadviewer.com/cadviewertechdocs/rest_api/standard_request_response/Wed, 07 Oct 2020 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/rest_api/standard_request_response/CADViewer REST API Request A Request will contain the following Key-Value pairs section: Request Key Request Value action The action can be one of the following: conversion, data_extraction, svg_creation, pdf_creation and cadviewer_display. converter Either “autodetect” or the name of the converter, AutoXchange 2023, LinkList 2022, DwgMerge 2022, etc. version Version of converter if not “autodetect” contentType The content type can be one of the following: “file”, “embedded”, “stream” . “file” is a physical url, “embedded” is for a base64 encoded file embedded in the call, “stream” is a stream end-point included in the call Depended on the setting of the contentType key, then one of the below Key-Value pairs.https://cadviewer.com/cadviewertechdocs/handlers/servlets/Wed, 07 Oct 2020 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/handlers/servlets/Folder Structure For a CADViewer Servlets installation under Tomcat on Windows, the base file-structure should be as below: NOTE: Under Linux replace c:\xampp\tomcat\webapps with /var/lib/tomcat{X}. c:\xampp\tomcat\webapps └─── cadviewer ├── app │ ├── cv │ │ ├── cv-pro │ │ │ ├── menu_config │ │ │ ├── language_table │ │ │ └── space │ │ │ ├── css │ │ │ └── html │ │ ├── cv-core │ │ │ ├── menu_config │ │ │ └── language_table │ │ └── cv-custom_commands │ ├── fonts │ ├── images │ ├── js │ ├── css │ └── user_resources ├── converters │ ├── ax2022 │ │ ├── windows │ │ │ └── fonts │ │ └── linux │ │ └── fonts │ ├── dwgmerge2022 │ │ ├── windows │ │ │ └── fonts │ │ └── linux │ │ └── fonts │ ├── linklist2022 │ │ ├── windows │ │ │ └── fonts │ │ └── linux │ │ └── fonts │ └── files ├── WEB-INF │ ├── classes │ └── lib ├── content ├── html └── temp_print 1: Download and install CADViewer under this structure.https://cadviewer.com/cadviewertechdocs/samples/cafm/Wed, 13 May 2020 06:26:15 +0000https://cadviewer.com/cadviewertechdocs/samples/cafm/Online Demo Link This CADViewer Online Sample illustrates the CADViewer Space Object interface. CADViewer is implemented in a use-case where buildings are being surveyed for Aspestos. The CADViewer Space Object interface has been used to create and link spaces and CADViewer is being set up to interact with an encapsulating application to display and highlight content related to each space. Click Here! Setup of Modals Use the Section section Call-Back Dynamic Modals for Highlight to set up the call-back Modals which will change content dynamically based on which Space is clicked.https://cadviewer.com/cadviewertechdocs/samples/json2/Sat, 25 Apr 2020 05:26:15 +0000https://cadviewer.com/cadviewertechdocs/samples/json2/Online Demo Link Try out this CADViewer Dynamic Modification Variables using JSON Sample on our onlinedemo.cadviewer.com server. Make sure to allow pop-up’s in your web-browser for this server. About This Sample This CADViewer sample uses the AutoXchange 2020 interface for JSON variables, where text strings defined either as %%%variable%%% or $$$variable$$$ can be identified and replaced with custom content. This CADViewer sample uses the Url parameter interface to pass over parameters to set the Print Modal to activate the controls:https://cadviewer.com/cadviewertechdocs/faq/cv_dotnetcore2/Sun, 12 Apr 2020 08:16:15 +0000https://cadviewer.com/cadviewertechdocs/faq/cv_dotnetcore2/If CADViewer controller is implemented in a module, the CADViewer parameter for callbackMethod in apsettings.json, needs to have a qualified URL pointing to the controller end-point in the module, as it will otherwise be evaluated on top-level. original apsettings.json { "CADViewer": { ... "callbackMethod": "/CADViewer/getFile", .... } } changed apsettings.json { "CADViewer": { ... "callbackMethod": "https://localhost:44325/_content/Sub.Module.CadViewer/CADViewer/getFile", .... } }https://cadviewer.com/cadviewertechdocs/handlers/asp.net/Thu, 09 Apr 2020 15:26:15 +0000https://cadviewer.com/cadviewertechdocs/handlers/asp.net/Folder Structure For a CADViewer .NET installation, the base file-structure should be as below: CADViewer and AutoXchange is included in this repository, but it can be recreated by downloading the components directly from: https://cadviewer.com/download, or from our dotNet GitHub Repository. c:\VisualStudio └─── cadviewer ├── app │ ├── cv │ │ ├── cv-pro │ │ │ ├── menu_config │ │ │ ├── language_table │ │ │ └── space │ │ │ ├── css │ │ │ └── html │ │ ├── cv-core │ │ │ ├── menu_config │ │ │ └── language_table │ │ └── cv-custom_commands │ ├── fonts │ ├── images │ ├── js │ ├── css │ └── user_resources ├── converters │ ├── ax2022 │ │ ├── windows │ │ │ └── fonts │ │ └── linux │ │ └── fonts │ ├── dwgmerge2022 │ │ ├── windows │ │ │ └── fonts │ │ └── linux │ │ └── fonts │ ├── linklist2022 │ │ ├── windows │ │ │ └── fonts │ │ └── linux │ │ └── fonts │ └── files ├── content ├── html └── temp_print Note that folders for advanced interaction, such as database connectivity and advanced REST-API connectivity features are not included in this folder tree, please see the Samples section for integration with this type of functionality.https://cadviewer.com/cadviewertechdocs/redlines/api-loadsave/Thu, 09 Apr 2020 15:26:15 +0000https://cadviewer.com/cadviewertechdocs/redlines/api-loadsave/API Controlled Redlines Load/Save The following two methods cvjs_saveStickyNotesRedlinesUser() and cvjs_loadStickyNotesRedlinesUser controls if Redlines are loaded/saved through the Modals, or directly controlled. The standard setup for loading through modals are as follows: // This method is linked to the save redline icon in the imagemap function cvjs_saveStickyNotesRedlinesUser(){ // there are two modes, user handling of redlines // alternatively use the build in redline file manager cadviewer.cvjs_openRedlineSaveModal("floorPlan"); // custom method startMethodRed to set the name and location of redline to save // see implementation below //startMethodRed(); // API call to save stickynotes and redlines //cadviewer.https://cadviewer.com/cadviewertechdocs/callback/onloadend/Thu, 09 Apr 2020 15:26:15 +0000https://cadviewer.com/cadviewertechdocs/callback/onloadend/cvjs_OnLoadEnd() is the general call-back method to when a drawing has been loaded. Typically when a drawing is loaded, a number of drawing specific API methods can be called, such as redline user settings, layer on/off, zoom extents, background color settings, etc. When this callback method have been called the full content of the CADViewer Front-End API can be applied: function cvjs_OnLoadEnd(){ // generic callback method, called when the drawing is loaded // here you fill in your stuff, call DB, set up arrays, etc.https://cadviewer.com/cadviewertechdocs/frontend/initialize/Sat, 04 Apr 2020 15:26:15 +0000https://cadviewer.com/cadviewertechdocs/frontend/initialize/Initialization Use the initialization method that corresponds to the attribute controls you want to run CADViewer with. The minimum initialization must reference a div element <div> with a defined id, in all our Samples and Repositories we use ‘floorPlan’. The initialization should be onLoad or onComponentMount, and then an additional handler needs to be exposed for Resize. Method Calls Use the intialization calls to the CADViewer API methods in the following order:https://cadviewer.com/cadviewertechdocs/frontend/languagemenu/Sun, 22 Mar 2020 15:26:15 +0000https://cadviewer.com/cadviewertechdocs/frontend/languagemenu/CADViewer Version CADViewer has two interfaces: Version 8 icons which uses scalable icons in SVG and legacy Version 6 icons which are based on bitmap icons at fixed size. Version 6 icons are light gray, whereas Version 8 icons are either black or deepblue. cvjs_setCADViewerInterfaceVersion(8) - default is Version 8 (version 7+), use this method and set to 6 for legacy Version 6 interface. cvjs_setIconImageSize(“floorPlan”,30, 40) - if in Version 8 -as the icons are scalable- the two icon menu sizes can be custom controlled through this API command, the default is 30px for small icons and 40px for large icons.https://cadviewer.com/cadviewertechdocs/frontend/customiconcommands/Sun, 22 Mar 2020 15:26:15 +0000https://cadviewer.com/cadviewertechdocs/frontend/customiconcommands/Please read the section Menu Layout and Language Settings first. In CADViewer, there are built 20 placeholders for Icon menu commands that the application programmer can use to add their own interactive Menus. The commands can be inserted into the XML configuration menu at a location of choice, and their corresponding pop-up text is set in sequential order at the tag. Sample XML Structure <cvjs> <iconmenu> <totalpages>1</totalpages> <startpage>1</startpage> <pages> <page> <command>cvjs_customCommand_01</command> <!https://cadviewer.com/cadviewertechdocs/blocks/highlight-of-block-attributes/Mon, 08 Aug 2022 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/blocks/highlight-of-block-attributes/When a block is created as a JSON object, its attributes can be retried from the Space Object JSON Structure. The Space Object JSON structure contains two variables specific for block handling: blockAttributeId blockAttributeIdCount The algorithm to access Block Attributes and their corresponding values are found by looping over number of attributes, and extract their tag/value pairs. myobject = cvjs_returnSpaceObjectID(rmid); try { // get block attribute: // block attributes are listed with ID_counter , and can be retrived with cvjs:tag and cvjs:value for (var i = 1; i <= myobject.https://cadviewer.com/cadviewertechdocs/spacemanagement/customspaceobjectmenu/Wed, 07 Oct 2020 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/spacemanagement/customspaceobjectmenu/The custom space menus, can be loaded from the file-system or they can be inserted through the API Standard Declaration API Insertion On Load Standard Declaration The Custom Space Object Menu is declared with the API command: // 6.9.18 // set SpaceObjectsCustomMenu location and json config file, flag true to display SpaceObject Menu, false to hide cadviewer.cvjs_setSpaceObjectsCustomMenu( "/content/customInsertSpaceObjectMenu/", "cadviewercustomspacecommands.json", true); The parameters sets the server side path on the CADViewer Server containing the Space Object symbols, the configuration JSON file to create the Icon menu, and a flag to set either on/off.https://cadviewer.com/cadviewertechdocs/rest_api/request_available_engines/Wed, 07 Oct 2020 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/rest_api/request_available_engines/API Request structure - Available Engines - Request A call to the TMS REST Api to pull the available conversion engines and their version number is structured as: { "converters": "listInstalledEngines" } API Response structure - Available Engines - Response The structure of the response: { "installedEngines": [ { "converter" : "name of converter/engine", "version" : "version of converter/engine", "status":"active | nonActive" }, { "converter" : "name of converter/engine", "version" : "version of converter/engine", "status":"active | nonActive" }, { "converter" : "name of converter/engine", "version" : "version of converter/engine", "status":"active | nonActive" }, .https://cadviewer.com/cadviewertechdocs/rest_api/request_conversion/Wed, 07 Oct 2020 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/rest_api/request_conversion/API Request structure - Conversion/Extraction - Request A call to the TMS REST Api will typically consist of the following structure, where the “|” notates that one of the options can be selected in the call. { "action": "conversion | data_extraction | svg_creation | pdf_creation | cadviewer_display" , "converter":"autodetect | AutoXchange 2023 | AutoXchange 2022 | LinkList 2022 | DwgMerge 2022 | ..", "version":"latest | Vx.yy", "contentType":"file | embedded | stream", "contentLocation":"url to the location of the content file (can be http or absolute path on conversion server) | none (if contentType is embedded or stream)", "contentStream":"url to the location of the content stream | none (if contentType is file or embedded)", "embeddedContent":" base64 encoded file | none (if contentLocation is file or stream)", "contentFormat":"DWG | DXF| DWF | DGN | PDF ", "contentUsername":" username when TMS REST is calling content location/stream to pick up content", "contentPassword":" password when TMS REST is calling location/stream to pick up content", "userLabel":" optional label returned in the response", "contentResponse":" file | embedded | stream", "parameters": [ { "paramName":" name of parameter", "paramValue":"value of parameter" }, { "paramName":" name of parameter", "paramValue":"value of parameter" }, { "paramName":" name of parameter", "paramValue":"value of parameter" }, .https://cadviewer.com/cadviewertechdocs/samples/spaceicons/Mon, 07 Sep 2020 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/samples/spaceicons/Online Demo Link Try out this CADViewer Sample, in which you can place out interactive SVG icons onto the CAD canvas and control them through the API. About This Sample This CADViewer sample illustrates the CADViewer Space Icon Object Interface. For a detailed description of the commands used, see the Space Icons User Manual. Simply select a Icon, click Insert Space Image, and place the Icon into the Canvas. The API settings of Space Name, Space ID and SVG image are display for each selection and the ID of spaces are automatically incremented when Insert Space Image is clicked.https://cadviewer.com/cadviewertechdocs/handlers/dotnetcore/Thu, 09 Apr 2020 15:26:15 +0000https://cadviewer.com/cadviewertechdocs/handlers/dotnetcore/Folder Structure For a CADViewer dotNetcore installation on Windows, the base file-structure should be as below: CADViewer and AutoXchange is included in this repository, but it can be recreated by downloading the components directly from: https://cadviewer.com/download, or from our dotNetCore GitHub Repository. c:\cadviewer-testapp-dotnet-core-01\cadviewer\cadviewer\ └─── wwwroot ├── app │ ├── cv │ │ ├── cv-pro │ │ │ ├── menu_config │ │ │ ├── language_table │ │ │ └── space │ │ │ ├── css │ │ │ └── html │ │ ├── cv-core │ │ │ ├── menu_config │ │ │ └── language_table │ │ └── cv-custom_commands │ ├── fonts │ ├── images │ ├── js │ ├── css │ └── user_resources ├── converters │ ├── ax2022 │ │ ├── windows │ │ │ └── fonts │ │ └── linux │ │ └── fonts │ ├── dwgmerge2022 │ │ ├── windows │ │ │ └── fonts │ │ └── linux │ │ └── fonts │ ├── linklist2022 │ │ ├── windows │ │ │ └── fonts │ │ └── linux │ │ └── fonts │ └── files ├── content ├── html └── temp_print Note that folders for controller configuration are set as part of the dotNet core main projecthttps://cadviewer.com/cadviewertechdocs/callback/onloadendredlines/Thu, 09 Apr 2020 15:26:15 +0000https://cadviewer.com/cadviewertechdocs/callback/onloadendredlines/cvjs_OnLoadEndRedlines() is used for Redlines callback, used to freeze/thaw redlines, turn redlines on/off: See more under the section for Redlines control. function cvjs_OnLoadEndRedlines(){ // generic callback method, called when the redline is loaded // here you fill in your stuff, hide specific users and lock specific users // this method MUST be retained as a dummy method! - if not implemeted - // I am hiding users added to the hide user list cvjs_hideAllRedlines_HiddenUsersList(); // I am freezing users added to the lock user list cvjs_lockAllRedlines_LockedUsersList(); }https://cadviewer.com/cadviewertechdocs/frontend/converting/Sat, 04 Apr 2020 15:26:15 +0000https://cadviewer.com/cadviewertechdocs/frontend/converting/To connect the CADViewer front-end with our back-end CAD Converters for seamless on-the-fly viewing of drawings, please install our Back-End Converters and connecting Handlers depending on the back-end technology. Please see the previous section initialize, in order to make sure to set the correct combination of Front-end framework and Back-end server technology. cvjs_setAllServerPaths_and_Handlers() - requiredhttps://cadviewer.com/cadviewertechdocs/spacemanagement/inkscape/Sat, 02 Jul 2022 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/spacemanagement/inkscape/Aplication programmers can design SVG images in Inkscape and use the Inkscape layer concept to organize and name layers inside the SVG image. These SVG images can subsequently be inserted into the drawing through the Custom Space Object Menu. The layers defined inside Inkscape can now be directly accessed and manipulated through the CADViewer Front-end API, see the Space Object Layers section for details. This is extremely useful for any application in IOT, Integrated Workplace Management Solutions and Security & Surveillance Applications, where there is a need to dynamically change the state of an object.https://cadviewer.com/cadviewertechdocs/spacemanagement/layer_operation/Wed, 07 Oct 2020 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/spacemanagement/layer_operation/Space Objects Layers Space Objects are associated to a layer that can be operated similar to the Geometrical Elements in the drawings. The links below will open the command documentation in the CADViewer JavaScript API. cvjs_allSpaceObjectsOff() cvjs_allSpaceObjectsOn() cvjs_setSpaceObjectsDefaultLayer() cvjs_getSpaceObjectDefaultLayer() cvjs_getLayerForSpaceObject() cvjs_getLayerOnSpaceObject() cvjs_setSpaceObjectOnLayer() cvjs_setSpaceObjectOnOff() cvjs_returnAllSpaceObjectsOnLayer() cvjs_spaceObjectLayerOnOff() Layers inside Inkscape SVG image cvjs_hideObjectInSpaceObjectGroup(id_node,objectTag, type) cvjs_showObjectInSpaceObjectGroup(id_node,objectTag, type) cvjs_showOnlyObjectInSpaceObjectGroup(id_node, objectTag, type ) cvjs_showOnlyObjectInAllSpaceObjectGroups(objectTag)https://cadviewer.com/cadviewertechdocs/spacemanagement/highlight/Wed, 07 Oct 2020 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/spacemanagement/highlight/A core functionality of the CADViewer Space Object API is the ability to interactively control the higlight, hatching and text decoration of Space Objects. Please see the detailed guide: Guide - Style Hotspots & Images All our Integrated Samples at our GitHub repository as well as some of the Samples in this section, will contain examples of the Highlight methods below. The links below will open the command documentation in the CADViewer JavaScript API.https://cadviewer.com/cadviewertechdocs/rest_api/template_objects/Wed, 07 Oct 2020 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/rest_api/template_objects/A sample REST API call will need a data object to pass over to the REST API Server. Three template objects conv_extr_request1, conv_extr_request2 and conv_extr_request3 are set up for data extraction, data conversion and CADViewer display. Template object for data extraction: This date extractiopn object is coded with a sample file location on the Tailor Made Software demo server. // DATA EXTRACTION OBJECT var conv_extr_request1 = new Object(); conv_extr_request1.action = "data_extraction"; conv_extr_request1.https://cadviewer.com/cadviewertechdocs/samples/autonomous_space_objects/Tue, 09 Jun 2020 05:26:15 +0000https://cadviewer.com/cadviewertechdocs/samples/autonomous_space_objects/Online Demo Link Try out this CADViewer Sample, in which you can place out interactive Space Icon Objects with Text onto the CAD canvas and control them through the API. About This Sample This CADViewer sample illustrates the CADViewer Space Object API to place, move and manipulate Objects on the CADViewer Canvas using the CADViewer API. Simply fromt the text fields, set Icon, Space type and ID, as well as Space Object Text, click button Create Text Space Object, and the API is used to place out the object on the Canvas using DWG coordinates.https://cadviewer.com/cadviewertechdocs/frontend/fileloader/Thu, 09 Apr 2020 15:26:15 +0000https://cadviewer.com/cadviewertechdocs/frontend/fileloader/The initialization methods cvjs_setServerFileLocation() and cvjs_setServerFileLocation_AbsolutePaths() controls the path to the file location, that links with the File Loader Modal. Click on the method to open the API documentation. cvjs_setServerFileLocation() - optional cvjs_setServerFileLocation_AbsolutePaths() - optional NOTE: If ServerLocation is set to “”, the back-end converter will concatenate to the back-end installation path.https://cadviewer.com/cadviewertechdocs/redlines/modal-loadsave/Thu, 09 Apr 2020 15:26:15 +0000https://cadviewer.com/cadviewertechdocs/redlines/modal-loadsave/API Controlled Direct Load and Save of Redlines from Local Source The Redline load and Save modals can be set up so that Redlines are loaded and saved from local sources. This is for use-cases where users do not want to commit their redline annotations to a central server. Application programmers will comment out the standard modal load and save and expose the methods cvjs_directDownloadStickyNotesRedlines() and cvjs_directUploadStickyNotesRedlines(). Click on the method to open the API documentation.https://cadviewer.com/cadviewertechdocs/blocks/block-substitution/Mon, 08 Aug 2022 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/blocks/block-substitution/The graphical image of a Block can be substituted with another image object. Firstly, ensure the drawing is processed with Blocks converted into Space Objects, below as a sample,the audiovisual block is being processed in CADViewer. Conversion parameters cadviewer.cvjs_conversion_clearAXconversionParameters(); // process blocks with a given name, in this case "audiovisual" cadviewer.cvjs_conversion_addAXconversionParameter("blockname", "audiovisual"); // process all invisible attributes in the block cadviewer.cvjs_conversion_addAXconversionParameter("ia", ""); // open the modelspace cadviewer.cvjs_conversion_addAXconversionParameter("model", ""); // Load file - needs the svg div name and name and path of file to load cadviewer.https://cadviewer.com/cadviewertechdocs/spacemanagement/query/Wed, 07 Oct 2020 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/spacemanagement/query/The CADViewer API supports a number of Query operations on Space Objects. The links below will open the command documentation in the CADViewer JavaScript API. cvjs_currentMaxSpaceNodeId() cvjs_currentMaxNodeId() cvjs_getSpaceObjectIdList() cvjs_getSpaceObjectNamesList() cvjs_getSpaceObjectTypefromId() cvjs_getSpaceObjectNodefromId() cvjs_getSpaceObjectNamefromId() cvjs_getSpaceObjectIdfromNode() cvjs_getSpaceObjectNamefromNode() cvjs_getAttributeStatus() cvjs_getAttributeFromSpaceObjectNode() cvjs_returnSpaceObjectSelected() cvjs_getSpaceObjectDirectXYCoord() cvjs_returnActiveSpaceObjects() cvjs_returnSpaceObjectClicked() cvjs_returnAllSpaceObjects() cvjs_returnSpaceObjectID()https://cadviewer.com/cadviewertechdocs/rest_api/template_endpoints/Wed, 07 Oct 2020 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/rest_api/template_endpoints/Below is three sample settings, user implementation of CADViewer NodeJS conversion server, user implementation of CADViewer PHP conversion server and a link to the Tailor Made Software PHP demo server End-point. // THIS IS THE URL TO THE ENDPOINT IMPLEMENTING CONVERTER AND DATA EXTRACTOR // cadviewer-conversion-server nodejs implementation var tms_rest_api_url_pw1 = "http://localhost:3000/callapiconversion"; // CADViewer php script implementation - local server var tms_rest_api_url_pw2 = "http://localhost/cadviewer/php/call-Api_Conversion.php"; // CADViewer php script implementation - CADViewer online demo var tms_rest_api_url_pw3 = "https://onlinedemo.https://cadviewer.com/cadviewertechdocs/callback/clickhandlers/Thu, 09 Apr 2020 15:26:15 +0000https://cadviewer.com/cadviewertechdocs/callback/clickhandlers/CADViewer provides the ability to add click-handlers to graphical objects in display CAD file. These objects are defined by the Entity Handle in the originating AutoCAD or MicroStation file being displayed by CADViewer. The Entity Handles are parsed by adding the following conversion control parameter -hlall , see more in the section Conversion Control Parameters and AutoXchange 2023 parameter interface. cadviewer.cvjs_conversion_addAXconversionParameter("HLALL", ""); In the general callback cvjs_OnLoadEnd() the API command cvjs_processHandleObjects will process handles on load.https://cadviewer.com/cadviewertechdocs/redlines/overlay/Thu, 09 Apr 2020 15:26:15 +0000https://cadviewer.com/cadviewertechdocs/redlines/overlay/Overlay Redlines at Load To allow Redlines to be overlaid at load, set the method cvjs_setLoadMultipleRedlinesStickyNotes(). Click on the method to open the API documentation. cvjs_setLoadMultipleRedlinesStickyNotes() - optional Samples Go to CADViewer Samples to see and download samples implementing Redlines Modals, Redlines Overlay and Redlines API controlled Redlines handling.https://cadviewer.com/cadviewertechdocs/spacemanagement/json_commands/Wed, 07 Oct 2020 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/spacemanagement/json_commands/Below are the API methods for operating on the Space Objects JSON Stucture. For manipulation of data fields inside Space Objects, see: Operations on Space Objects NOTE: When loading or saving multiple Space Objects, they will sequentially stored in a JSON element named ‘SpaceObjects’. The links below will open the command documentation in the CADViewer JavaScript API. cvjs_createNewJSonSpaceObject() - create a new JSON Space Object cvjs_loadSpaceObjectsDirect() - load up a JSON Space object array from a file-location into the drawing cvjs_setSpaceObjectDirect() - set a single JSON Space Object cvjs_setSpaceObjectsStructureDirect() - set an entire collection/array of JSON Space Objects into the drawing cvjs_addCustomSpaceObject() - add a custom structure as a JSON Space Object cvjs_returnSpaceObjectClicked() - return the Space Object clicked cvjs_returnAllSpaceObjects() - return the collection of all JSON Space Objects cvjs_returnSpaceObjectID() return a JSON Space Object based on ID The SpaceObject JSON structure The API method cvjs_createNewJSonSpaceObject() creates a default Space Object with the following structure.https://cadviewer.com/cadviewertechdocs/blocks/attribute-substitution/Mon, 08 Aug 2022 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/blocks/attribute-substitution/Substitution of a block image based on an attribute search, combines Search of Block Attributes and Block Substitution First ensure that the CAD drawing is converted with a single or multiple BLOCKS are converted to Space Objects. In this case below, we look at a single block: SIGA-PS and we insure all invisible attributes are converted using ia. Conversion parameters for Block parsing cadviewer.cvjs_conversion_clearAXconversionParameters(); // process blocks with a given name, in this case "audiovisual" cadviewer.https://cadviewer.com/cadviewertechdocs/handlers/vuejs/Wed, 31 Mar 2021 01:52:18 +0700https://cadviewer.com/cadviewertechdocs/handlers/vuejs/Install CADViewer Install CADViewer from: npm i cadviewer There are some general image and XML configuration files that CADViewer needs during execution, please download vue_react_public_folder_cadviewer_6_4.zip and place in your VueJS /public/ project folder. Install CAD Conversion Server Download the CADViewer Node JS CAD Conversion server (or alternatively the PHP, .NET or Servlet Server implementations). Use the NodeJS CADServer instructions. Install Converters Download the CAD Converter AutoXchange 2022. Go to: https://cadviewer.com/download/, register and receive email and then download from AutoXchange 2020 Downloads.https://cadviewer.com/cadviewertechdocs/handlers/reactjs/Sat, 10 Oct 2020 13:52:18 +0700https://cadviewer.com/cadviewertechdocs/handlers/reactjs/Install CADViewer 1A: Install CADViewer from: npm i cadviewer , see the CADViewer package on npm for more information. 1B: In your /public folder create the assets/cadviewer/ folder, then unzip and add the content from the CADViewer assets file: assets_cadviewer.zip (the folder structure will be /assets/cadviewer/app/…). The assets can also be found in the /node_modules/cadviewer/dist/assets/ folder after installation. As an alternative: 2: Install our sample implementation of a React App implementing CADViewer by cloning from Github: cadviewer-testapp-react-01 (class components, live demo) or cadviewer-testapp-react-02 (hooks / functional components, live demo)https://cadviewer.com/cadviewertechdocs/rest_api/template_restcalls/Wed, 07 Oct 2020 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/rest_api/template_restcalls/Pulling it all together Below are three different sets of calling a conversion and data extraction from a CADViewer REST API Server, based on the code snippets above, embedded in sample HTML Code: NodeJS REST Server DWG conversion and JSON data extraction samples, NodeJS REST Server under localhost. <button class="w3-button demo" onClick="call_server_post(conv_extr_request1, tms_rest_api_url_pw1);">NodeJS: Test POST Conversion Server - JSON Data Extraction</button> <br> <button class="w3-button demo" onClick="call_server_post(conv_extr_request2, tms_rest_api_url_pw1);">NodeJS: Test POST Conversion Server - DWG to SVG Conversion</button> <br> <button class="w3-button demo" onClick="call_server_post(conv_extr_request3, tms_rest_api_url_pw1);">NodeJS: CADViewer Display of DWG</button> PHP REST Server DWG conversion and JSON data extraction samples, PHP REST Server under localhost.https://cadviewer.com/cadviewertechdocs/spacemanagement/modify_content/Wed, 07 Oct 2020 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/spacemanagement/modify_content/The CADViewer API supports a number of methods to perform operations on Space Objects change internal values in respect to attributes, location and transformation matrix, etc. The links below will open the command documentation in the CADViewer JavaScript API. cvjs_setCurrentSpaceObjectNodeValues() cvjs_setAttributeStatus() cvjs_setAttributeInSpaceObjectNode() cvjs_modifySpaceObjectDirect() cvjs_moveSpaceObjectDirect() cvjs_deleteSpaceObjectDirect() cvjs_setSpaceObjectDirect() cvjs_changeSpaceObjectLayer() cvjs_changeSpaceObjectLinkStatus() cvjs_changeSpaceObjectName() cvjs_changeSpaceObjectType() cvjs_changeSpaceObjectID() cvjs_spaceObjectClickHandlerControlID() cvjs_spaceObjectClickHandlerControlAll()https://cadviewer.com/cadviewertechdocs/samples/space_objects_layers/Tue, 08 Sep 2020 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/samples/space_objects_layers/Online Demo Link This CADViewer Online Sample illustrates Layer Management and Highlights of CADViewer Space Objects. Setup of Interactive Content In Drawing To make space objects “come alive”, we will use the Automated Area Linkage capabilities of our back-end CAD Converter AutoXchange 2020. Automated Area Linkage will automatically match the identifier (henceforth called “Room Name”) with the corresponding area outline (henceforth called “Room Polygon”) and create a hyperlink that typically passes the Room Name to a JavaScript function whenever the Room Polygon is clicked or hovered over.https://cadviewer.com/cadviewertechdocs/callback/graphicalobjectonchange/Thu, 09 Apr 2020 15:26:15 +0000https://cadviewer.com/cadviewertechdocs/callback/graphicalobjectonchange/cvjs_graphicalObjectOnChange() is a callback Method on Creation, Delete and Change. It captures any action on graphical objects. It is used for CAFM Space Management and IWMS (Integrated Workplace Management Systems) Space Objects, as well as for Redlines handling and StickyNote handling: For Space Objects see: Space Objects using cvjs_graphicalObjectOnChange() For Redlines and StickyNotes see: Redline and StickyNote Objects using cvjs_graphicalObjectOnChange()https://cadviewer.com/cadviewertechdocs/redlines/redlineformats/Thu, 09 Apr 2020 15:26:15 +0000https://cadviewer.com/cadviewertechdocs/redlines/redlineformats/Redlines and SticyNote shares a common javascript structure in CADViewer v6. For CADViewer v7 and CADViewer v8, the data-structure of Redlines and StickyNotes have been updated to a JSON based structure similar to Space Objects. CADViewer 7/CADViewer 8 Redline Format The base JSON structure for a CADViewer 7/CADViewer 8 Redline Object is: When using the general JSON extration method, see Functional implementation for Redline/StickyNotes , all redlines are consolidated into a {‘RedlineObjects’:[]} structure.https://cadviewer.com/cadviewertechdocs/rest_api/cadviewer_url_endpoints/Wed, 07 Oct 2020 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/rest_api/cadviewer_url_endpoints/URL End-point to REST API The actual request-response call will need a URL end-point to connect to the REST API server. The REST API End-points supported by CADViewer server scripts on the various platforms are: Platform End-Point NodeJS /callapiconversion PHP /call-Api_Conversion.php Tomcat Servlets /callApiConversionServlet dotNet /callApiConversionHandler.ashx dotNetCore /callApiConversionhttps://cadviewer.com/cadviewertechdocs/spacemanagement/interface_commands/Wed, 07 Oct 2020 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/spacemanagement/interface_commands/The following commands will activate Icon Interface commands related to Space Objects. The links below will open the command documentation in the CADViewer JavaScript API. cvjs_changeSpaceObjectDisplayMode() - Interface command cvjs_addHandleFunc_ResizeDragSpace() - Interface command cvjs_resizeSpaceObject() - Interface command cvjs_moveSpaceObject() - Interface command cvjs_rotateSpaceObject() - Interface command cvjs_displaySpaceObjectsStructure() - Interface command cvjs_deleteSpaceObject() - Interface command cvjs_clearSpaceObjects() - Interface command cvjs_addPolygonSpaceObject() - Interface command cvjs_addRectangleSpaceObject() - Interface command cvjs_addCircleSpaceObject() - Interface command cvjs_copyCircleSpaceObject() - Interface commandhttps://cadviewer.com/cadviewertechdocs/handlers/angular/Mon, 10 Aug 2020 13:52:18 +0700https://cadviewer.com/cadviewertechdocs/handlers/angular/Install CADViewer 1A: Install CADViewer: npm i cadviewer 1B: There are some general image, style and XML configuration files that CADViewer needs during execution, please download angular_src_asset_folder_cadviewer_6_4.zip and place in your Angular /src/assets/ project folder. 1C: In angular.json , reference the cadviewer related stylesheets from /src/assets/: "styles": [ "src/styles.css", "src/assets/cadviewer/app/css/bootstrap.min.css", "src/assets/cadviewer/app/css/jquery.qtip.min.css", "src/assets/cadviewer/app/css/jquery-ui-1.11.4.min.css", "src/assets/cadviewer/app/css/bootstrap-multiselect.css", "src/assets/cadviewer/app/css/cvjs_6.4.css" ], As an alternative: 2: Install Angular App testing CADViewer API canvas sample by cloning from Github: cadviewer-testapp-angular-v01https://cadviewer.com/cadviewertechdocs/callback/spaceobjectsonchange/Thu, 09 Apr 2020 15:26:15 +0000https://cadviewer.com/cadviewertechdocs/callback/spaceobjectsonchange/cvjs_graphicalObjectOnChange() is a callback Method on Creation, Delete and Change. For more details on Space Management see: Space Objects - API Inteface & Guides The cvjs_graphicalObjectOnChange(type, graphicalObject, id, evt) callback contains the parameters: type: The types of interaction are: Create, Delete, Click, Move, Resize, Scale, Edit … graphicalObject: The grapical object itself, there are different types of redlines and space objects id: The ID of the object. Note that the corresponding node of the object will typically be RED_xxx for Redlines , SNOTE_xxx for StickyNotes and NODE_xxx for Space Objectshttps://cadviewer.com/cadviewertechdocs/frontend/insertimage/Thu, 09 Apr 2020 15:26:15 +0000https://cadviewer.com/cadviewertechdocs/frontend/insertimage/The image notes are loaded and saved from a designated folder, where the path is controlled by the two methods cvjs_setInsertImageObjectsRelativePath() and cvjs_setInsertImageObjectsAbsolutePath(). Click on the method to open the API documentation. cvjs_setInsertImageObjectsRelativePath() - optional cvjs_setInsertImageObjectsAbsolutePath() - optional NOTE: If ServerLocation is set to “”, the back-end converter will concatenate to the back-end installation path.https://cadviewer.com/cadviewertechdocs/frontend/parameters/Thu, 09 Apr 2020 09:16:15 +0000https://cadviewer.com/cadviewertechdocs/frontend/parameters/Application programmers can pass over parameters to the document implementing CADViewer. To ease picking up these user parameters, the CADViewer API has implemented the method cvjs_GetURLParameter(). The method is used to read and pass over control parameter, such as the drawing file to CADViewer. Click on the method to open the API documentation. cvjs_GetURLParameter() - optionalhttps://cadviewer.com/cadviewertechdocs/handlers/laravel/Sat, 10 Oct 2020 13:52:18 +0700https://cadviewer.com/cadviewertechdocs/handlers/laravel/Install CADViewer Install CADViewer under your Laravel project folder: /public/app/. Go to:https://cadviewer.com/download/, register and receive email and then download from CADViewer. Simply copy the CADViewer folder tree /cadviewer/app/ so it becomes /public/app/ under the Laravel folder strucure. Install CAD Conversion Server Download the CADViewer Node JS CAD Conversion server (or alternatively the PHP, .NET or Servlet Server implementations). Go to: https://cadviewer.com/download/, register and receive email and then download from CADViewer Handler/Connector Scripts.https://cadviewer.com/cadviewertechdocs/rest_api/cadviewer_sample_rest_calls/Wed, 07 Oct 2020 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/rest_api/cadviewer_sample_rest_calls/Sample Call Method to the REST API Depending on Server implementation the Ajax call (or whatever technology preferred) can be either: Post call call to the End-Point Url. Jsonp Post call to the End-Point Url. A: Sample Post call to NodeJS server: function call_server_post(data_object, tms_rest_api_url_pw){ var api_data = JSON.stringify(data_object); console.log(api_data); var filelist_data = {}; filelist_data['request'] = api_data; jQuery.ajax({ url : tms_rest_api_url_pw, type: 'post', data: filelist_data, success:function(Api_response){ console.log("SERVER RESPONSE POST: "+Api_response); var conversion_result = JSON.https://cadviewer.com/cadviewertechdocs/callback/redlineandstickynotesonchange/Thu, 09 Apr 2020 15:26:15 +0000https://cadviewer.com/cadviewertechdocs/callback/redlineandstickynotesonchange/cvjs_graphicalObjectOnChange() is a callback Method on Creation, Delete and Change. It captures any action on Redline and StickyNote objects: The cvjs_graphicalObjectOnChange(type, graphicalObject, id, evt) callback contains the parameters: type: The types of interaction are: Create, Delete, Click, Move, Resize, Scale, Edit … graphicalObject: The grapical object itself, there are different types of redlines and space objects id: The ID of the object. Note that the corresponding node of the object will typically be RED_xxx for Redlines , SNOTE_xxx for StickyNotes and NODE_xxx for Space Objectshttps://cadviewer.com/cadviewertechdocs/callback/theothers/Thu, 09 Apr 2020 15:26:15 +0000https://cadviewer.com/cadviewertechdocs/callback/theothers/Methods cvjs_change_space(), cvjs_graphicalObjectCreated() and cvjs_ObjectSelected() are used for Space Management Interface creation and call-back when an object has been clicked for interation. Mostly cvjs_change_space(), cvjs_graphicalObjectCreated() can be left empty, as all interaction can be tracked through cvjs_graphicalObjectOnChange(): The call-back cvjs_ObjectSelected() is always called when a Space Object has been clicked. // generic callback method, tells which FM object has been clicked function cvjs_change_space(){ } function cvjs_graphicalObjectCreated(graphicalObject){ // do something with the graphics object created!https://cadviewer.com/cadviewertechdocs/frontend/compare/Sun, 29 Jan 2023 15:26:15 +0000https://cadviewer.com/cadviewertechdocs/frontend/compare/CADViewer provides the ability to API control the colors of the drawing. To utilize this API the conversion parameter colorasc needs to be called, to process all internal colors in the drawing according to the AutoCAD palette. The compare drawings methods loads drawings from the paths defined by the general file modal initialization methods cvjs_setServerFileLocation() and cvjs_setServerFileLocation_AbsolutePaths(). These controls the path to the file location, that links with the File Loader Modal.https://cadviewer.com/cadviewertechdocs/frontend/colorcontrols/Sun, 29 Jan 2023 08:16:15 +0000https://cadviewer.com/cadviewertechdocs/frontend/colorcontrols/Application programmers can control the line colors in the drawings by using the CADViewer API. For this purpose the drawing needs to be converted with the conversion parameter colorasc activated. This parameter will allow application programmers to control the AutoCAD Palettes. See the two default AutoCAD palettes: AutoCAD Light Palette and AutoCAD Dark Pallette. NOTE: The index in the Palette will start from 0 when using the CADViewer API! For CAD converter AutoXchange AX2023 from version v23.https://cadviewer.com/cadviewertechdocs/handlers/php_sharepoint/Sat, 10 Oct 2020 13:52:18 +0700https://cadviewer.com/cadviewertechdocs/handlers/php_sharepoint/CADViewer can be integrated into SharePoint through the PageViewer interface, so that CADViewer resides on an external https server, displays drawings inside MicroSoft 365 / SharePoint, and communicates with SharePoint through the REST API to generate file-list and process drawings for display. The CADViewer installation acts as a seamless CAD access point to a Sharepoint server. The samples in this section allows implementors to builds navigational file tree structures over Sharepoint server folder content.https://cadviewer.com/cadviewertechdocs/frontend/axparameters/Sun, 12 Apr 2020 08:16:15 +0000https://cadviewer.com/cadviewertechdocs/frontend/axparameters/The Back-End converter AutoXchange 2022 has a comprehensive Parameter Interface API to specifically control the conversions of drawings in respect to view and higher level content. In CADViewer, a standard set of conversion control parameters are set up in the back-end Handlers installation, to control the location of the license key, font path and initial external reference file paths. Application programmers can add their own settings of conversion parameters in CADViewer prior to loading a drawings.https://cadviewer.com/cadviewertechdocs/frontend/custommodals/Sun, 12 Apr 2020 08:16:15 +0000https://cadviewer.com/cadviewertechdocs/frontend/custommodals/Standard Modal Controls When setting up the Custom Modal for Space Objects Highlight and call-back methods, application programmers define a cvjsPopUpBody that contains the HTML content the modal displays. The Highlight on objects can be controlled setting a style object for three modes: base, highlight and select. The variables are: cvjsRoomPolygonBaseAttributes, cvjsRoomPolygonHighlightAttributes and cvjsRoomPolygonSelectAttributes. The initialization of CADViewer is called with the method cvjs_InitCADViewer_highLight_popUp_app using the highlight styles and pop-up body as arguments.https://cadviewer.com/cadviewertechdocs/modals/custommodals/Sun, 12 Apr 2020 08:16:15 +0000https://cadviewer.com/cadviewertechdocs/modals/custommodals/Standard Modal Controls When setting up the Custom Modal for Space Objects Highlight and call-back methods, application programmers define a cvjsPopUpBody that contains the HTML content the modal displays. The Highlight on objects can be controlled setting a style object for three modes: base, highlight and select. The variables are: cvjsRoomPolygonBaseAttributes, cvjsRoomPolygonHighlightAttributes and cvjsRoomPolygonSelectAttributes. The initialization of CADViewer is called with the method cvjs_InitCADViewer_highLight_popUp_app using the highlight styles and pop-up body as arguments.https://cadviewer.com/cadviewertechdocs/frontend/callbackdynamicmodals/Sun, 12 Apr 2020 08:16:15 +0000https://cadviewer.com/cadviewertechdocs/frontend/callbackdynamicmodals/The section Custom Modals for Highlight describes in detail on how to set up user defined pop-up modals when interacting with an object space in the floor-plan for intelligent highlight. However, these modals are static in nature, they contains header information on the object clicked and the type of object, but the content of the modal itself keeps the original configuration. CADViewer, also allows application programmers the ability to catch a call-back when an object is clicked, and dynamically set the content of the popup modal.https://cadviewer.com/cadviewertechdocs/modals/callbackdynamicmodals/Sun, 12 Apr 2020 08:16:15 +0000https://cadviewer.com/cadviewertechdocs/modals/callbackdynamicmodals/The section Custom Modals for Highlight describes in detail on how to set up user defined pop-up modals when interacting with an object space in the floor-plan for intelligent highlight. However, these modals are static in nature, they contains header information on the object clicked and the type of object, but the content of the modal itself keeps the original configuration. CADViewer, also allows application programmers the ability to catch a call-back when an object is clicked, and dynamically set the content of the popup modal.https://cadviewer.com/cadviewertechdocs/spacemanagement/zvalue/Sat, 02 Jul 2022 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/spacemanagement/zvalue/The display order of the Space Objects can be changed dynamically. There are 4 commands implemented for this purpose: Bring to Front Send to Back Bring Forward Send Backward Selection of objects are done with Shift+Click. Deselection of single object or entire sets of objects is done with Click on canvas. Shift+Click on an already selected object will deselect that object. Selection of object Send object to back Move object to front Deselect objecthttps://cadviewer.com/cadviewertechdocs/frontend/suppressdynamicmodals/Sun, 12 Apr 2020 08:16:15 +0000https://cadviewer.com/cadviewertechdocs/frontend/suppressdynamicmodals/For an application programmer to take control of the Pop-Up modals and replace with their own interface, do follow the instructions below. If wanting to work with the CADViewer Pop-Up Modal interface, please instead go to the resources - Custom Modals for Highlight and Dynamic Modals for Highlight. Do the following: In the declaration part of CADViewer turn off the Pop-Up Modal interface: cvjs_setNoModalMode(true); When a Space or (Block) is clicked, capture the interaction from the callback method:https://cadviewer.com/cadviewertechdocs/modals/suppressdynamicmodals/Sun, 12 Apr 2020 08:16:15 +0000https://cadviewer.com/cadviewertechdocs/modals/suppressdynamicmodals/For an application programmer to take control of the Pop-Up modals and replace with their own interface, do follow the instructions below. If wanting to work with the CADViewer Pop-Up Modal interface, please instead go to the resources - Custom Modals for Highlight and Dynamic Modals for Highlight. Do the following: In the declaration part of CADViewer turn off the Pop-Up Modal interface: cvjs_setNoModalMode(true); When a Space or (Block) is clicked, capture the interaction from the callback method:https://cadviewer.com/cadviewertechdocs/modals/stylemodals/Sun, 12 Apr 2020 08:16:15 +0000https://cadviewer.com/cadviewertechdocs/modals/stylemodals/There is an API control cvjs_styleQTip_color to style the background colors and titlebar text colors of the space object pop-up modal: /** * Style the background and text colors of qTip popup modal * @param {boolean} state - true are new colors, false sets back to default, remaining fields are not used * @param {string} titlebar - background color of titlebar * @param {string} content - background color of content * @param {string} header_1 - text color of header 1 item * @param {string} header_info_1 - text color of header info 1 item * @param {string} header_info_2 - text color of header info 2 item */ function cvjs_styleQTip_color(state, titlebar, content, header_1, header_info_1, header_info_2 ){ This method can preferable be applied prior to creating the dynamic pop-up in the myCustomPopUpBody() method:https://cadviewer.com/cadviewertechdocs/faq/libfontconfig/Sun, 12 Apr 2020 08:16:15 +0000https://cadviewer.com/cadviewertechdocs/faq/libfontconfig/If executing Linux the version of AutoXchange and getting the following error: libfontconfig.so.1: cannot open shared object file then install fontconfig: sudo apt-get install fontconfighttps://cadviewer.com/cadviewertechdocs/faq/ax_chmod/Sun, 12 Apr 2020 08:16:15 +0000https://cadviewer.com/cadviewertechdocs/faq/ax_chmod/If AutoXchange is not running when executing on Linux, the most common issue is that AutoXchange does not have permissions to execute from the install folder: sudo chmod 777 /cadviewer-conversion-server/converters/ax2022/linux/ax2022_L64_22_12_70 and the output folder used for file-conversions needs to have write permission set for all users: sudo chmod 777 /cadviewer-conversion-server/converters/files Verify AX2022 is running by running the command to echo the parameter interface. It will either any missing libraries or display all parameter commands:https://cadviewer.com/cadviewertechdocs/faq/chmodax/Sun, 12 Apr 2020 08:16:15 +0000https://cadviewer.com/cadviewertechdocs/faq/chmodax/If AutoXchange is not running when executing on Linux, the most common issue is that AutoXchange does not have permissions to execute from the install folder: sudo chmod 777 /cadviewer-conversion-server/converters/ax2022/linux/ax2022_L64_22_12_70 and to write into temporary file folder: sudo chmod 777 /cadviewer-conversion-server/converters/files Verify AX2022 is running by running the command to echo the parameter interface: /cadviewer-conversion-server/converters/ax2022/linux/ax2022_L64_22_12_70 -?https://cadviewer.com/cadviewertechdocs/faq/ax_modelspace/Thu, 17 Mar 2022 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/faq/ax_modelspace/Q: We always get ModelSpace view, but that can have a lot of extra stuff in it. How do we make sure we get Layout1? A: If you don’t list a view it will open in the Last Saved View, whatever was being looked at when the drawing was saved. You can also specify this using -last If you want ModelSpace, use -model If you want PaperSpace, use -paper If you want a particular layout, use -layout=namehttps://cadviewer.com/cadviewertechdocs/faq/ax_licensekey/Thu, 17 Mar 2022 01:26:15 +0000https://cadviewer.com/cadviewertechdocs/faq/ax_licensekey/If a rotated “trial” watermark appears on the output, the AutoXchange axlic.key is either coded incorrectly or has timed out. Running a test conversion (myfile.dwg) from the command line/terminal will list both the expiration date as well as any MAC/IP addresses read into AutoXchange. Use the command -trace for debug output and redirect the output to a text file: >mytrace.txt >ax2023_xx_yy_nn -i=myfile.dwg -o=myfile.svg -f=svg -model -trace >mytrace.txt The mytrace.txt file will contain a full trace on the MAC/IP addresses read in as well as any other license key diagnostics.https://cadviewer.com/cadviewertechdocs/faq/ax_pdftodwg/Sun, 12 Apr 2020 08:16:15 +0000https://cadviewer.com/cadviewertechdocs/faq/ax_pdftodwg/AutoXChange does not currently support AutoCAD DWG or DXF as a normal output format. However, when AutoXChange converts from PDF to another format it creates an internal AutoCAD DWG from the PDF. It then processes that DWG just as it would any other DWG and produces the output format. Use the -savedwg parameter to save the intermediate DWG file. ax2022 <inputfile> -svg -savedwg Until such time as we add -dwg and -dxf as output formats, you have to list another format, usually -svg, when you do a conversion.https://cadviewer.com/cadviewertechdocs/faq/ax_changecolor/Sun, 12 Apr 2020 08:16:15 +0000https://cadviewer.com/cadviewertechdocs/faq/ax_changecolor/AutoXChange Use the -b or -background parameter. The value is an integer (0 to 255) that defines the AutoCAD Light Palette Color Index, so 0 is black, 1 is red, 7 is white, etc. For the simple colors (0 to 7) and some of the others, you can also names, blank, red, white, lightgrey, etc. For SVG this will set the CSS background-color value. For PDF it will create a rectangle filling the full page with that color.