For documentation on the current version, please check Knowledge Base.
This is an old revision of the document!
Getting started Javascript SDK
This page describes how to initialize the Javascript SDK in a web environment.
https://orbitgt.com/legal/developer-terms-of-use/.
Loading the library
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 : https://cdn.3dmapping.cloud/<version>/javascript/orbitgt_3dm_sdk.js
Replace <version> by the actual version you want to use.
For example to use SDK version 20.9.0 : https://cdn.3dmapping.cloud/20.9.0/javascript/orbitgt_3dm_sdk.js
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.
Related to the proof-of-concept Orbit 3DM Viewer Plugin for ArcGIS Online, check the referenced 3DM Viewer SDK in “
../widgets/Orbit 3D Mapping Widget/Orbit3DM.js
Usage in a document context
Using the library on a browser document is straightforward.
Add Script Tag
Add the following script tag to your application.
<html> <head> <script type="text/javascript" src="https://cdn.3dmapping.cloud/23.1.0/javascript/viewer_sdk_javascript"></script> </head> </html>
Create Viewer instance
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.
The initial state of the viewer can be tweaked by providing startup options defined by the Constants
class. You can use startup options to Restoring Viewer State or set the communication CRS.
After creating the viewer, wait for the isReady
promise to resolve.
<html> <head> <script type="text/javascript" src="https://cdn.3dmapping.cloud/23.1.0/javascript/viewer_sdk_javascript.js"></script> </head> <body> <div id="app"> <script type="text/javascript"> var viewer; /** * Called when the viewer component is ready for interaction. */ function handleReady() { // Set initial size viewer.setSize(600,400); } /** * Called when the page is full loaded. */ function handleDOMReady() { // Choose an application name that best suits your plugin var applicationName = "Orbit 3D Mapping Web AppBuilder Widget"; // Create viewer var appElement = document.getElementById("m3dviewer"); viewer = new orbitgt.mapping3d.sdk.viewer.SDKViewer(applicationName,appElement); viewer.isReady.then(handleReady); } // Wait for page to load document.addEventListener("DOMContentLoaded", handleDOMReady); </script> <div id="m3dviewer"/> </body> </html>