en:function_webexport
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
en:function_webexport [2022/09/20 10:54] – tom | en:function_webexport [2024/04/08 07:58] (current) – [Links] onyxadmin | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | + | ====== WebViewer Export | |
- | ====== WebViewer Export ====== | + | |
---- | ---- | ||
- | The Onyx 3D WebViewer allows to create a web based representation of the dataset for viewing in web browsers, including on mobile devices. The WebViewer can be integrated into [[en: | + | The Onyx 3D WebViewer allows to create a web based representation of the dataset for viewing in web browsers, including on mobile devices. The WebViewer can be integrated into websites or web portals of service providers, but does not itself provide any functions that go beyond mere presentation. See also entry [[en:web_communication |
- | | ||
Line 17: | Line 15: | ||
| Comment | | Comment | ||
| Object List | Show an Onyx-like list for modifying objects | | Object List | Show an Onyx-like list for modifying objects | ||
+ | | Tools | Show a toolbar for showing/ | ||
| Colors | | Colors | ||
| Password | | Password | ||
Line 22: | Line 21: | ||
| Patient Data | Select the data to display on the information popup | | Patient Data | Select the data to display on the information popup | ||
| Link | Result which can be given to the user or can be embedded into a patient-specific web page | | Link | Result which can be given to the user or can be embedded into a patient-specific web page | ||
- | | Password | + | | Password |
---- | ---- | ||
- | ===== Configuration ===== | + | ===== Configuration |
The upload has to be configured in [[settings|System Options]] on tab [[tab_uploaddata_webview|Upload Data]] > 3D-Web-Viewer before it becomes available as menu item. | The upload has to be configured in [[settings|System Options]] on tab [[tab_uploaddata_webview|Upload Data]] > 3D-Web-Viewer before it becomes available as menu item. | ||
- | ^ Entry ^ Description | + | For individualizing |
- | | Host | Your provider for the FTP-webspace | + | |
- | | Connection Security | + | |
- | | User Name | The user name für the FTP access | + | |
- | | User Password | + | |
- | | htaccess | + | |
- | | Host Directory | + | |
- | | Viewer Homepage | + | |
- | | Data Address | + | |
- | * Take care of the valid sequence of protocols in both the iframe-embedding in the viewer homepage and in the configuration above (http >= https in '' | + | ++++ Example code for a page with individualized viewer |
- | * Notice that the of the Host Directory might be different from the address from outside (Data Address) | + | |
- | * The minimal | + | |
- | * :!: Please note that the way of embedding has changed due to a new security feature (or bug) in the safari browser: | + | |
<html xmlns=" | <html xmlns=" | ||
< | < | ||
< | < | ||
- | function addIFrame() { // New dynamic frame insertion via script | + | function addIFrame() { // Frame is embedded using this script |
- | var iframe = document.createElement(' | + | var viewerLink = '// |
+ | var viewerData = window.location.search; | ||
+ | var iframe | ||
+ | | ||
iframe.setAttribute(' | iframe.setAttribute(' | ||
iframe.setAttribute(' | iframe.setAttribute(' | ||
- | iframe.setAttribute(' | + | iframe.setAttribute(' |
document.body.appendChild(iframe); | document.body.appendChild(iframe); | ||
} | } | ||
Line 61: | Line 52: | ||
</ | </ | ||
</ | </ | ||
+ | ++++ | ||
---- | ---- | ||
- | |||
===== Troubleshooting ===== | ===== Troubleshooting ===== | ||
- | The upload does not work: | + | ++++ First steps to configure your own server and viewer website | |
+ | - Fill out the configuration as described above. | ||
+ | - Upload a dataset and check that the link that is behind the '' | ||
+ | - Copy the example code from above to a html page on your own server and change the variable '' | ||
+ | - Add a logo which is ideally transparent and scaling well with the site also for mobile devices. | ||
+ | - Link your own viewer site in the OnyxCeph configuration and test the upload. | ||
+ | ++++ | ||
+ | |||
+ | ++++ The upload | ||
* Check the upload-settings and verify that you can connect wwith your settings using an auxilliary tool like TotalCommander or FileZilla | * Check the upload-settings and verify that you can connect wwith your settings using an auxilliary tool like TotalCommander or FileZilla | ||
+ | * If it is working with the same account settings on such other programs, test the other protocols (FTP, FTPES, FTPS, SFTS). | ||
+ | ++++ | ||
- | The viewer page stays empty with the message | + | ++++ The viewer page reports |
- | * Check the data address in the configuration: | + | * Check the data address in the configuration: |
+ | * Notice that the host directory is relative on the server and will be different from the data address which is needed for HTTP(S) access | ||
* Open the development tools in your browser using F12 and look for any red error message in the console: | * Open the development tools in your browser using F12 and look for any red error message in the console: | ||
* If the error contains something about " | * If the error contains something about " | ||
* If the error complains about http and https: verify your configuration: | * If the error complains about http and https: verify your configuration: | ||
+ | ++++ | ||
+ | |||
+ | ++++ The viewer page reports "Wrong password or corrupt file" | | ||
+ | * The file returned by the link in the '' | ||
+ | * Check again by entering this link alone that the correct file is delivered by the server. | ||
+ | ++++ | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ===== Extended Interface ===== | ||
+ | |||
+ | The webviewer supports a wide range of additional options for individualizing appearance and functionality. For instance, the icons can be exchanged and the font size can be controlled for " | ||
+ | |||
+ | ++++ Example code for the extended interface | | ||
+ | |||
+ | | ||
+ | |||
+ | // add event handler to catch the loading finished event from the viewer: | ||
+ | | ||
+ | |||
+ | var viewerLink = '// | ||
+ | var viewerData = window.location.search; | ||
+ | var iframe | ||
+ | |||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | } | ||
+ | |||
+ | // handle events from the viewer | ||
+ | | ||
+ | |||
+ | var eventObj = JSON.parse(event.data); | ||
+ | | ||
+ | // Do any initial setup here if required, like: | ||
+ | | ||
+ | /* functions for responsive design scaling and replacing icons | ||
+ | | ||
+ | | ||
+ | // id: possible values are: | ||
+ | // | ||
+ | // | ||
+ | // | ||
+ | // | ||
+ | // | ||
+ | // part: " | ||
+ | // value: d attribute of the svg path element for " | ||
+ | |||
+ | // Example for changing all the step icons to smaller icons (i.e. smaller numbers) | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | |||
+ | // Example for changing all the icons back to the pin-icons: | ||
+ | | ||
+ | | ||
+ | | ||
+ | } | ||
+ | */ | ||
+ | |||
+ | /* functions for controlling the timeline | ||
+ | | ||
+ | */ | ||
+ | |||
+ | /* possible functions for automatic control of the " | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | */ | ||
+ | |||
+ | /* functions for control of the " | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | */ | ||
+ | } | ||
+ | } | ||
+ | |||
+ | ++++ | ||
---- | ---- | ||
===== Links ===== | ===== Links ===== | ||
+ | |{{: | ||
|{{: | |{{: | ||
|{{: | |{{: | ||
- | |{{: | + | |{{: |
\\ | \\ | ||
en/function_webexport.1663664043.txt.gz · Last modified: 2022/09/20 10:54 by tom