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:developer:3dmapping_sdk:viewer_state [2019/01/31 10:40]
pieter.bonne@orbitgt.com 		dev:developer:3dmapping_sdk:viewer_state [2020/05/15 11:22]
jeroen removed
Line 8: Line 8:
  
 To listen for state changes, we listen to the ''onAppStateChanged'' signal of the viewer. Save state whenever it changes. To listen for state changes, we listen to the ''onAppStateChanged'' signal of the viewer. Save state whenever it changes.
 +
 +Below is a pseudocode example of storing application state in the browser's localStorage.
  
 <code javascript> <code javascript>
-// Listen to the state-changed signal+// Listen to state changes
 viewer.onAppStateChanged.add(handleAppStateChanged); viewer.onAppStateChanged.add(handleAppStateChanged);
 +
 +// Save state
 +function handleAppStateChanged(state) {
 +    window.localStorage.getItem("m3dviewer_state",state);
 +}
 </code> </code>
  
Line 18: Line 25:
 When creating the viewer, you have the ability to pass [[glossary|startup options]]. The available options are defined by the ''Constants'' class.  You can use the ''Constants.STARTUP_APP_STATE'' startup option to restore a previously saved state. When creating the viewer, you have the ability to pass [[glossary|startup options]]. The available options are defined by the ''Constants'' class.  You can use the ''Constants.STARTUP_APP_STATE'' startup option to restore a previously saved state.
  
-Startup options can be provided only once.+Startup options can be provided only once, on viewer construction.
  
-===== Example ===== +Below is a pseudocode example of restoring the application state using the state we have previously stored in the browser's localStorage.
- +
-Below is a Javascript-specific example using ''window.localStorage'' for storing state.\\  +
-Try logging in to the viewer with "Remember me" checked, and refresh the page.+
  
 <code javascript> <code javascript>
-var viewer;+// Get a reference to some API elements we will use. 
 +var Constansts = orbitgt.mapping3d.sdk.viewer.Constants; 
 +var SDKViewer = orbitgt.mapping3d.sdk.viewer.SDKViewer; 
 +var AMap = orbitgt.mapping3d.sdk.viewer.AMap;
  
-/** +// Prepare options and set state. 
- * Called when something changes to the viewer state.  +var options = new AMap(); 
- */ +options.set(Constants.STARTUP_APP_STATE,window.localStorage.getItem("m3dviewer_state"));
-function handleAppStateChanged(state) { +
-    // Save state somewhere... +
-    window.localStorage.setItem("m3dviewer_state",state); +
-}+
  
-/** +// Create viewer 
- * Called when the viewer component is ready for interaction. +var appElement = document.getElementById("m3dviewer"); 
- */ +var viewer = new SDKViewer("example application",appElement,options);
-function handleReady() { +
-    // Listen to the state-changed signal +
-    viewer.onAppStateChanged.add(handleAppStateChanged); +
-} +
- +
-/** +
- * Called when the page is full loaded. +
- */ +
-function handleDOMReady() { +
-    // Create viewer startup options +
-    var options = new orbitgt.mapping3d.sdk.viewer.AMap(); +
-    options.set(orbitgt.mapping3d.sdk.viewer.Constants.STARTUP_APP_STATE,window.localStorage.getItem("m3dviewer_state")); +
-    // Create viewer +
-    var appElement = document.getElementById("m3dviewer"); +
-    viewer = new orbitgt.mapping3d.sdk.viewer.SDKViewer("example application",appElement,options); +
-    viewer.setSize(600,400); +
-    viewer.isReady.then(handleReady); +
-} +
- +
-// Wait for page to load +
-document.addEventListener("DOMContentLoaded", handleDOMReady);+
 </code> </code>
- 
-<html> 
-<iframe scrolling="no" src="https://sdk.3dmapping.cloud/19.0.1/javascript_examples/example02.html" allowfullscreen="" width="600px" height="400px" frameborder="0"> 
-</iframe> 
-</html> 
-