@inovitas/infra3dapi 0.2.4 → 0.2.8

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
@@ -1,25 +1,74 @@
1
1
  # Installation
2
2
  ### NPM Package
3
- The api can be installed with npm as a package. To install it from the npm package repository just type:
3
+ The API can be installed as a package using npm. To install it from the npm package repository, simply type:
4
4
  ```bash
5
5
  npm install @inovitas/infra3dapi
6
6
  ```
7
7
 
8
8
  ### CDN Download
9
- As alternative you can get the api from a CDN. To get the latest version add the following script into your html file:
9
+ Alternatively, you can obtain the API from a CDN. To get the latest version, add the following script to your HTML file:
10
10
  ```html
11
11
  <script src="https://cdn.jsdelivr.net/npm/@inovitas/infra3dapi@latest/infra3dapi.js"></script>
12
12
  ```
13
- We recommend to use a specific version in your project. To get a specific version use the following script and adjust the version to your version:
13
+ We recommend using a specific version in your project. To get a specific version, use the following script and adjust the version accordingly:
14
14
  ```html
15
15
  <script src="https://cdn.jsdelivr.net/npm/@inovitas/infra3dapi@0.1.0/infra3dapi.js"></script>
16
16
  ```
17
+ **Note**: Please do not name the `<div>` in which the viewer is initialized as "infra3d" as this may cause internal conflicts.
17
18
 
18
19
 
19
20
  # Core Concept
20
- 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 from the sdk. 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)).
21
+ 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)).
21
22
 
22
23
 
23
- # Changelog
24
- ## 0.1.0 - 22.09.2023
25
- First MVP release of the new JavaScript API
24
+ # Changelog
25
+
26
+ ## 0.2.8 - 08.04.2024
27
+
28
+ ### Added
29
+
30
+ - Integrated and documented functions
31
+ - moveToPosition
32
+ - moveToCampaign
33
+ - lookAtPosition
34
+ - getRoutes
35
+
36
+ ## 0.2.7 - 04.04.2024
37
+
38
+ ### Added
39
+
40
+ - Improved documentation
41
+ - Description of the event types
42
+ - Description of further settings
43
+
44
+ ### Changed
45
+
46
+ - Adaptation to the existing examples
47
+
48
+ ## 0.2.4 - 14.03.2024
49
+
50
+ ### Bugfixes
51
+
52
+ - Troubleshooting with internal module
53
+
54
+ ## 0.2.3 - 09.02.2024
55
+
56
+ ### Added
57
+
58
+ - Demo Access Login
59
+ - Documenation
60
+
61
+ ### Changed
62
+
63
+ - Adoption of adjustments to the UI base of infra3D Edit
64
+
65
+ ### Bugfixes
66
+
67
+ - Various minor adjustments
68
+
69
+ ## 0.2.0 - 30.01.2024
70
+
71
+ ### Added
72
+
73
+ - Edit functionality
74
+