https://kb.orbitgt.com/ 2026-07-30T10:04:38+00:00 https://kb.orbitgt.com/ https://kb.orbitgt.com/lib/tpl/orbitgt_standalone/images/favicon.ico text/html 2019-03-25T11:36:25+00:00 Anonymous (anonymous@undisclosed.example.com) https://kb.orbitgt.com/180/developer/webclient_js/example_checklicense?rev=1553513785 Example : Check Product License This example assumes you have successfully embedded the component. Every seat of your application must be activated before it can be used. During the license check, the user will be asked for an Activation Key or a Publisher Server that can provide an Activation Key instead. This activation key will be validated online and the license will then be granted or revoked. text/html 2019-03-25T11:36:25+00:00 Anonymous (anonymous@undisclosed.example.com) https://kb.orbitgt.com/180/developer/webclient_js/example_embed?rev=1553513785 Example : Embed the component Steps to take : * Load the API * Add the component to your page * Wait for the READY event. 1. Load the API Load API from a CDN Orbit provides a central storage of all API files. It is strongly advised to load the text/html 2019-03-25T11:36:25+00:00 Anonymous (anonymous@undisclosed.example.com) https://kb.orbitgt.com/180/developer/webclient_js/example_enable_inventory?rev=1553513785 Example : Enable Inventory Tools This example assumes you have successfully embedded the component and validated the license. The webclient has a minimal set of inventory tools that are disabled by default in the API context, because usually the host application implements these functions instead. This example shows you how to enable them again. text/html 2019-03-25T11:36:25+00:00 Anonymous (anonymous@undisclosed.example.com) https://kb.orbitgt.com/180/developer/webclient_js/example_hidemap?rev=1553513785 Example : Hide the map. This example assumes you have successfully embedded the component and validated the license. Hide the map The Orbit WebClient Component provides global functions to enable or disable the visibility of the Map or the Panorama components. By default both the Map and text/html 2019-03-25T11:36:25+00:00 Anonymous (anonymous@undisclosed.example.com) https://kb.orbitgt.com/180/developer/webclient_js/example_loadphoto?rev=1553513785 Example : Open photo This example assumes you have successfully embedded the component and validated the license. Opening the startup location You can open the startup location by using the applyStartupParameters() function. client.addEventListener(orbit.webclient.LoadPublicationEvent.SUCCESS, function(e) { client.applyStartupParameters(); }); text/html 2019-03-25T11:36:25+00:00 Anonymous (anonymous@undisclosed.example.com) https://kb.orbitgt.com/180/developer/webclient_js/example_loadpublication?rev=1553513785 Example : Load a publication This example assumes you have successfully embedded the component and validated the license. By default, the webclient displays a login panel where the user can select a URL, enter credentials and select a publication. This example demonstrates how you can bypass the login panel and load a publication directly. text/html 2019-03-25T11:36:25+00:00 Anonymous (anonymous@undisclosed.example.com) https://kb.orbitgt.com/180/developer/webclient_js/example_loadpublicationlist?rev=1553513785 Example : Load publication list Steps to take : * Embed the component. * Load publication list. 1. Embed the component Embedding the component is described here : Example : Embed the component. 2. Load publication list To load the list of available publications for a specific user, we must first configure which server to use, which credentials to use and validate the product license using the text/html 2019-03-25T11:36:25+00:00 Anonymous (anonymous@undisclosed.example.com) https://kb.orbitgt.com/180/developer/webclient_js/example_loginconfiguration?rev=1553513785 Example : Manage login configuration data This example assumes you have successfully embedded the component. By default the component saves and recalls the login configuration to and from the Flash Local Storage. This example shows you how to take control of the login configuration data and let the host application manage it. text/html 2019-03-25T11:36:25+00:00 Anonymous (anonymous@undisclosed.example.com) https://kb.orbitgt.com/180/developer/webclient_js/example_measurements?rev=1553513785 Example : Tracking Mobile Mapping Measurements This example assumes you have successfully embedded the component and validated the license. Listening to measurement completion events. The Orbit WebClient Component provides a Panorama component that manages all PanoramaViewer components that are in use. All measurement events are dispatched by the text/html 2019-03-25T11:36:25+00:00 Anonymous (anonymous@undisclosed.example.com) https://kb.orbitgt.com/180/developer/webclient_js/example_measurements_1113?rev=1553513785 Example : Tracking Mobile Mapping Measurements (11.1.3) Example for version 11.1.3 text/html 2019-03-25T11:36:25+00:00 Anonymous (anonymous@undisclosed.example.com) https://kb.orbitgt.com/180/developer/webclient_js/example_preventstartup?rev=1553513785 Example : Prevent the default startup location This example assumes you have successfully embedded the component and validated the license. When implementing an integration it may be useful to prevent the default startup location from being loaded. You may want to restore a previous location. This can be done quite easily using a setting. text/html 2019-03-25T11:36:25+00:00 Anonymous (anonymous@undisclosed.example.com) https://kb.orbitgt.com/180/developer/webclient_js/example_searchcoverages?rev=1553513785 Example : Search Panorama Coverages This example assumes you have successfully embedded the component and validated the license. This example shows you how to retrieve panorama coverages. A panorama coverage is extracted from the actual trajectory taken by the mobile vehicle while the module mapping data was recorded. This trajectory is then simplified and provided as text/html 2019-03-25T11:36:25+00:00 Anonymous (anonymous@undisclosed.example.com) https://kb.orbitgt.com/180/developer/webclient_js/example_searchphotos?rev=1553513785 Example : Search Panorama Photos This example assumes you have successfully embedded the component and validated the license. Steps to take : * Wait for the publication to load. * Search for panorama photos inside a boundingbox. * Search for panorama photos close to a location. * Open a panorama photo. text/html 2019-03-25T11:36:25+00:00 Anonymous (anonymous@undisclosed.example.com) https://kb.orbitgt.com/180/developer/webclient_js/example_snapshot?rev=1553513785 Example : Export panorama snapshots This example assumes you have successfully embedded the component and validated the license. Steps to take : * Listen to snapshot updates. * Process the snapshot. 1. Listen to snapshot updates. First we listen to viewer open and close events. Whenever a viewer is opened, we listen for the PanoramaViewerEvent.SNAPSHOT_UPDATED event. This event is dispatched when one of the viewers updated its snapshot image. text/html 2019-03-25T11:36:25+00:00 Anonymous (anonymous@undisclosed.example.com) https://kb.orbitgt.com/180/developer/webclient_js/example_test?rev=1553513785 Result Please open the JavaScript Console of your browser to see debug messages. text/html 2019-03-25T11:36:25+00:00 Anonymous (anonymous@undisclosed.example.com) https://kb.orbitgt.com/180/developer/webclient_js/example_viewerstate?rev=1553513785 Example : Tracking viewer changes This example assumes you have successfully embedded the component and validated the license. Steps to take : * Listen for viewer open and close events. * Listen for individual viewer events. 1. Listen for Panorama open and close events. The Orbit WebClient Component provides a text/html 2019-03-25T11:36:25+00:00 Anonymous (anonymous@undisclosed.example.com) https://kb.orbitgt.com/180/developer/webclient_js/example_wkt_area?rev=1553513785 Example : Working with a WKT Area layer This example assumes you have successfully embedded the component and validated the license. This example shows you how to add a polygon layer using WKT data. WKT is a standard for encoding geometries using plain text. The geometries can be expressed in any CRS and can be rendering using a custom legend. text/html 2019-03-25T11:36:25+00:00 Anonymous (anonymous@undisclosed.example.com) https://kb.orbitgt.com/180/developer/webclient_js/example_wkt_line?rev=1553513785 Example : Add a WKT Line layer This example assumes you have successfully embedded the component and validated the license. This example shows you how to add a line layer using WKT data. WKT is a standard for encoding geometries using plain text. The geometries can be expressed in any CRS and can be rendering using a custom legend. text/html 2019-03-25T11:36:25+00:00 Anonymous (anonymous@undisclosed.example.com) https://kb.orbitgt.com/180/developer/webclient_js/example_wkt_symbol?rev=1553513785 Example : Add a WKT Point layer This example assumes you have successfully embedded the component and validated the license. This example shows you how to add a symbol layer using WKT data. WKT is a standard for encoding geometries using plain text. The geometries can be expressed in any CRS and can be rendering using a custom legend. text/html 2019-03-25T11:36:25+00:00 Anonymous (anonymous@undisclosed.example.com) https://kb.orbitgt.com/180/developer/webclient_js/index?rev=1553513785 Web Client JavaScript SDK This page gives an overview on all platform specific documentation to use Orbit WebClient API in a Javascript environment. Reference The javascript API follows the reference documentation with only some small exceptions. Asynchronous requests text/html 2019-03-25T11:36:25+00:00 Anonymous (anonymous@undisclosed.example.com) https://kb.orbitgt.com/180/developer/webclient_js/migration_104_105?rev=1553513785 Notes on migrating from 10.4 to 10.5 This page highlights the most important API changes when migrating from the 10.4 to 10.5 APIs. Loading the API Loading the API changed; the script reference now includes an API version. This ensures your application will always be using the text/html 2019-03-25T11:36:25+00:00 Anonymous (anonymous@undisclosed.example.com) https://kb.orbitgt.com/180/developer/webclient_js/migration_105_111?rev=1553513785 Notes on migrating from 10.5 to 11.1 This page highlights the most important API changes when migrating from the 10.5 to 11.1 APIs. Events Some events were removed : * ClientEvent.LOAD_PUBLICATION_LIST_FAILURE -> LoadPublicationListEvent.FAILURE text/html 2019-03-25T11:36:25+00:00 Anonymous (anonymous@undisclosed.example.com) https://kb.orbitgt.com/180/developer/webclient_js/problems?rev=1553513785 Troubleshooting text/html 2019-03-25T11:36:25+00:00 Anonymous (anonymous@undisclosed.example.com) https://kb.orbitgt.com/180/developer/webclient_js/usecase_loadpublication?rev=1553513785 Back to Web Client JavaScript API Example : Load a publication Steps to take : * Load the API. * Embed the viewer component into your webpage. * Connect to your server and load the publication. 1. Load the API We start by loading the API from the server we are connecting to. The