@inovitas/infra3dapi 1.2.0-beta.1 → 1.2.0
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 +170 -165
- package/infra3dapi.d.ts +203 -202
- package/infra3dapi.js +1 -1
- package/licenses.txt +95 -95
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,168 +1,173 @@
|
|
|
1
|
-
# Installation
|
|
2
|
-
|
|
3
|
-
### NPM Package
|
|
4
|
-
|
|
5
|
-
The API can be installed as a package using npm. To install it from the npm package repository, simply type:
|
|
6
|
-
|
|
7
|
-
```bash
|
|
8
|
-
npm install @inovitas/infra3dapi
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
### CDN Download
|
|
12
|
-
|
|
13
|
-
Alternatively, you can obtain the API from a CDN. To get the latest version, add the following script to your HTML file:
|
|
14
|
-
|
|
15
|
-
```html
|
|
16
|
-
<script src="https://cdn.jsdelivr.net/npm/@inovitas/infra3dapi@latest/infra3dapi.js"></script>
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
We recommend using a specific version in your project. To get a specific version, use the following script and adjust the version accordingly:
|
|
20
|
-
|
|
21
|
-
```html
|
|
22
|
-
<script src="https://cdn.jsdelivr.net/npm/@inovitas/infra3dapi@1.0.1/infra3dapi.js"></script>
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
**Note**: Please do not name the `<div>` in which the viewer is initialized as "infra3d" as this may cause internal conflicts.
|
|
26
|
-
|
|
27
|
-
# Core Concept
|
|
28
|
-
|
|
29
|
-
To use the API, you can call the init functions in infra3dapi. After loggin in and initializing the view (with [`manager.initView()`](classes/_inovitas_infra3dapi.manager.Manager.html#initView)), you will get a viewer object. This viewer object can then be used to add event-listeners to different events emitted by the viewer (like [`viewer.geoframechanged`](classes/_inovitas_infra3dsdk.Viewer.html#geoframechanged)) or to call some functions (like [`viewer.getRoutes()`](classes/_inovitas_infra3dsdk.Viewer.html#getRoutes) or [`viewer.movePosition()`](classes/_inovitas_infra3dsdk.Viewer.html#movePosition)).
|
|
30
|
-
|
|
31
|
-
# Authentication
|
|
32
|
-
|
|
33
|
-
1. Register your OAuth 2.0 application with our sales team to obtain credentials (client_id and client_secret).
|
|
34
|
-
2. Develop a server-side component to securely use these credentials, obtaining an access token from infra3D.
|
|
35
|
-
3. Your server-side component fetches the access token using client credentials, which can then be shared with your client app.
|
|
36
|
-
4. Your client app uses this token to authenticate with infra3D for requested services, refreshing it via the server component when expired. Remember to treat the client_secret like a password, avoiding exposure in client-side environments for enhanced security.
|
|
37
|
-
|
|
1
|
+
# Installation
|
|
2
|
+
|
|
3
|
+
### NPM Package
|
|
4
|
+
|
|
5
|
+
The API can be installed as a package using npm. To install it from the npm package repository, simply type:
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @inovitas/infra3dapi
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
### CDN Download
|
|
12
|
+
|
|
13
|
+
Alternatively, you can obtain the API from a CDN. To get the latest version, add the following script to your HTML file:
|
|
14
|
+
|
|
15
|
+
```html
|
|
16
|
+
<script src="https://cdn.jsdelivr.net/npm/@inovitas/infra3dapi@latest/infra3dapi.js"></script>
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
We recommend using a specific version in your project. To get a specific version, use the following script and adjust the version accordingly:
|
|
20
|
+
|
|
21
|
+
```html
|
|
22
|
+
<script src="https://cdn.jsdelivr.net/npm/@inovitas/infra3dapi@1.0.1/infra3dapi.js"></script>
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
**Note**: Please do not name the `<div>` in which the viewer is initialized as "infra3d" as this may cause internal conflicts.
|
|
26
|
+
|
|
27
|
+
# Core Concept
|
|
28
|
+
|
|
29
|
+
To use the API, you can call the init functions in infra3dapi. After loggin in and initializing the view (with [`manager.initView()`](classes/_inovitas_infra3dapi.manager.Manager.html#initView)), you will get a viewer object. This viewer object can then be used to add event-listeners to different events emitted by the viewer (like [`viewer.geoframechanged`](classes/_inovitas_infra3dsdk.Viewer.html#geoframechanged)) or to call some functions (like [`viewer.getRoutes()`](classes/_inovitas_infra3dsdk.Viewer.html#getRoutes) or [`viewer.movePosition()`](classes/_inovitas_infra3dsdk.Viewer.html#movePosition)).
|
|
30
|
+
|
|
31
|
+
# Authentication
|
|
32
|
+
|
|
33
|
+
1. Register your OAuth 2.0 application with our sales team to obtain credentials (client_id and client_secret).
|
|
34
|
+
2. Develop a server-side component to securely use these credentials, obtaining an access token from infra3D.
|
|
35
|
+
3. Your server-side component fetches the access token using client credentials, which can then be shared with your client app.
|
|
36
|
+
4. Your client app uses this token to authenticate with infra3D for requested services, refreshing it via the server component when expired. Remember to treat the client_secret like a password, avoiding exposure in client-side environments for enhanced security.
|
|
37
|
+
|
|
38
38
|
# Changelog
|
|
39
39
|
|
|
40
|
-
## 1.2.0
|
|
41
|
-
|
|
42
|
-
###
|
|
43
|
-
|
|
44
|
-
-
|
|
45
|
-
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
-
|
|
52
|
-
|
|
53
|
-
## 1.1.
|
|
54
|
-
|
|
55
|
-
### Bugfixes
|
|
56
|
-
|
|
57
|
-
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
-
|
|
71
|
-
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
-
|
|
89
|
-
|
|
90
|
-
## 1.0.
|
|
91
|
-
|
|
92
|
-
### Bugfixes
|
|
93
|
-
|
|
94
|
-
- Fixed
|
|
95
|
-
|
|
96
|
-
## 1.0.
|
|
97
|
-
|
|
98
|
-
### Bugfixes
|
|
99
|
-
|
|
100
|
-
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
###
|
|
139
|
-
|
|
140
|
-
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
###
|
|
145
|
-
|
|
146
|
-
-
|
|
147
|
-
|
|
148
|
-
## 0.2.
|
|
149
|
-
|
|
150
|
-
###
|
|
151
|
-
|
|
152
|
-
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
###
|
|
166
|
-
|
|
167
|
-
-
|
|
40
|
+
## 1.2.0 - 16.12.2024
|
|
41
|
+
|
|
42
|
+
### Bugfixes
|
|
43
|
+
|
|
44
|
+
- Improve styling when using global box-sizing style
|
|
45
|
+
- Style of the scrollbar is no more globally overwritten by the API
|
|
46
|
+
|
|
47
|
+
### Added
|
|
48
|
+
|
|
49
|
+
- Added functions on viewer to draw and pick a geometry
|
|
50
|
+
- Added geometry overlays to display geometries in the viewer
|
|
51
|
+
- Function to destroy the API and remove it from the DOM
|
|
52
|
+
|
|
53
|
+
## 1.1.2 - 21.10.2024
|
|
54
|
+
|
|
55
|
+
### Bugfixes
|
|
56
|
+
|
|
57
|
+
- viewer.getRoutes() resulted in an error
|
|
58
|
+
|
|
59
|
+
## 1.1.1 - 14.10.2024
|
|
60
|
+
|
|
61
|
+
### Bugfixes
|
|
62
|
+
|
|
63
|
+
- Layer export not working for non-memory layers
|
|
64
|
+
- Duplicate layers when exporting directly after importing layers (without reloading)
|
|
65
|
+
|
|
66
|
+
## 1.1.0 - 09.10.2024
|
|
67
|
+
|
|
68
|
+
### Bugfixes
|
|
69
|
+
|
|
70
|
+
- Bug in viewer.getRoutesOutline() when using as migrated user.
|
|
71
|
+
- Same default EPSG-Code (4326) when using start-position for (un)-migrated users.
|
|
72
|
+
|
|
73
|
+
### Added
|
|
74
|
+
|
|
75
|
+
- ProjectScope is available to restrict the access inside a project accordingly.
|
|
76
|
+
- New concept for routes abstraction in the map, using hexagons
|
|
77
|
+
- viewer.getRouteLines() and viewer.getRouteHexes()
|
|
78
|
+
- PointCloudExport
|
|
79
|
+
- Support of EPSG-Code in start-position
|
|
80
|
+
|
|
81
|
+
## 1.0.3 - 17.09.2024
|
|
82
|
+
|
|
83
|
+
### Bugfixes
|
|
84
|
+
|
|
85
|
+
- Fixed pilegate URL for migrated users.
|
|
86
|
+
- Using the profiletool, added an information and reset the tool when changing the image while performing a measurement.
|
|
87
|
+
- Fix the bug when using jest for testing.
|
|
88
|
+
- Added missing bounding box parameter to viewer.getRoutes().
|
|
89
|
+
|
|
90
|
+
## 1.0.2 - 06.08.2024
|
|
91
|
+
|
|
92
|
+
### Bugfixes
|
|
93
|
+
|
|
94
|
+
- Fixed bug in the layer tree view. The layer tree is visible again.
|
|
95
|
+
|
|
96
|
+
## 1.0.1 - 23.07.2024
|
|
97
|
+
|
|
98
|
+
### Bugfixes
|
|
99
|
+
|
|
100
|
+
- Fixed a bug in the campaign change event in the viewer.
|
|
101
|
+
|
|
102
|
+
## 1.0.0 - 17.05.2024
|
|
103
|
+
|
|
104
|
+
### Bugfixes
|
|
105
|
+
|
|
106
|
+
- Restoration of toolbar and top bar functionality: They can now be shown and hidden smoothly.
|
|
107
|
+
|
|
108
|
+
### Added
|
|
109
|
+
|
|
110
|
+
- Introduction of machine authentication and a new corresponding example.
|
|
111
|
+
- Added: Option for access token in the init function.
|
|
112
|
+
- Added: Refresh token for the init function.
|
|
113
|
+
- Typings
|
|
114
|
+
|
|
115
|
+
### Changed
|
|
116
|
+
|
|
117
|
+
- Examples have been updated to accommodate the new authentication process.
|
|
118
|
+
|
|
119
|
+
### Deleted
|
|
120
|
+
|
|
121
|
+
- Interactive login functions.
|
|
122
|
+
- Removed: Two options from the init function:
|
|
123
|
+
- demoAccess
|
|
124
|
+
- redirectPath
|
|
125
|
+
|
|
126
|
+
## 0.2.8 - 08.04.2024
|
|
127
|
+
|
|
128
|
+
### Added
|
|
129
|
+
|
|
130
|
+
- Integrated and documented functions
|
|
131
|
+
- moveToPosition
|
|
132
|
+
- moveToCampaign
|
|
133
|
+
- lookAtPosition
|
|
134
|
+
- getRoutes
|
|
135
|
+
|
|
136
|
+
## 0.2.7 - 04.04.2024
|
|
137
|
+
|
|
138
|
+
### Added
|
|
139
|
+
|
|
140
|
+
- Improved documentation
|
|
141
|
+
- Description of the event types
|
|
142
|
+
- Description of further settings
|
|
143
|
+
|
|
144
|
+
### Changed
|
|
145
|
+
|
|
146
|
+
- Adaptation to the existing examples
|
|
147
|
+
|
|
148
|
+
## 0.2.4 - 14.03.2024
|
|
149
|
+
|
|
150
|
+
### Bugfixes
|
|
151
|
+
|
|
152
|
+
- Troubleshooting with internal module
|
|
153
|
+
|
|
154
|
+
## 0.2.3 - 09.02.2024
|
|
155
|
+
|
|
156
|
+
### Added
|
|
157
|
+
|
|
158
|
+
- Demo Access Login
|
|
159
|
+
- Documenation
|
|
160
|
+
|
|
161
|
+
### Changed
|
|
162
|
+
|
|
163
|
+
- Adoption of adjustments to the UI base of infra3D Edit
|
|
164
|
+
|
|
165
|
+
### Bugfixes
|
|
166
|
+
|
|
167
|
+
- Various minor adjustments
|
|
168
|
+
|
|
169
|
+
## 0.2.0 - 30.01.2024
|
|
170
|
+
|
|
171
|
+
### Added
|
|
168
172
|
|
|
173
|
+
- Edit functionality
|