cadviewer 7.1.9 → 7.1.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -2,107 +2,79 @@
|
|
|
2
2
|
|
|
3
3
|
## CADViewer for frameworks (ReactJS, VueJS, Angular etc.)
|
|
4
4
|
|
|
5
|
-
**1)** Install CADViewer with ***npm i cadviewer*** on all framework platforms. See specifics below for each platform on how to add auxillary files and connect with the back-end CAD conversion server.
|
|
6
5
|
|
|
7
|
-
|
|
6
|
+
#### Install CADViewer
|
|
8
7
|
|
|
9
|
-
**
|
|
8
|
+
**1:** Install CADViewer with ***npm i cadviewer*** on all framework platforms. See specifics below for each platform on how to add auxillary files and connect with the back-end CAD conversion server.
|
|
10
9
|
|
|
10
|
+
#### Add Assets
|
|
11
11
|
|
|
12
|
-
***
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
***Note 2:*** For plain-vanilla JavaScript top-level library, please use our [GitHub](https://github.com/CADViewer/cadviewer-script-library) repository [cadviewer-script-library](https://github.com/CADViewer/cadviewer-script-library).
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
***Note 3:*** Always install the back-end [cadviewer-conversion-server](https://github.com/CADViewer/cadviewer-conversion-server) for CAD conversion, Redlines and Space Object management.
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
## Install Instructions for ReactJS and VueJS
|
|
22
|
-
|
|
23
|
-
1: Install CADViewer as above.
|
|
24
|
-
|
|
25
|
-
To see how a CAD Canvas is set up with callback methods and initialization of CADViewer use the following samples as a template:
|
|
12
|
+
**2:** In your ***/src*** (Angular) or ***/public*** (NodeJS/VueJS) folder create the ***[assets/cadviewer/](https://cadviewer.com/downloads/cadviewer/assets/assets_cadviewer.zip)*** folder, then unzip and add the content from the CADViewer assets file: ***[assets_cadviewer.zip](https://cadviewer.com/downloads/cadviewer/assets/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.
|
|
26
13
|
|
|
27
|
-
|
|
14
|
+
#### If using TypeScript
|
|
28
15
|
|
|
29
|
-
|
|
16
|
+
**3:** If you are using typescript, then ***cadviewer.d.ts*** is in the **/node_modules/cadviewer/dist/** */ folder after installation and is referenced through package.json. The types definitions can also be pulled from [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped), with **npm i @types/cadviewer**.
|
|
30
17
|
|
|
31
|
-
|
|
18
|
+
#### Notes:
|
|
32
19
|
|
|
20
|
+
***Note 1:*** For any installation issues, please refer to CADViewer [FAQ](https://cadviewer.com/cadviewertechdocs/faq)
|
|
33
21
|
|
|
34
|
-
3: Install a back-end CAD Conversion server to process CAD files and communicate with CADViewer.
|
|
35
|
-
|
|
36
|
-
Download the 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**.
|
|
37
|
-
|
|
38
|
-
The [CADViewer](https://github.com/CADViewer/cadviewer-conversion-server) NodeJS CAD Conversion Server can be downloaded from [Github](https://github.com/CADViewer/cadviewer-conversion-server) from the repository [cadviewer-conversion-server](https://github.com/CADViewer/cadviewer-conversion-server).
|
|
39
|
-
|
|
40
|
-
You can always update the CAD Converter AutoXchange 2023 in the server structure: Go to: https://cadviewer.com/download/, register and receive email and then download from **AutoXchange 2023 Downloads**.
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
Note that the path book-keeping is important for proper initialization, where the ServerBackEndUrl and ServerLocation is the location and Url of the CAD Server and ServerUrl is the Url of the React/VueJS application encapulating CADViewer.
|
|
44
|
-
|
|
45
|
-
var ServerBackEndUrl = "http://localhost:3000/";
|
|
46
|
-
var ServerUrl = "http://localhost:8000/";
|
|
47
|
-
var ServerLocation = ""; // leave blank, for devopment purposes can be set: c:/nodejs/cadviewer-conversion-server/
|
|
48
|
-
|
|
49
|
-
The CADViewer React JS general install instructions are at: https://cadviewer.com/cadviewertechdocs/handlers/reactjs/
|
|
50
22
|
|
|
51
|
-
|
|
23
|
+
***Note 2:*** For plain-vanilla JavaScript top-level library, please use our [GitHub](https://github.com/CADViewer/cadviewer-script-library) repository [cadviewer-script-library](https://github.com/CADViewer/cadviewer-script-library).
|
|
52
24
|
|
|
53
|
-
Use the [CADViewer API](https://cadviewer.com/cadviewerproapi/global.html) to open and manipulate drawings in your application.
|
|
54
25
|
|
|
55
|
-
|
|
26
|
+
***Note 3:*** Always install the back-end ***[cadviewer-conversion-server](https://github.com/CADViewer/cadviewer-conversion-server)*** (windows) or ***[cadviewer-conversion-server-linux](https://github.com/CADViewer/cadviewer-conversion-server-linux)*** (linux) for CAD conversion, Redlines and Space Object management. (see **5:** below)
|
|
56
27
|
|
|
57
|
-
Read the Guide on how to **[modify hotspots](https://cadviewer.com/highlight2/main/)** (Space Objects), this will help you work with the code in this sample.
|
|
58
28
|
|
|
59
|
-
|
|
29
|
+
#### Use Integrated Samples
|
|
60
30
|
|
|
61
|
-
|
|
31
|
+
To see how a CAD Canvas is set up with callback methods and initialization of CADViewer, as an alternative to **1: - 3:** above, use the following samples as a template:
|
|
62
32
|
|
|
63
|
-
|
|
33
|
+
**4A:** ***ReactJS*** - download the CADViewer [React](https://github.com/CADViewer/cadviewer-testapp-react-01) implementation sample from the [Github](https://github.com/CADViewer/cadviewer-testapp-react-01) repository ***[cadviewer-testapp-react-01](https://github.com/CADViewer/cadviewer-testapp-react-01)***.
|
|
64
34
|
|
|
35
|
+
**4B:** ***VueJS*** - download the CADViewer [VueJS](https://github.com/CADViewer/cadviewer-testapp-vue-01) implementation sample from [Github](https://github.com/CADViewer/cadviewer-testapp-vue-v01) repository ***[cadviewer-testapp-vue-01](https://github.com/CADViewer/cadviewer-testapp-vue-01)***.
|
|
65
36
|
|
|
66
37
|
|
|
67
|
-
|
|
38
|
+
**4C:** ***Angular*** - download a CADViewer [Angular](https://github.com/CADViewer/cadviewer-testapp-angular-v02) implementation sample from the repositories either [Github](https://github.com/CADViewer/cadviewer-testapp-angular-v01) - Angular 11 (***[cadviewer-testapp-angular-v01](https://github.com/CADViewer/cadviewer-testapp-angular-v01)***) or [Github](https://github.com/CADViewer/cadviewer-testapp-angular-v02) - Angular 13 with TypeScript (***[cadviewer-testapp-angular-v02](https://github.com/CADViewer/cadviewer-testapp-angular-v02)***).
|
|
68
39
|
|
|
69
|
-
1: Install CADViewer as above.
|
|
70
40
|
|
|
71
|
-
|
|
41
|
+
These samples illustrates initialization and loading of CADViewer as well as illustrates the functional interface for [highlight](https://cadviewer.com/cadviewertechdocs/spacemanagement/) and adding [interactive](https://cadviewer.com/cadviewertechdocs/spacemanagement/) image content to the CAD canvas.
|
|
72
42
|
|
|
73
|
-
|
|
43
|
+
#### Install Back-End Converter
|
|
74
44
|
|
|
45
|
+
**5:** Install a back-end CAD Conversion server to process CAD files and communicate with CADViewer.
|
|
75
46
|
|
|
76
|
-
|
|
47
|
+
Download the 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**.
|
|
77
48
|
|
|
78
|
-
|
|
49
|
+
***Note:*** that the preferred CAD Server with React/Vue/Angular, is the **CADViewer NodeJS CAD Conversion Server** which can be downloaded directly from the [Github](https://github.com/CADViewer/cadviewer-conversion-server) repositories ***[cadviewer-conversion-server](https://github.com/CADViewer/cadviewer-conversion-server)*** (windows) or ***[cadviewer-conversion-server-linux](https://github.com/CADViewer/cadviewer-conversion-server-linux)*** (linux).
|
|
79
50
|
|
|
80
|
-
|
|
51
|
+
You can always update the back-end CAD Converter [AutoXchange 2023](https://www.tailormade.com/ax2020techdocs/) in the server structure: Go to: https://cadviewer.com/download/, register, receive email and then download from **AutoXchange 2023 Downloads**.
|
|
81
52
|
|
|
82
|
-
Download the CAD Converter AutoXchange 2023: Go to: https://cadviewer.com/download/, register and receive email and then download from **AutoXchange 2023 Downloads**.
|
|
83
53
|
|
|
84
|
-
|
|
54
|
+
Note that the path book-keeping is important for proper initialization, where the ***ServerBackEndUrl*** and ***ServerLocation*** is the location and Url of the CAD Server and ServerUrl is the Url of the React/VueJS/Angular application encapulating CADViewer.
|
|
85
55
|
|
|
86
|
-
|
|
56
|
+
var ServerBackEndUrl = "http://localhost:3000/";
|
|
57
|
+
var ServerUrl = "http://localhost:8000/"; // react
|
|
58
|
+
// var ServerUrl = "http://localhost:8080/"; // vue
|
|
59
|
+
// var ServerUrl = "http://localhost:4200/"; // angular
|
|
60
|
+
var ServerLocation = ""; // leave blank (only use for dev purposes)
|
|
61
|
+
|
|
62
|
+
The [CADViewer Back-End](https://cadviewer.com/cadviewertechdocs/handlers/) install instructions are at: https://cadviewer.com/cadviewertechdocs/handlers/.
|
|
87
63
|
|
|
64
|
+
The [CADViewer Front-End](https://cadviewer.com/cadviewertechdocs/frontend/) install instructions are at: https://cadviewer.com/cadviewertechdocs/frontend/.
|
|
88
65
|
|
|
89
|
-
var ServerBackEndUrl = "http://localhost:3000/";
|
|
90
|
-
var ServerUrl = "http://localhost:4200/";
|
|
91
|
-
var ServerLocation = ""; // leave blank, for devopment purposes can be set: c:/nodejs/cadviewer-conversion-server/
|
|
92
66
|
|
|
93
|
-
|
|
67
|
+
### General Information
|
|
94
68
|
|
|
95
|
-
**LICENSE: TMS 1.0:** Use freely on localhost. Commercial use requires licensing, both using entirely or in parts. Forbidden to remove license key check. Contact Tailor Made Software, https://cadviewer.com/contact, for more information.
|
|
96
69
|
|
|
97
|
-
Use
|
|
70
|
+
**LICENSE: TMS 1.0:** Use freely on localhost. Commercial use requires licensing, both using entirely or in parts. Contact Tailor Made Software, https://cadviewer.com/contact, for more information.
|
|
98
71
|
|
|
99
|
-
Read the Guide on how to **[create hotspots](https://cadviewer.com/highlight/main/)** (Space Objects), it outlines how spaces can be processed on a drawing to create interactive objects.
|
|
100
72
|
|
|
101
|
-
|
|
73
|
+
The general documentation on **[CADViewer](https://cadviewer.com/cadviewertechdocs/)** is found at: https://cadviewer.com/cadviewertechdocs/.
|
|
102
74
|
|
|
103
|
-
|
|
75
|
+
The general documentation on **[AutoXchange 2023](https://tailormade.com/ax2020techdocs/)** is found at: https://tailormade.com/ax2020techdocs/.
|
|
104
76
|
|
|
105
|
-
The
|
|
77
|
+
The ***[CADViewer API](https://cadviewer.com/cadviewerproapi/global.html)*** is found at: https://cadviewer.com/cadviewerproapi/global.html.
|
|
106
78
|
|
|
107
|
-
The CADViewer API is found at: https://cadviewer.com/cadviewerproapi/global.html.
|
|
108
79
|
|
|
80
|
+
Read the Guide on how to **[create hotspots](https://cadviewer.com/highlight/main/)** and **[modify hotspots](https://cadviewer.com/highlight2/main/)**, this will help you work with the code in the integrated samples. Also please reference the general documentation on **[Space Management](https://cadviewer.com/cadviewertechdocs/spacemanagement/)**.
|