Knowledge Base
Recent Changes

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
dev:viewer:sdk:initialize_js [2020/05/15 11:17]
reine 		dev:viewer:sdk:initialize_js [2023/10/03 13:07] (current)
pieter [Loading the library]
Line 2: Line 2:
  
 This page describes how to initialize the Javascript SDK in a web environment. This page describes how to initialize the Javascript SDK in a web environment.
 +
 +<note warning>
 +By downloading and using the Orbit 3DM Viewer SDK, you agree with the terms of use on the development and usage of Orbit GT's 3DM Viewer SDK: \\ 
 +[[https://orbitgt.com/legal/developer-terms-of-use/|]].
 +</note>
  
 ===== Loading the library ===== ===== Loading the library =====
- 
-<note warning>By downloading and using the Orbit 3DM Viewer SDK, you agree with the terms of use on the development and usage of Orbit GT's 3DM Viewer SDK: \\ [[https://orbitgt.com/legal/developer-terms-of-use/|]].</note> 
  
 The library is compiled as a UMD (universal module definition) library and can as such be used in different javascript environments. \\ The library is compiled as a UMD (universal module definition) library and can as such be used in different javascript environments. \\
-It can be referenced by using this URL : **<nowiki>https://cdn.3dmapping.cloud/<version>/javascript/orbitgt_3dm_sdk.js</nowiki>**+It can be referenced by using this URL : **<nowiki>https://cdn.3dmapping.cloud/<version>/javascript/viewer_sdk_javascript.js</nowiki>** 
 + 
 +__Note__: Before version 23.7.0, the name of the javascript file was ''orbitgt_3dm_sdk.js''. 
 + 
 +=== Versions ===
  
 Replace **<version>** by the actual version you want to use. \\  Replace **<version>** by the actual version you want to use. \\ 
-For example to use SDK version 19.3.0 : <nowiki>https://cdn.3dmapping.cloud/19.3.0/javascript/orbitgt_3dm_sdk.js</nowiki>+For example, to use SDK version 23.7.0 : <nowiki>https://cdn.3dmapping.cloud/23.7.0/javascript/viewer_sdk_javascript.js</nowiki>
  
 +The following dynamic versions are available : 
 +  * ''stable'' - The last released version
 +  * ''beta'' - The version currently in development 
 +
 +It is strongly advised to keep the referenced version of the Viewer SDK within your Plugin up to date. \\
 +Forward compatibility (using an older version of the 3DM Viewer SDK to connect with a newer backed Publisher or Cloud) is not guaranteed. 
 +
 +In the proof-of-concept Orbit 3DM Viewer Plugin for ArcGIS Online, you can see the 3DM Viewer SDK in use: \\ ../widgets/Orbit 3D Mapping Widget/Orbit3DM.js
  
 ===== Usage in a document context ===== ===== Usage in a document context =====
Line 22: Line 37:
 Add the following script tag to your application. Add the following script tag to your application.
  
-Example for SDK version 19.3.0+Current stable release 
 +<code> 
 +<html> 
 + <head> 
 +   <script type="text/javascript" src="https://cdn.3dmapping.cloud/stable/javascript/viewer_sdk_javascript"></script> 
 + </head> 
 +</html> 
 +</code> 
 + 
 +Specific named version, e.g. 23.7.0
 <code> <code>
 <html> <html>
  <head>  <head>
-   <script type="text/javascript" src="https://cdn.3dmapping.cloud/19.3.0/javascript/orbitgt_3dm_sdk.js"></script>+   <script type="text/javascript" src="https://cdn.3dmapping.cloud/23.7.0/javascript/viewer_sdk_javascript"></script>
  </head>  </head>
 </html> </html>
Line 35: Line 59:
 Before we can start using the library, you must wait for the browser document to be fully loaded.  The code below is the most basic way of doing that by waiting for the ''DOMContentLoaded'' event. \\ Before we can start using the library, you must wait for the browser document to be fully loaded.  The code below is the most basic way of doing that by waiting for the ''DOMContentLoaded'' event. \\
 Once the library is ready, we can instantiate the ''SDKViewer'' class.  \\ Once the library is ready, we can instantiate the ''SDKViewer'' class.  \\
-The initial state of the viewer can be tweaked by providing [[concepts|startup options]] defined by the ''Constants'' class.  You can use startup options to [[viewer_state|restore viewer state]] or set the communication [[concepts|CRS]]. \\+The initial state of the viewer can be tweaked by providing [[dev:viewer:sdk:concepts|startup options]] defined by the ''Constants'' class.  You can use startup options to [[dev:viewer:sdk:viewer_state|]] or set the communication [[dev:viewer:sdk:concepts|CRS]]. \\
 After creating the viewer, wait for the ''isReady'' promise to resolve. After creating the viewer, wait for the ''isReady'' promise to resolve.
  
Line 41: Line 65:
 <html> <html>
   <head>   <head>
-    <script type="text/javascript" src="https://cdn.3dmapping.cloud/<version>/javascript/orbitgt_3dm_sdk.js"></script>+    <script type="text/javascript" src="https://cdn.3dmapping.cloud/stable/javascript/viewer_sdk_javascript.js"></script>
   </head>   </head>
   <body>   <body>
 
Last modified:: 2020/05/15 11:17