Home

NeptuneLabs Document

1. ShowAngle Description Display current angle Syntax Bool Default false Context Plug in attribute If set to true the plug in appends a text representing the current angle in degrees to the text display E g 120 2 inches 43 2 NeptuneLabs FSI Viewer 135 Plug in Reference LineColor Description Defines the color of the measure lines Syntax HexColor Default FF0000 Context Plug in attribute 6 digit hexadecimal color value defining the color of the measure lines TextColor Description Defines the color of the text Syntax HexColor Default 000000 Context Plug in attribute 6 digit hexadecimal color value defining the color of the text BGColor Description Defines the color of the text background Syntax HexColor Default FFFFFF Context Plug in attribute 6 digit hexadecimal color value defining the background color of the text BGAlpha Description Defines the opacity of the text background Syntax Number Default 80 Context Plug in attribute Defines the opacity of the text background 0 100 Events Description Fire plug in events Syntax Boolean Default False Context Plug in attribute Version 3 2 5 and above Specifies whether the plug in fires plug in events Plug in events can be handled wh
2. DragBar Description Enable Disable dynamic resizing of the thumbnail bar Syntax Resizable Fixed or Hidden Default Resizable Context Showcase plug in node or HTTP query prefixed with showcase e Resizeable The user is able to resize the thumbnail bar dynamically The width of the splitter bar of the showcase is increased e Fixed The user is not able to resize the thumbnail bar dynamically The width of the splitter bar of the showcase is normal e Hidden The user is not able to resize the thumbnail bar dynamically and the splitter bar of the showcase is invisible DragMenu Description Show Hide the buttons in the thumbnail bar Syntax Boolean Default True Context Showcase plug in node or HTTP query prefixed with showcase Show the buttons of the thumbnail bar enabling the user to resize the thumbnails and the bar itself This parameter is always false if the parameter DragBar is hidden UseInitialView Description Use InitialView parameters to for thumbnail images Syntax Boolean Default True Context Showcase plug in node or HTTP query prefixed with showcase Use the image section defined by the parameter InitialView to create the thumbnail image if set to true If set to False the entire image will be used 1 NeptuneLabs FSI Viewer FSI Showcase Add on InitialImage
3. thumbnails LabelMode Description Content of the thumbnail labels Syntax Number Default 0 Context Showcase plug in node or HTTP query prefixed with showcase NeptuneLabs FSI Viewer 63 FSI Showcase Add on Defines the content of the text presented below the thumbnail image The following modes are available e Mode 0 default Display the text defined by Label parameter e Mode 1 Display the index of the image e Mode 2 Display the index of the image plus the text defined by Label parameter e Mode 3 Display the prefix only LabelPrefix Description Prefix applied to thumbnail texts Syntax String Default SS Context Showcase plug in node or HTTP query prefixed with showcase_ A prefix string applied to all thumbnail labels or false for now prefix This is especially useful with LabelMode 2 and LabelMode 3 to display the image index with a prefix like or image or if you want to display a general tool tip for all images like Click to view image LabelSpaceX Description Additional horizontal space for thumbnail text Syntax Pixel Default 0 Context Showcase plug in node or HTTP query prefixed with showcase_ You can use this value to increase or decrease the width of the thumbnail text area Increasing the width might display the text across the thumbnail boundaries or even lead to overlappi
4. Hide the menu bar on startup The user has to click the Show Menu button to show the user interface This option is especially useful when an image is meant to look like an ordinary image or when there are many FSI Viewers on a single web page UISwitchable Description Enable hiding showing the user interface Syntax Bool Default True Context lt Options gt Version 3 2 2 and above Specifies whether the user is able to show or hide the user interface by clicking the corresponding button or pressing 0 of the num pad The Show Menu button is hidden if this option is set to false NoImageBlend Description Subsequently loaded image details display without transition Syntax Bool Default False Context lt Options gt Version 1 2 0 or higher If this parameter is activated subsequently loaded image details are displayed abruptly without transition Effects Description Image manipulation parameters for all images Syntax String Default Context Options Version 1 3 0 or higher The effects parameter can be used to pass image manipulation parameters to the imaging server The range of available parameters depends on the imaging 40 NeptuneLabs FSI Viewer ag Configuration server being used Typical manipulation parameters include the image compression quality or glt and
5. Dir Description eRez image share eRez only Syntax String Default Context Showcase plug in node or HTTP query prefixed with showcase_ Specifies the image directory on the eRez Imaging Server the lt Images gt section will be created for e g images paintings Query Description Search query eRez server only Syntax String Default Context Showcase plug in node or HTTP query prefixed with showcase_ Specifies a search query to be used to generate the showcase e g foo Can be used alternatively to the dir parameter 4 NeptuneLabs FSI Viewer FSI Showcase Add on Server Description Path to imaging server eRez server only Syntax String Default Context Showcase plug in node or HTTP query prefixed with showcase Specifies the URL of the eRez imaging server to generate the configuration E g http mydomain com erez2 This parameter can be omitted if the Showcase has been installed to the default location on the eRez imaging server Please note Loading configurations across domain boundaries will fail due to a security restriction of the Macromedia Flash plug in NeptuneLabs FSI Viewer 5 FSI Showcase Add on Advanced Parameters The following parameters can be used to customize the appearance of the thumbnails and the thumbnail bar Please note that you can easily change the c
6. NeptuneLabs FSI Viewer 25 Configuration 2 Preventing Security Popup with Flash MX 2004 plug ins From Flash MX 2004 Macromedia modified the security model of Flash plug ins regarding the cross domain policy To avoid security messages popping up when FSI Viewer tries to retrieve data from the Imaging server you have to add an XML file to the root directory of the imaging server being requested The file contains information about domains that are allowed to retrieve data from the specific domain and has to be named crossdomain xml Example crossdomain xml lt xml version 1 0 encoding iso 8859 1 lt cross domain policy gt lt allow access from domain secure false gt lt cross domain policy gt Please refer to the Macromedia documentation for more information regarding cross domain security 26 NeptuneLabs FSI Viewer Configuration Basic Parameters The following parameters are essential and usually need to be specified Please refer to the chapter Retrieving Parameters Automatically for information on how to enable FSI Viewer to retrieve image specific parameters values automatically CFG Description Relative path to a configuration file Syntax fsi swfecfg FSI_Name Default Context HTTP query only A relative path to an fsi configurations file The file extension fsi has to be omitted You can specify a def
7. 3 Navigating to image sections To navigate to a specific image section you simply use the Goto command followed by a valid image section parameter Please refer to the chapter Debug Mode for details on how to obtain image section parameters Example Button Zoom to image section MSIE lt input type button value Zoom to section onClick document all fsiviewer SetVariable FSICMD Grorie 9 8d 3p 0 0 0 gw Implementing JavaScript callbacks Using JavaScript callbacks enables you to react on FSI Viewer FSI Showcase events by executing JavaScript code The JSBridge plug in calls a JavaScript function using the Flash FSCommand architecture providing an event identifier and a parameter Please follow the steps below to implement JavaScript callbacks from FSI Viewer FSI Showcase Step 1 Enable JavaScript callbacks by setting the plug in parameter Callback to true e g Example Enabling JavaScript Callbacks plugin src jsbridge callback true gt Or alternatively via HTTP query fsi swf cfg foo amp jsbridge callback 1 Step 2 Add a unique identifier to the object and the embed tag of FSI Viewer FSI Showcase NeptuneLabs FSI Viewer 127 Plug in Reference Example Adding ID NAME parameters lt object id fsiviewer classid gt lt Param name movie value gt lt embed NAME fsiviewer gt lt object gt Step 3 Add a Ja
8. Align Description Position of the thumbnail bar Syntax left top right bottom Default right Context Showcase plug in node or HTTP query prefixed with showcase Defines the position of the thumbnail bar Please note that the orientation of a possible scrollbar can be defined by the parameter HScroll InitialSize Description Initial size of the thumbnail bar Syntax Size in pixel or percent or in number of items Default 1 item Context Showcase plug in node or HTTP query prefixed with showcase Defines the initial size of the thumbnail bar You can define the size in absolute pixel values e g 120 in percent of the viewer size 50 or by the number of thumbnails being displayed horizontally Align left right or vertically Align top bottom If you set the Layout parameter to Outside or Inside this value additionally defines the minimum size of the thumbnail bar the user can achieve by dragging the thumbnail bar HScroll Description Display a horizontal scroll bar if required Syntax Boolean Default False Context Showcase plug in node or HTTP query prefixed with showcase_ e False Arrange thumbnails vertically and use a vertical scroll bar if required e True Arrange thumbnails horizontally and use a horizontal scroll bar if required 70 NeptuneLabs FSI Viewer FSI Showcase Add on
9. NeptuneLabs FSI Viewer HTML Source Code Integration into HTML Pages NeptuneLabs FSI Viewer has to be integrated into HTML pages by means of an lt object gt tag just like any other Flash movie clip Configuration parameters have to be appended to the URL of the movie clip be means of an HTTP query If you already know how to add Flash movie clips to HTML code you can simply skip this chapter and move on to the chapter Configuration Object Tag All recent browsers require an lt Object gt tag to integrate a Flash movie clip Older browsers use the obsolete lt Embed gt tag instead Sample HTML code to integrate FSI Viewer into HTML pages Variable data printed in bold and square brackets lt OBJECT classid clsid D27CDB6E AE6D 11cf 96B8 444553540000 codebase http download macromedia com pub shockwave cabs flash swfl ash cab version 5 0 42 0 width Width height Height gt lt PARAM NAME movie VALUE URL and Parameter gt lt PARAM NAME bgcolor VALUE Background color gt lt PARAM NAME menu VALUE false gt lt OBJECT gt Embed Tag For browsers e g Netscape 4 x that do not support the lt object gt tag an additional lt embed gt tag with identical parameters is required lt OBJECT classid clsid D27CDB6E AE6D 11cf 96B8 444553540000 codebase http download macromedia com pub shockwave cabs flash swfl ash cab version 5 0 42 0 width
10. Function Adds a magnifier to the user interface Syntax Plugin src magnifier visible true size 10 The Magnifier plug in adds a magnifier to the user interface that can be dragged using the mouse Using the magnifier plug in does not cause additional data traffic as the plug in enlarges already loaded image data by software The magnifier can be hidden and shown using a corresponding button in the menu bar The level of magnification and the magnifier size can be defined by plug in parameters Plug in Parameters MenuOffset Description Indentation of the menu button Syntax Number Default 0 Context Plug in attribute Specifies the space in pixel left of the menu button of the plug in Visible Description Initial state of visibility Syntax Bool Default false Context Plug in attribute Defines the initial visibility of the magnifier NeptuneLabs FSI Viewer 111 Plug in Reference Size Description Size of magnifier Syntax Number Default 8 Context Plug in attribute Defines the overall size of the magnifier Possible values are between 4 and 16 Please note that greater values require more CPU power Magnification Description Level of magnification Syntax Number Default 2 Context Plug in attribute Defines the level of magnification where 1 means no magnificatio
11. InitialAction value NextScene gt lt InitialActionDelay value 3 gt lt MenuAlign value TL gt lt NoNav value true gt lt Options gt lt fsi_parameter gt 146 NeptuneLabs FSI Viewer Appendix Credits Special thanks go to the following persons for their valuable support such as providing translations sharing their ideas regarding improvements and beta testing Bora Alioglu Oscar Applegren Sven Erik Andersen Radoslav Bielik Maciej Chojnacki Jacky Choy Petr Cihar Marc Delisle Daniel Hinostroza Yukihiro Kawada Kristian Ottosen Ivo Teel Andri Viland NeptuneLabs FSI Viewer 147 Appendix Index Absolute Addressing 29 MenuAlign EE 33 Automation sserresesiriecuneipricuinrkaruiinin 25 55 NavEffects TTT 43 COMMENES rasitti eeki eiea 22 NaVvErame 5 eee eaaa sends teneret ene 34 Compatibility and Requirements 10 NavFrameColor eee 34 Deb g MOd6G ore rna eg een Rennen na 53 t ie EE 34 Embed Tag tette edad 18 NavMaskaAlpha eeeeeeeeeeee 35 Error Messages seeeeeen 142 NavMaskColor ssssssssssserrrrrrrrnrrnrnnnrnnnnnnnn 35 Flasli 5 ie Ee reete rex 32 NavWidth i e orte m recede 34 FSI Ghowcaee 61 NoImageBlend sesssess 40 FSI Showcase Parameters 68 Net ieee 34 ESI VI WGE 5 ond coo tere
12. Options lt Magnifier value false gt lt Options gt lt Image gt lt Images gt e Plug in parameters defining the initial state of a plug in do only apply to the first image The initial state does not get restored when selecting an image in the thumbnail bar For example if you set the visible parameter of the Magnifier plug in to true it will be initially visible but it will not be displayed each time the user selects an image if the user disabled the magnifier glass by clicking the corresponding button 66 NeptuneLabs FSI Viewer FSI Showcase Add on Showcase Parameters The Showcase parameters described in the following can be provided in 3 different ways a Attributes of the plug in tag Example Parameter provided as attribute Plugins Plugin src showcase Layout Outside gt Plugins b Child nodes of the plug in node Example Parameter provided as child nodes Plugins Plugin src showcase gt lt Layout value Outside gt lt Align value Left gt lt Plugin gt lt Plugins gt c By HTTP query value prefixed with showcase_ Example Parameter provided by query lt Param name movie value fsi swf showcase_layout Outside gt The following types of values can be entered Type Example Number 90 Pixel 90 String ZoomIn URL http www neptunelabs com Bool eithe
13. Error Keyboard commands not working Using the keyboard commands require the FSI Viewer to have the input focus Click anywhere inside the Viewer to pass the focus to the FSI Viewer 144 NeptuneLabs FSI Viewer Appendix Appendix Example of a default fsi file fsi parameter lt This file contains default parameters All parameters will be overwritten by additional fsi files or query parameters gt lt FPX gt lt ServerType value eRez gt Base value http erez neptunelabs com erez3 erez src FPX Plugins Plugins src mousemodes Plugins Options lt FSIBase value fsi gt lt ScenePreload value true gt lt MenuAlign value BR gt lt Animation value BEST gt lt ZoomCache value http zoomcache provider com gt ZoomCacheID value my zoomcache id gt lt ZoomCache50nly value true gt lt Options gt lt fsi_parameter gt NeptuneLabs FSI Viewer 145 Appendix Example of an image specific FSI configuration file fsi parameter lt required parameters for Flash 5 plugin gt Viewer Width value 330 gt Height value 338 lt Viewer gt lt FPX gt ccs Sigel EE lores e eeng dox eV daisies onr EE Hl Ee cem Sm value 3d object fpx Width value 8128 Height value 9168 TilesX value 4 TilesY value 3 FPX Options
14. Release Button Reset Reset Viewer ZoomIn Start zooming in ZoomOut Start zooming out Up Start panning upwards Down Start panning downwards Left Start panning to the left Right Start panning to the right RotateLeft Start rotating counter clockwise Z axis RotateRight Start rotating clockwise Z axis NextScene Start rotating clockwise Y axis PreviousScene Start rotating counter clockwise Y axis NextSceneSet Start rotating clockwise X axis PreviousSceneSet Start rotating counter clockwise X axis DebugWindow Show Hide the debug window if available InfoWindow Show Hide the about window if available Showcase only Description PreviousImage Select previous Image NextImage Select next Image SelectImage Select image n Important Use SetVariable ImageIndex 7 where n is 0 images prior to sending this command Alternatively you can select an image relatively from the currently selected image To select an image relatively you have to set ImageIndex to a number prefixed by or e g 1 selects the next image SwitchThumbs Show Hide Thumb bar 2 Button press release Using this command remotely presses releases a button inside FSI Viewer FSI Showcase There can not be more than one button pressed at a time Pressing another button by script will automatically release the previous button Usage FSIViewer SetVariable FSICMD Button ButtonID NeptuneLabs FS
15. a Flash based Single Ctt Source image Vieuier Version 3 User Manual FSI Viewer FSI Showcase Add on FSI Plug ins Software NeptuneLabs GbR P O B 1207 32818 Blomberg Germany 2003 2005 NeptuneLabs GbR All rights reserved Last updated in April 2005 FSI Viewer Version 3 2 5 FSI Showcase Version 3 1 2 Manual Revision 019 All brands and product names are trademarks or registered trademarks of the respective producers Contents Contents el 5 Alphabetical Index of FSI Viewer Parameters seen 7 INTRODUCT TION H 9 Compatibility and System Requirements NNN 10 Using FSI EE 11 MENULB TEE 11 MOUSE le EEN 12 Additional Tree E 13 Survey lee 13 Keyboard Kelter 14 cR LEM E 15 Setting p EE 16 le e 17 HTML SOURCE CODE ciiscsccisvacsaicctevsccsieabticecdessitatanacerceaseerdeeas 18 Integration into HTML e EE 18 ODICCE Tag EE 18 Embed E PER D 18 Variable HTML Parameters eeeeeeeseeeee nennen nne nnne nnn nnn nn nnn nnn 19 CONFIGURATION WEE 20 Using XML Configuration Files Teil 20 Using HTTP TT NEE 22 Hierarchy of Configuration Parameters uk 23 Choosing a Configuration Method eene 24 Retrieving Parameters Automatically sese 25 Basie KEE eeh 27 leier ERT 30 VIRTUAL 3D PRESENTATIONS eren 47 3D Crime 49 DEBUG MODE niensis eaoa pae uExES DE Eun Fu su kx E SEE na
16. 0 5236 888560 eMail info neptunelabs com WWW www neptunelabs com No part of this manual including the software described in it may be reproduced transmitted transcribed stored in a retrieval system or translated into any language in any form or by any means except documentation kept by the purchaser for backup purposes without the express written permission of NeptuneLabs Specifications and information contained in this manual are furnished for informational use only and are subject to change at any time without notice and should not be construed as a commitment by NeptuneLabs NeptuneLabs assumes no responsibility or liability for any errors or inaccuracies in this manual including the software described in it Copyright 2002 2005 NeptuneLabs GbR All rights reserved
17. 5 nere 70 ThumbBorderActiveWidth 78 LabelMarginBottom 85 ThumbBorderHighlight 79 LabelMarginTop eeeeeeeesese 85 ThumbBorderSelectedHighlight 79 LabelMode 3 iibi 83 ThumbBorderSelectedShadow 79 LabelOffeet Top REENEN 85 ThumbBorderSelectedWidth 78 LADEISPACEX ee ceceecseesessseeeeeeesseeaasaaeeeenens 84 ThumbBorderShadow 79 LabelSpaceY eene nnne 84 ThumbbBorderWidth s 78 LabelTextSize AAA 83 ThumbEffects A 73 IR Ve 69 ThumbFace eeeeeeeenenn enne 78 MarginBottom ANNER 81 ThumbSelectedFace ssssssseserreerererrrrrens 78 Matgihbeft ice deren ea nani 81 TOOMIPS eR A 72 Mat gin Rightsiin 81 LsetnitalVlew esee 71 68 NeptuneLabs FSI Viewer FSI Showcase Add on Basic Parameters BaseColor Description Base color of the thumbnail bar Syntax HexColor Default DDDDDD light gray Context Showcase plug in node or HTTP query prefixed with showcase Base color for the thumbnail frame work the scroll bar and the background of the thumbnail bar All color values will automatically be derived from this color if not defined separately see Advanced Parameters BaseScale Description Scale of thumbn
18. Context Plug in attributes 88 NeptuneLabs FSI Viewer Plug in Reference Provides the possibility to hide specific mouse mode buttons in the dropdown menu Example Remove Drag Button lt Plugin src mousemodes Model false gt The example above shows how to hide the button for mouse mode 1 Drag Mode n Mouse Mode Mode Q Zoom Modei Drag Mode2 Rotate X Y Axis g Mode3 v Rotate Z Axis NeptuneLabs FSI Viewer 89 Plug in Reference NeptuneLabs FSI Viewer Plug in Plug in Zoom Meter Plug in Target User interface Plug in Location plugins zoommeter plg 23 8 Function Displays the current level of magnification Syntax Plugin src zoommeter color 000000 gt The ZoomMeter plug in extends the survey window with a display of the current magnification Plug in Parameters Color Description Text color Syntax String Default 000000 black Context Plug in attribute Text color of the zoom display The color has to be defined as a 6 digit hexadecimal number E g FFFFOO for yellow SrcRelative Description Display magnification relative to source image or viewer size Syntax Boolean Default False Context Plug in attribute Version 3 0 0 or higher Display the current magnification in percent of the viewer size false or relative to the size o
19. Description Image selected at startup Syntax Number Default 1 Context Showcase plug in node or HTTP query prefixed with showcase The index of the image selected on startup Enter the index of the image from 1 to n images ToolTips Description Show tool tips when hovering above a thumbnail Syntax Boolean Default True Context Showcase plug in node or HTTP query prefixed with showcase Show tool tips when the mouse cursor hovers above a thumbnail The text presented in the tool tip is the text of the thumbnail This option can be useful if you choose to hide the text on the thumbnail or if the thumbnail label is too long to be entirely displayed on the thumbnail itself Multi line texts are being presented separated by commas MinimizeOnSelect Description Minimize the thumbnail bar on select Syntax Boolean Default True Context Showcase plug in node or HTTP query prefixed with showcase Minimize the thumbnail bar to the initial size when the user selects clicks a thumbnail TextOutsideFrame Description Display text outside thumbnail frame Syntax Boolean Default False Context Showcase plug in node or HTTP query prefixed with showcase Display the thumbnail label inside the thumbnail frame work false or outside the frame work true The option only applies to thumbnails in normal state in does not have an impac
20. InitComplete The viewer has finished parsing the configuration and is about to start loading image data ImageInfo String Provides concatenated image information See details below this table LoadingComplete The initial load progress of an image completed LoadProgress Number Number corresponding to the progress bar percent inside FSI Viewer Press Button ID The button ID has been pressed Release Button ID The button ID has been released ToolTip String escaped The tool tip String is about to be displayed See details below this table View Image Section The image section currently displayed Can be used with the Goto command ImageUrl URL template Provides a template that can be used to build an image URL corresponding to the image being displayed in FSI Viewer See details below this table Action Action ID The action ID is currently being executed Modal true false The viewer enters a passive true or an active false state MouseMode Mouse Mode ID The mouse mode ID has been activated Zoom Magnification The magnification has changed percent ImageSelected Image index A new image has been selected 0 nImages FSI Showcase only Please note that some plug ins provide additional events Please refer to the events parameter of the corresponding plug in for details The recommended way to react on an event is to extend the switch case block of the siviewer DoFSCom
21. Rotate gt Model 77 Description MouseWheel action for MouseMode 7 Syntax String Default Specified by default parameter or Zoom Context Plug in attribute Defines the action of the mouse wheel when mouse mode 7 has been activated Example Defining rotate as default action Plugin src mousewheel default Rotate Mode0 Rotate gt The example above shows how to specify the mouse wheel action Rotate for the mouse mode Zoom The possible values for n are as following MouseMode Zoom MouseMode Move MouseMode Rotate MouseMode Tilt QN BPO NeptuneLabs FSI Viewer 105 Plug in Reference NeptuneLabs FSI Viewer Plug in Plug in ClockProgress Plug in Target User interface Plug in Location plugins clockprogress plg 34 Function Replacement for default progress bar Syntax lt Plugin src clockprogress gt The ClockProgress plug in replaces the default progress bar with a round progress indicator Plug in Parameters The clockprogress plug in can be customized by adding attributes to the lt plugin gt tag E g Plugin src clockprogress alpha 20 gt The following attributes can be used to customize the clockprogress plug in Alpha Description Opacity of progress indicator Syntax Number Default 50 Context Plug in attributes Defines the opacity of the progress indicator Possibl
22. Width height Height gt lt PARAM NAME movie VALUE URL and Parameter gt lt PARAM NAME bgcolor VALUE Background color gt lt PARAM NAME menu VALUE false gt lt EMBED TYPE application x shockwave flash PLUGINSPAGE http www macromedia com shockwave download index cgi Pl Prod Version ShockwaveFlash SRC URL and Parameter WIDTH Width HEIGHT Height BGCOLOR Background color MENU false gt lt EMBED gt lt OBJECT gt 18 NeptuneLabs FSI Viewer Setup Variable HTML Parameters Width Width of the viewer in pixel or optional in percent with flash 6 or newer Height Height of the viewer in pixel or optional in percent with flash 6 or newer Background color Background color hexadecimal e g FFFFFF for white URL and parameter The address to the FSI Viewer and parameters provided as HTTP query e g c g oo For information about available parameters please see chapter FSI Parameters For further possible parameters or XHTML configuration options please refer to Flash documentations or renowned HTML references NeptuneLabs FSI Viewer 19 Configuration NeptuneLabs FSI Viewer Configuration Configuration parameters can be provided using XML configuration files and or by HTTP queries appended to the URL of the Flash movie clip Providing parameters by HTTP query is recommen
23. values permit magnifications smaller than the viewer size Possible values are 1 to 100 38 NeptuneLabs FSI Viewer Configuration ExtendedViewport Description Extend the size of the view port Syntax Boolean Default False Context lt Options gt With this option enabled you can pan the borders of the image to the center of the view port If you disable this option the panning range is smaller so that the user can not pan the image borders to the center of the view port Animation Description Animation quality Syntax String Default best Context lt Options gt Specifies the quality during animations transitions The lower the quality the smoother the animations Possible values none no animation at all low low quality high speed medium good quality and speed high very good quality slower speed with slow computers best best quality slower speed with slow computers AnimationSpeed Description Animation speed Syntax Number Default 50 Context lt Options gt Specifies the speed of the zoom and scene animations Possible values range from 1 very slow to 100 very fast See parameter Animation to disable animated motion NeptuneLabs FSI Viewer 39 Configuration HideUI Description Hide user interface Syntax Bool Default false Context lt Options gt
24. 0761 2 OE A080 275 Ow tip circle gt lt rect spot 1 10 0 54314 0 68446 0 74036 0 88168 56 tip rectangle url rect htm gt HotSpots Please refer to the chapter HotSpot Authoring Tips for useful tips on how to create HotSpots NeptuneLabs FSI Viewer 117 Plug in Reference HotSpot Parameters The following attributes can be assigned to each HotSpot Spot Description Position of the HotSpot Syntax String Default Ss Context HotSpot tag Defines the position of the HotSpot It is recommended to use the plug in SelectFrame to obtain this value Please refer to the chapter HotSpot Authoring tips for more information on this parameter View Description Image section to display Syntax String Default Value of spot parameter Context HotSpot tag Version 3 2 3 and above Defines the position to display when move is set to true If this parameter is undefined the value of spot will be used instead Please refer to the chapter HotSpot Authoring tips for more information on this parameter Tip Description Tooltip Syntax String Default Context HotSpot tag Defines a string to be used for a tooltip when the user moves the cursor over the HotSpot 118 NeptuneLabs FSI Viewer Plug in Reference Move Description Zoom to HotSpot area on click S
25. 31 4 mm 45 0 o User interface DURS Plug in Location me plugins measure plg Function Provides distance and angle measuring Syntax Plugin src measure This plug in can be optionally obtained Using the plug in without a valid licence key activates the evaluation mode The Measure plug in provides an additional mouse mode which enables the user to measure distances and angles inside the FSI Viewer by clicking amp dragging Pressing SHIFT locks the angle to 45 degree steps Pressing CTRL moves the measurement line Mouse Mode The mouse mode id for the measuring mode is 100 You can use this id to set the InitialMouseMode parameter of the FSI Viewer e g InitialMouseMode value 100 gt or cfg foo amp InitialMouseMode 100 Setting up the Plug in The Measure Plug in requires the real width of the entire image to enable distance measuring 132 NeptuneLabs FSI Viewer Plug in Reference Example 1 If you already know the entire width of the image simply add the ImageWidth and the Suffix parameter to the plug in tag If the width of the entire image is 120 5 inches the corresponding plug in tag looks as follows lt plugin src measure ImageWidth 120 5 Suffix inches gt Please note You might as well define all plug in parameters via query or inside the lt options gt group by using the prefix measure E g cfg image amp Measure ImageWidth 120 5 amp Measure Su
26. 60 NeptuneLabs FSI Viewer FSI Showcase Add on NeptuneLabs FSI Viewer FSI Showcase Add on FSI Showcase Add on integrates a resizable scroll pane to FSI Viewer displaying thumbnails of multiple images Clicking a thumbnail displays the image in FSI Viewer This way a single viewer instance can be used to display hundreds of images presenting thumbnails and optional texts for each image Integrating FSI Showcase The integration of FSI Showcase is very similar to an ordinary FSI plug in To enable the showcase you have to add a plug in node to your default XML configuration file Example Integrating FSI Showcase lt Plugins gt Plugin src showcase basecolor 58A8FF lt Plugins gt Please note that FSI Showcase requires Macromedia Flash plug in version 6 Flash MX or above Defining Image Lists The images to be displayed in FSI Showcase have to be defined in an lt images gt node added to your XML configuration file Example Defining FSI Showcase image nodes lt Images gt lt Image label My First Image file imagel fsi gt lt Image label My Second Image file image2 fsi gt lt Images gt 61 NeptuneLabs FSI Viewer FSI Showcase Add on There are three different ways of defining image lists 1 Creating image nodes referencing external XML configuration files Example External XML configuration files lt Images gt lt
27. Bridge API ServerTemplate Beschreibung Real time template of the imaging server Syntax String template name Default fsi Kontext lt FPX gt Query FPXServerTemplate Version 2 1 0 or higher This parameter applies to eRez Imaging Servers only and specifies the name of a real time template used when accessing the imaging server Using these templates you can specify e g the image compression maximum image dimensions and watermarks Src Description URL of the source image to be displayed Syntax URL Default b Context FPX Query FPXSrc Specify either a relative URL or the absolute URL of the source image on the imaging server The parameter FPXBase can be used to specify a base path to the imaging server Please refer to the documentation of your imaging server for details on supported image formats 28 NeptuneLabs FSI Viewer Configuration Example 1 Absolute addressing eRez Imaging Servers lt FPX gt Src value http www domain com erez3 erez src project foo tif gt lt FPX gt Example 2 Absolute addressing Iseemedia Imaging Servers lt FPX gt Src value http www domain com fif project foo fpx gt FPX Example 3 Partial relative addressing lt FPX gt Src value project foobar fpx FPX Width and Height Description Source image di
28. Configuration ScenePreload Description Load scenes in high resolution 3D Syntax Bool Default false Context lt Options gt If this parameter is activated all scenes will be loaded on startup in high resolution Otherwise preview images will be loaded with lower resolution This parameter can significantly influence loading times and traffic volumes Setting this parameter to false leads to faster startup times and scene images will be loaded as soon as they need to be displayed TilePaddingX and TilePaddingY Description Crops scene images by a given number of pixel Syntax Number pixel or percent Default 0 Context lt FPX gt Version 2 2 0 or higher Specifies a positive number of pixels that each source scene image 2D and 3D will be cropped by This parameter can be used to eliminate image margins especially with 3D objects containing polychrome backgrounds You can specify the padding either absolutely as a number of pixel or in percent of the source image NoSceneAnimation Description No SceneSet animations 3D Syntax Bool Default false Context lt Options gt Disable animations between scenes and scene sets This can be useful if different scenes represent different states of an object instead of a rotation NoSetLoop Description No 360 rotation around the y axis 3D Syntax Bool Default f
29. Image label My First Image file imagel fsi gt lt Image label My Second Image file image2 fsi gt lt Images gt 2 Creating image nodes containing complete image configurations Example Complete XML configurations lt Images gt lt Image label My First Image gt lt FPX gt lt SRC value imagel fpx gt lt FPX gt lt Image gt lt Image label My Second Image gt lt FPX gt lt SRC value image2 fpx gt lt Width value 8096 gt lt Height value 12300 gt lt FPX gt lt Options gt lt NoNav value true gt lt Options gt lt Image gt lt Images gt 3 Retrieving automatically generated image lists from a server Example Complete XML configurations lt Plugins gt Plugin src showcase server dir gt lt Plugins gt Method 1 and Method 2 can be freely combined while Method 3 retrieves a complete image list ignoring previously defined lt images gt nodes 62 NeptuneLabs FSI Viewer FSI Showcase Add on Image Order The order of the images within the thumbnail bar corresponds to the order of the lt image gt declarations within the lt images gt section Graphical Bookmarks and Product Tours The Showcase does not re load images if the image source did not change e g FXPSrc and Effects You can therefore use the Showcase to create graphical bookmarks or product tours by specifying the same
30. Specifies the size of image details image tiles The value can be defined relative to the viewer size e g 25 or using absolute pixel values e g 256 The default value of 50 means that each image tile is one quarter in size of the entire viewer This way a maximum of 9 image tiles is required to display the selected image section Please do not change this value unless you are certain that this is necessary and you are aware of possible consequences Defining smaller image tiles reduces the overall viewer performance and increases the number of requests and thus the imaging server load Defining larger image tiles might lead to increased traffic and decreased download performance as more image data than actually required for a certain image section will be loaded ConcurrentRequests Description Number of simultaneous image requests Syntax Number Default 2 Context Options Version 2 3 0 or higher Specifies the number of image details image tiles being requested simultaneously Please do not change this value unless you are certain that this is necessary and you are aware of possible consequences Increasing this value might lead to increased imaging server load Decreasing the value will decrease the download performance NeptuneLabs FSI Viewer 45 Configuration ZoomLevelFrequency Description Number of Zoom Levels Syntax Number
31. URL Default Context HotSpot tag Defines a hyperlink to be opened if the user clicks the HotSpot The URL can be given relatively or absolutely The Target parameter or respectively the DefaultTarget parameter defines the targetframe for the hyperlink Please refer to the BaseURL parameter as well Target Description Target frame for hyperlinks Syntax String Default _blank Context HotSpot tag Defines the targetframe for HotSpot hyperlinks Valid parameters include blank self top frames inside a HTML frameset parent and names of Please refer to the DefaultTarget parameter for details on how to set a default target for hyperlinks CFG Description FSI parameters to be used on click Syntax String query Default Context HotSpot tag If you define a CFG parameter for a HotSpot the viewer will be reinitialized with the given configuration if the user clicks the HotSpot This can be useful to switch from one image to another if the user clicks a HotSpot The syntax of the CFG parameter has to consist of FSI Parameters concatenated with the ampersand character like a HTTP query Parameteri valueil amp Parameter2 value2 120 NeptuneLabs FSI Viewer Plug in Reference Example cfg cfg image2 amp NoNav 1 Defining the parameter like this the viewer would reinitialize using the configuration file image2 fs
32. adding the following parameters to the default fsi or any other configuration file Example Inlude plug in SelectFrame plugins plugin src SelectFrame visible 1 window 1 rotate 1 AspectRatio 1 1 gt lt plugins gt After including the plug in you will be able to author hotspots directly in B a FSI Viewer a 0 46821367 0 31171482 0 4010 You can use the value displayed in ds EE the Selection window for the ET 9 pm Spot parameter of the hotspot z Ki dh You can use the value displayed in the View window for the optional 5 View parameter When modifying the select box please use SHIFT to lock the aspect ratio of the selection CTRL to resize the selection relative to the center ALT to rotate the selection ALT SHIFT to rotate the selection in steps of 5 degrees HotSpot Z Order When defining Hot Spots that overlap each other you have to keep the z order of the Hot Spots in mind The z order of Hot Spots is determined by the sequence in which they are defined in the configuration file from bottom to top As a rule of thumb you should define big Hot Spot areas first to ensure that smaller Hot Spots are not completely hidden underneath 122 NeptuneLabs FSI Viewer Plug in Reference NeptuneLabs FSI Viewer Plug in Plug in JavaScript Bridge Plug in Target Scripting Plug in Location pl
33. function or a server side script Example Templates in CustomButton URLs lt Plugine sec Veustombubron buttons A Orms Denit URES javaseriptyalherna t SSerqphPxXWidthosSmxoSehq bP xXHeaghitSiom iay gt The example above outputs the size of the source image via JavaScript The following templates are available Template in URL Replaced by cfg Name The value of the FSI Viewer parameter name Be sure to use the long parameter names only e g FPXWidth instead of width You can retrieve parameter values retrieved from the imaging server using this template as well E g 5 cfg FPXWidth returns the size of the source image whether specified manually or retrieved from the imaging server s Views A string representing the current image section in FSI Viewer see Parameter InitialView for details SSURLViewS The complete URL to the image currently displayed in FSI Viewer The resulting string contains the templates SSwidth S Sheight and SStemplate eRez only which need to be replaced in JavaScript or server side script SSURLScenes Same as above but representing the entire scene image DownloadRatio Aspect ratio representing the factor width heigth You can use this value to calculate the width of the image to download Zoom Current magnification relative to the initial size of the image Selection A string representing the current s
34. image source FPXSrc for multiple images and defining different InitialView parameters The Showcase parameter UselInitialView should be set to true default in this case FSI Parameters and FSI Showcase All FSI parameters and FSI Plug in parameters can be used with FSI Showcase Add on The only exception is the plug in integration which will be described later on The Showcase Add on follows the hierarchy displayed below to build the configuration for an image Hierarchy of parameter definitions 1 Default Configuration File 2 Showcase Configuration File 3 Image Configuration File 4 Image Node 5 HTTP Query This way you can define global parameters for all images by defining the parameters in 1 default configuration 2 showcase configuration or 5 by HTTP query Parameters specific to certain images have to be defined in the external image configuration file 3 or in the image node of the image list 4 Due to the hierarchy displayed above parameters declared by query supersede all other parameter definitions This can be especially useful if you want to supersede parameters defined in external configuration files for example superseding the MenuAlign parameter NeptuneLabs FSI Viewer 63 FSI Showcase Add on Defining the Showcase Layout The appearance of the Showcase Add on can be customized by a large number of configuration parameters The parameters will be described in detail in the
35. inside the survey window Syntax HexColor Default FF0000 depending on the skin Context Options Version 3 0 0 and above Specify a 6 digit HexColor to change the color of the selection frame inside the survey window e g OOOOFF for blue 34 NeptuneLabs FSI Viewer Configuration NavMaskColor Description Color of the area around the selection frame of the survey window Syntax HexColor Default depends on the skin Context Options Version 3 0 0 and above Specify a 6 digit hexadecimal color to change the color of the area outside the selection frame of the survey window e g FFFFFF for white NavMaskAlpha Description Opacity of the area around the selection frame of the survey window Syntax Number 0 100 Default depends on the skin Context Options Version 3 0 0 and above Specify the opacity of the area outside the selection frame of the survey window Possible values are integer values from 0 invisible to 100 opaque InitialView Description Initial image segment Syntax SceneSet Scene left top right bottom rotation Default 1 1 0 0 1 1 0 Context Options Image section and rotation to display on startup The first two parameters are required as they specify the scene set and the Scene For 2D image both of these values default to 1 The other parameters are
36. like sharpen or quality to all images inside the survey window Please refer to effects parameter for a detailed description SceneEffects Description Image manipulation parameters applied to preview images Syntax String Default Context Options Version 3 1 1 or higher Applies image manipulation effects like sharpen or quality to all un tiled images in the viewer Please refer to effects parameter for a detailed description TileEffects Description Image manipulation parameters applied to image tiles Syntax String Default Context Options Version 3 1 1 or higher Applies image manipulation effects like sharpen or quality to all images tiles in the main view area Please refer to effects parameter for a detailed description ZoomCache Description URL of the ZoomCache Syntax URL Default Context lt Options gt If you use NeptuneLabs ZoomCache please specify the URL of the ZoomCache server here If you haven t setup one yourself you can receive this URL and a ZoomCache ID from your image hosting provider NeptuneLabs FSI Viewer 43 Configuration ZoomCacheID Description ID of the ZoomCache access profile Syntax String Default Context lt Options gt When using NeptuneLabs ZoomCache enter the name of the access profile for your images her
37. name of the plug in and a value of false to the lt Options gt section of your configuration file or provide a corresponding parameter via HTTP query Example Disabling the History Plug in lt Options gt lt History value false gt lt Options gt or by HTTP query Example Using a Query to disable History Plug in Obs eet s5 lt PARAM NAME movie VALUE fsi swf cfg image fsi amp history false Object NeptuneLabs FSI Viewer 59 Plug ins Plug in Parameters Plug in parameters are defined as attributes of the lt Plugin gt tag Please note that some plug ins might require specific attributes or even entire XML sections in the configuration file to work properly For information on a specific plug in please refer to the Plug in Reference Example Defining plug in parameters lt Plugins gt Plugin src navextension MenuOffset 10 visible true gt lt Plugins gt Providing Plug in Parameters by Query To provide plug in parameters by query you have to prefix the corresponding parameter with the name of the plug in and an underscore character PluginName_ParameterName value Example Providing plug in parameters via HTTP query fsi swf navextension visible true amp history length 10 The example above sets the visible parameter of the NavExtension plug in to true and the length parameter of the History plug in to 10
38. or the x axis if available Click on the image and drag to the left or to the right Move the mouse up or down to rotate the object around the x axis To reset rotation hold down the CTRL key and click on the image 12 NeptuneLabs FSI Viewer Using FSI Viewer Additional Buttons P Hide Display menu Displays or hides the user interface Information Displays information about the viewer and refers to a configurable help page Parameter HelpURL Survey Window In the survey window you can see a miniature presentation of the entire image The segment which is currently viewed is framed in red In the survey window you can change the current segment either by dragging the frame or by clicking on the desired area of the image 13 NeptuneLabs FSI Viewer Using FSI Viewer Keyboard Shortcuts FSI Viewer and FSI Showcase can also be controlled with the keyboard The list below shows which keys have what function As most of the keys belong to the Num field it has to be activated before use Key Function ell m Back to original view spacebar Ak ein Move to the left left arrow Num 6 t right arrow Move to the right del vun Move up up arrow MUNA Move down down arrow Num 1 Turn around the z axis to the left Num 3 Turn around the z axis to the right Num 7 ck Rotate around the y axis to the left 3D only Nu
39. state will be set accordingly Alpha Description Defines the opacity for all HotSpots Syntax Number zwischen 0 100 Default 100 Context lt HotSpots gt tag Defines the opacity for all HotSpots from 0 invisible to 100 opaque BaseURL Description Prefix for relative HotSpot URLs Syntax String Default n Context lt HotSpots gt group tag Defines a prefix that will be applied to all HotSpots containing relative URLs This way you can omit e g the domain in URL attributes of subsequent HotSpots Defining Default Attributes The following attributes define default attributes to all HotSpot that do not contain a corresponding attribute itself E g defining a DefaultTarget of _self will open all hyperlinks in the frame the viewer resides in if there is no individual Target attribute defined NeptuneLabs FSI Viewer 115 Plug in Reference DefaultTarget Description Default target for hyperlinks Syntax String Default _blank Context lt HotSpots gt group tag Defines the default target frame for HotSpot hyperlinks Valid parameters are blank self top parent and names of frames inside a HTML frameset DefaultMove Description Zoom to HotSpot area by default Syntax Bool Default true Context lt HotSpots gt group tag Defines the default value for all subsequent HotSpo
40. Content Description core Core components debug Debugging components This folder can safely be deleted if debugging is not required any more languages User interface language files plugins FSI Plug ins extending FSI Viewer at runtime skins FSI Skins containing the visible parts of the user interface NeptuneLabs FSI Viewer 15 Setup Setting up FSI Viewer Step 1 Copy the FSI Viewer and or FSI Showcase Add on files using an FTP program into the corresponding directory on your web server Please note that all files have to be transferred in binary mode Step 2 Edit the default configuration file default fsi located in the main index of your setup directory using a text editor of your choice The most important modifications are e FPXServerType Enter the type of your imaging server e g erez or ZIS e FPXBase Request base of the imaging server e g http domain erez3 erez src Or http zis domain xcom fif Additionally you can create configuration files for individual images or use HTTP queries to access different images Please refer to the chapter Automated Implementation of Images if you plan to integrate a large number of images Step 3 Add the HTML source for a Flash movie to your website and enter the path to the file fsi swf with the desired parameters as a HTTP query for the parameter Movie object tag and Src embed tag lt PARAM NAME movie VALUE f
41. Default 2 Context lt Options gt Version 2 3 0 or higher To enable effective caching of image data FSI Viewer does not load image data for every level of magnification Instead FSI Viewer uses dynamic zoom levels to determine when to load image data and when to scale the image by software By modifying this value you can define the frequency of zoom levels Please do not change this value unless you are certain that this is necessary and you are aware of possible consequences Defining higher values will instruct FSI Viewer to load image data more frequently This decreases the number of cache hits and increases data traffic On the other hand higher values increase image quality as software image scaling will be reduced Defining smaller values increases cache hits and decreases the data traffic volume Lower values might lead to reduced image quality though Possible Values are integer or floating point number greater or equal to 1 Level 4 Mag 300 Level 3 Mag 200 96 Level 2 Mag 150 96 magi ificatior E Level 1 magnificat Mag 100 ES me by Software by soitwar Magnification The figure above displays a zoom level frequency of 2 46 NeptuneLabs FSI Viewer Configuration NeptuneLabs FSI Viewer Virtual 3D Presentations In addition to zoomable 2D images FSI Viewer can as well be used to display virtual 3D presentations of an object In this case the source image must contain multiple ima
42. FPXSrc image fpx amp FPXTilesx 4 amp FPXTilesY 3 width 320 height 300 bgcolor FFFFFF template lt OBJECT classid clsid D27CDB6E AE6D 11cf 96B8 444553540000 codebase http download macromedia com pub shockwave cabs flash swf lash cab version 5 0 42 0 width width height height gt lt PARAM NAME movie VALUE fsi_url gt lt PARAM NAME bgcolor VA UE bgcolor gt lt PARAM NAME menu VALUE false gt lt EMBED TYPE application x shockwave flash PLUGINSPAGE http www macromedia com shockwave download index cgi P 1 H lt c sal rs eal a Prod Version ShockwaveFlashN SRC fsi_url WIDTH width EIGHT height BGCOLOR bgcolor MENU false gt lt EMBED gt EIERE echo template BODY HTML NeptuneLabs FSI Viewer 57 Plug ins NeptuneLabs FSI Viewer Plug ins FSI Plug ins dynamically extend the functionality of FSI Viewer and can be included at runtime Plug ins are available from version 2 0 Depending on the plug in additional buttons might be added to the menu bar The sequence of these buttons can be defined by the sequence of the plug in definitions inside the lt Plugins gt section of the configuration file Using Plug ins To include a plug in you simply list the desired plug ins in the lt Plugins gt section of any fsi configurat
43. I Viewer 125 Plug in Reference To release the button previously pressed use FSIViewer SetVariable FSICMD En Identifying commands of buttons not listed below There might be some button identifiers that are not listed below especially buttons integrated by other plug ins To obtain command identifiers of these buttons follow the steps below 1 Activate the debug window of the FSI viewer set parameter debug to 2 Set the explore parameter of the jsBridge plug in to true 3 Click the desired button inside FSI Viewer and copy the identifier from the debug window ButtonID Description empty string Release previously pressed button Mouse Mode o Activate mouse mode n 0 Zoom 1 Pan 2 Rotate 3D 3 Rotate Z axis There might be more mouse modes available depending on loaded plug ins Tool_ Reset Reset button see command Reset Tool_ZoomIn Zoom In button see command ZoomIn Tool ZoomOut Zoom Out button see command ZoomOut Tool SwitchUI Show Hide FSI Viewer user interface Plugin SwitchMusic Toggle music on or off Plugin ExtendedNavigation Toggle display of ExtendedNavigation plug in Plugin HistoryBack Click History Back button of the history plug in Plugin HistoryForward Click History Forward button of the history plug in 126 NeptuneLabs FSI Viewer Plug in Reference
44. P query the value of the effects parameter has to be provided as an url escaped string e g 9026 instead of amp and 3D instead Oo si swf effects quality 3D65 26sharpen 3D30 In general FSI Viewer passes the value of the effects parameter through to the imaging server This is you can pass through all parameters supported by your imaging server valid for static images using the effects parameter For example with eRez imaging server you can force the use of a real time template by passing the tmp parameter lt effects value tmp fsi2 gt Applying Effects to Specific Images Only While the effects parameter holds image manipulation parameters for all images you can as well apply effects to specific types of images in FSI Viewer see NavEffects SceneEffects and TileEffects For example it is sometimes useful to sharpen the images inside the survey window as small images tend to appear a little blurry To do so you can add a corresponding NavEffects parameter Sharpening Images in the survey window lt NavEffects value sharpen 35 gt eRez Imaging Server lt NavEffects value ftr 5 gt Iseemedia Zoom Image Server 42 NeptuneLabs FSI Viewer Configuration NavEffects Description Image manipulation parameters applied to the survey window Syntax String Default B Context Options Version 3 1 1 or higher Applies image manipulation effects
45. Set rotate around the x axis to the left 3D only RotateRight rotate around the z axis to the right 3D only RotateLeft rotate around the z axis to the left 3D only ZoomIn zoom in ZoomOut zoom out InitialActionDelay Description Speed of the initial action Syntax Number Default 3 Context Options Specifies the speed of the action specified by the InitialAction parameter Possible values are integer values greater than O 0 highest speed zl slower 20 NeptuneLabs FSI Viewer Configuration InitialActionPersistent Description Repetition of initial action Syntax Bool Default false Context lt Options gt Version 2 2 0 or higher Initial action restarts on each reset command button or keyboard if set to true Otherwise the action only performs on startup HelpURL Description URL of custom help page Syntax String Default http help fsi viewer com Context lt Options gt Version 1 3 0 or higher If you want to create a custom help page for your FSI Viewer enter the complete absolute URL to this page using this parameters HelpURLTarget Description Target frame for custom help page Syntax String Default _blank Context lt Options gt Version 1 3 0 or higher Using this parameter you can define the target name of the browser window if a user opens the help pag
46. The optional small survey window above left displays the position of the image section currently viewed Menu Bar VER AD d z xli E fa e Q g 100 The menu bar might look different depending on skins or additional plug ins O 11 NeptuneLabs FSI Viewer Using FSI Viewer Main Functions Back to Initial View Undoes zoom pan and rotation and restores the initial view identical with space bar Zoom Out Mouse Modes The Mousemodes or MousemodeSelect plug in is required to display the following mouse mode buttons D Mouse Zoom In Choose this function to enlarge segments using the mouse Click on the image and drag the frame over the desired segment Alternatively you can click on the image without marking a segment The image will then be magnified in steps To zoom out in steps hold down the CTRL key and click on the image Mouse Pan Choose this functions to pan the image using the mouse Click on the image and drag in the desired direction To return to the original view hold down the CTRL key and click on the image Mouse Turn Choose this function to rotate the image around the z axis Click on the image and drag in whatever direction you want to turn the object to the right or the left To reset the rotation hold down the CTRL key and click on the image Mouse Rotate only for 3D presentations Choose this function to rotate the object around the y axis
47. XSrc parameter from your data source After collecting the image specific data from your data source you have to build a standard HTTP query string RFC1738 containing the data using server side scripting Using HTTP Queries NeptuneLabs FSI Viewer 55 Plug ins Example Generating FSI queries fetch_fpx_image php Retrieve FPX properties for picture 1 from table FPX Images result mysql query select FPXSrc FPXHeight FPXWidth TilesX TilesY from FPX Images where PictureID 1 SEET Fetch SQL data fpx parameter mysql fetch assoc result if fpx parameter RFC1738 parameter encoding foreach fpx parameter as fpx key gt S fpx val query collection fpx key rawurlencode fpx val Make one large query string fsi_query implode amp Squery collection Add Query to FSI Viewer URL fsi url fsi swf fsi query 3 Creating the HTML Code dynamically Create a variable that contains the object and embed tag with all variables provided as script variables Replace all variables inside the template using server side scripting You will usually need to replace the following 4 variables URL 2 Creating image specific URLs Width Height Background Color 56 NeptuneLabs FSI Viewer Plug ins Example HTML Template lt HTML gt lt BODY gt lt php include fetch_fpx_image php fsi url fsi fsi swf
48. Y Description Initial Y position in pixel Syntax Number Default 0 Context Plug in Tag Initial vertical position of the control in pixels relative to the top left corner of the viewer NeptuneLabs FSI Viewer 101 Plug in Reference NeptuneLabs FSI Viewer Plug in Plug in Software Cursor Plug in Target t Fm t F 1 User interface Q rat HGH n Plug in Location plugins softwarecursor plg Function Adds a software cursor to the FSI Viewer Syntax Plugin src softwarecursor The Software Cursor plug in adds a software cursor representing the current mouse mode Zoom Drag Rotate 2D Rotate 3D Plug in parameters No parameters available 102 NeptuneLabs FSI Viewer Plug in Reference NeptuneLabs FSI Viewer Plug in Plug in MouseWheel Plug in Target User interface Plug in Location plugins mousewheel plg Function Adds mouse wheel support to FSI Viewer Zoom Rotate Syntax Plugin src mousewheel gt Requirements MSIE 6 0 JavaScript The MouseWheel plug in enables the user to scroll or rotate an image using the mouse wheel Implementing MouseWheel support 1 Add a class attribute of value FSIViewer to all FSI Viewer Object tags E g object class FSIViewer classid gt 2 the following javascript to your HTML source JavaScript MouseWheel lt script type text javascript gt See FSIViewers new Array function W
49. ail images Syntax Number Default 100 Context Showcase plug in node or HTTP query prefixed with showcase Scale of thumbnails in percent e g 150 for 150 of the original size The user can additionally scale the thumbnails by clicking the corresponding buttons in the drag bar menu Please note that this value does not change the dimension of thumbnails being retrieved from the server see ImageWidth and ImageHeight Layout Description Defines the way FSI Showcase integrates into the viewer Syntax outside inside or floating Default outside Context Showcase plug in node or HTTP query prefixed with showcase e Outside default The showcase occupies the entire height or width of the viewer instance shrinking the viewer size by the initial size of the thumbnail bar The thumbnail bar will be placed above all viewer elements when enlarging the thumb bar by default e Inside The showcase reduces the view port of the viewer by the initial size of the thumbnail bar leaving the menu elements unchanged The thumbnail bar will be placed below all viewer elements when enlarging the thumb bar by default NeptuneLabs FSI Viewer 69 FSI Showcase Add on e Floating The showcase floats above the view port without modifying the viewer nor the view port size The thumbnail bar will be placed below all viewer elements when enlarging the thumb bar by default
50. ails inside the thumbnail bar Syntax Pixel Default 0 Context Showcase plug in node or HTTP query prefixed with showcase_ This value defines the right padding of thumbnails inside the thumbnail bar of the showcase Please see the Showcase measurements figures for details 82 NeptuneLabs FSI Viewer FSI Showcase Add on HoverZoom Description Zoom thumbnails onMouseOver Syntax Number Default 100 disabled Context Showcase plug in node or HTTP query prefixed with showcase_ Zoom thumbnails when the user points at a thumbnail The default value is 100 no effect Possible values are 100 no effect to 250 HoverRotation Description Rotate thumbnails onMouseOver Syntax Number Default 0 disabled Context Showcase plug in node or HTTP query prefixed with showcase Rotate thumbnails when the user points at a thumbnail The default value is 0 no effect Possible values are 0 degree to 360 degree The following parameters can be used to customize the text displayed on the thumbnails LabelTextSize Description Text size of the thumbnail labels Syntax Pixel Default 0 no text Context Showcase plug in node or HTTP query prefixed with showcase Text size in pixel for the text presented below the thumbnail image Use 0 to disable text and positive values e g 8 to enable texts on the
51. alse Context lt Options gt The first and the last scene set will be considered ending points E g for rotations lt 360 NeptuneLabs FSI Viewer 51 Configuration NoSceneLoop Description No 360 rotation around the x axis 3D Syntax Bool Default false Context lt Options gt The first and last scene in the each scene set will be considered ending points E g for rotations lt 360 52 NeptuneLabs FSI Viewer Debug Mode NeptuneLabs FSI Viewer Debug Mode Enabling the Debug Mode The debug mode can be enabled or disabled by passing the Debug parameter either by HTTP query or inside an XML configuration file Use debug 1 to enable the debug mode and debug 0 or omit the debug parameter to disable the debug mode To disable the debug mode permanently you can safely delete the debug directory of your FSI setup directory Using the Debug Window In debug mode an output window is available FSI Viewer Debug Window presenting information about the initialization FSI Viewer 3 0 0 progress configuration parameters plug ins and hawker quen c image information Reading Image Configuration ok Loading Skin and FSI Module You can select different debug sections by poss NR clicking the corresponding tab at the bottom of eM T BEDS the window Please review Config section Loading 6 Plug in s ok Init complete The window c
52. an additionally select a scene set using the keys and in the num block or using the mouse mode rotate moving the mouse vertically If the TilesX or TilesY parameters are defined for a source image but no scene set is defined a scene set containing all the scenes from left to right top to bottom will be created by default Referring to Figure B this would be SceneSets value 1 24 As the presentation of Figure B consists of 6 by 4 individual images while 8 images represent a complete rotation around the Y axis the definition of the following 3 scene sets is required Image Tiles Y Axis X Axis 1 8 0 to 360 15 9 16 0 to 360 0 17 24 0 to 360 15 The required configuration to rotate the object around the Y axis moving the mouse horizontally and rotating the object around the X axis moving the mouse vertically looks like this Example Configuration for a 3D view as displayed in Figure B lt FPX gt lt TilesX value 6 gt lt TilesY value 4 gt lt FPX gt lt Options gt lt SceneSets value 1 8 9 16 17 24 gt lt Options gt Please refer to the description of the SceneSets parameter for details on the different ways of defining images contained in a scene set Tip If you are not sure about the number of images in your source image in the x and y direction firstly enter the value 1 for TilesX and TilesY In the viewer you will then see the
53. an be moved by dragging the window title bar and you can show or hide the window by pressing d Enabling the debug mode additionally prevents the browser from caching FSI configuration files This allows you to easily test changes to your FSI configuration files without having to delete the browser cache each time General section Displays general information about the initialization progress If the viewer does not display an image you should be able to track the error cause by determining the step where the initialization process stops For example if the last output is Loading Skin and Module the skin file is most likely missing or corrupt Config section Displays information on the configuration parsing process the resulting configuration and possible configuration errors NeptuneLabs FSI Viewer 53 Debug Mode If the viewer loads successfully but the configuration does not look as expected you should be able to track the reason in this section This section lists all recognized parameters resulting from the 3 different configuration methods default configuration configuration file and query and displays tips regarding false parameter values as well as unknown parameters Plug ins section Displays information on loaded FSI Plug ins and configuration errors related to plug ins Info section Displays version information general information related to the viewer instance and information on the image being
54. and values Only parameters in these groups will be recognized by FSI Viewer but configuration files do not need to contain all groups Each parameter has to be provided as an individual XML child node of a group where the node name is the parameter name and the parameter value is the attribute value of the node Structure of XML configuration files fsi parameter Viewer lt parameter value lt Viewer gt lt FPX gt lt parameter value gt lt FPX gt lt Plugins gt lt parameter value gt lt Plugins gt lt Options gt lt parameter value gt lt Options gt lt fsi_parameter gt Example Simple XML configuration file e g named foo fsi fsi parameter lt FPX gt Src value image fpx gt FPX Options Debug value 1 lt Options gt lt fsi_parameter gt Please keep in mind the following rules when using XML configuration files e Values must be written in quotation marks e Configuration files might be cached by your browser so that changes in these files require flushing the browser cache This does not apply when using the debug mode NeptuneLabs FSI Viewer 21 O Configuration You can comment on or disable sections of XML configuration files using the following comment syntax Example comments lt FPX gt lt p Abele Alls age oemimenmit e s Src value image fpx lt The followin
55. artup Syntax Number Default 0 Context Showcase plug in node or HTTP query prefixed with showcase_ Setting the value to 0 makes the showcase load thumbnails on demand Setting positive values enables the pre loader which loads all images on startup The given value specifies the number of images to preload simultaneously Please note Be careful when activating this option especially with automatically generated image lists or large image lists as it might cause higher server loads and increased and possibly unnecessary network traffic 85 NeptuneLabs FSI Viewer Plug in Reference Plug in Reference NeptuneLabs FSI Viewer Plug in Plug in Mousemodes Plug in Target A eg t User interface iQ i C gt Plug in Location plugins mousemodes plg Function Integrates buttons into the menu bar to select the mouse mode Syntax Plugin src mousemodes gt The Mousemodes plug in provides 3 buttons 2D images or 4 buttons 3D presentations to select the current mouse mode Plug in Parameters MenuOffset Description Indentation of the menu buttons Syntax Number Default 0 Context Plug in Tag Specifies the space in pixel left of the menu button s of the plug in Mode n Description Removes the button for mouse mode 7 from the menu bar Syntax Bool Default Context Plug in Tag Provides the possibility to hide speci
56. ase plug in node or HTTP query prefixed with showcase_ This value defines the margin in pixel from the right of the thumbnail bar to the content and scrollbar of the thumbnail bar of the showcase Please see the Showcase measurements figures for details 81 NeptuneLabs FSI Viewer FSI Showcase Add on PaddingTop Description Padding of thumbnails inside the thumbnail bar Syntax Pixel Default 0 Context Showcase plug in node or HTTP query prefixed with showcase_ This value defines the top padding of thumbnails inside the thumbnail bar of the showcase Please see the Showcase measurements figures for details PaddingBottom Description Padding of thumbnails inside the thumbnail bar Syntax Pixel Default 0 Context Showcase plug in node or HTTP query prefixed with showcase_ This value defines the bottom padding of thumbnails inside the thumbnail bar of the showcase Please see the Showcase measurements figures for details PaddingLeft Description Padding of thumbnails inside the thumbnail bar Syntax Pixel Default 0 Context Showcase plug in node or HTTP query prefixed with showcase_ This value defines the left padding of thumbnails inside the thumbnail bar of the showcase Please see the Showcase measurements figures for details PaddingRight Description Padding of thumbn
57. ault base path to all configuration files using the FSIBase parameter Example Defining a configuration file lt PARAM NAME movie VALUE fsi swf cfg foobar In this case the FSI Viewer first searches for the default fsi file in the installation folder where the file fsi swf is located and evaluates the configuration parameters The optional parameter FSIBase from the default fsi file is then used as the path specification in order to search in the correct index for a FSI configuration file with the name foobar fsi DefaultCFG Description Relative path to an alternate default configuration file Syntax fsi swf cfg filename Default default Context HTTP query only Relative path to an alternate default configuration file other than default fsi Only useful as part of an HTTP query The file extension fsi has to be omitted NeptuneLabs FSI Viewer 2 Configuration ServerType Description Image Server type Syntax String eRez ZIS TrueSpectra TrueSpectra Bridge Default Context lt FPX gt Query FPXServerType Please enter the value erez for YaWah eRez Imaging Server For the Zoom Image Server of iSeeMedia please enter the value ZIS For the Image Server of TrueSpectra please enter the value TrueSpectra if you are using the stand alone server and TrueSpectra Bridge if you are using the TrueSpectra
58. cape before displaying this parameter 130 NeptuneLabs FSI Viewer Plug in Reference JSBridge Plug in Parameters Explore Description Activate debug output of Button IDs Syntax Boolean Default false Context Plug in attribute If enabled the debug window will display the Button ID of each button pressed inside FSI Viewer This way you are able to determine Button IDs not listed in this documentation Additionally the debug window will output each command received by the JSBridge plug in Callback Description Enable JavaScript callbacks Syntax Boolean Default false Context Plug in attribute If enabled the events of FSI Viewer FSI Showcase will be forwarded to a specific JavaScript function Please refer to the section Implementing JavaScript Callbacks for details ImageUrls Description Provide ImageUrl templates with JavaScript callbacks Syntax Boolean Default false Context Plug in attribute This parameter depends on the Callback parameter above If Callback and ImageUrls parameter have been set to true ImageUrl notifications providing image URL templates will be sent to the JavaScript callback function Please refer to the ImageUrl callback identifier for details NeptuneLabs FSI Viewer 131 Plug in Reference NeptuneLabs FSI Viewer Plug in Plug in Measure Plug in Target
59. ded if you plan to display large numbers of images Automated Implementation of Images In the simplest case you only define the relative path to a configuration file within the src parameter of the object Tag using the cfg parameter Example Defining the CFG parameter inside the object tag lt PARAM NAME movie VALUE fsi swf cfg relative path to FSI file gt In general FSI parameters may contain the following value types Type Example Number 90 String ZoomIn URL http www fsi viewer com Boolean either 0 1 or true false HexColor FF0000 Using XML Configuration Files fsi Configuration files have to be created in XML format and can easily be edited with any text editor The default configuration file default fsi which is located in the same folder as the main viewer file fsi swf is the most important XML configuration file and will always be evaluated first To use FSI Viewer with additional image specific configuration files you have to provide the name of the configuration file using the cfg parameter attached to the URL of the fsi swf file Example Specifying an XML configuration file for FSI Viewer lt PARAM name Movie VALUE fsi fsi swf cfg foo 20 NeptuneLabs FSI Viewer Configuration Configuration files are structured into configuration groups XML nodes containing parameter names
60. displayed Two pieces of information displayed here can be especially useful when implementing FSI Viewer into websites e Image Section Displays a string representing the current image section that can be used for the InitialView parameter and when defining hot spots for the HotSpot plug in Please refer to the InitialView parameter for an explanation of the string format Press i to refresh the image section being displayed after zooming panning or rotating the image e Viewer Size matching Image Size Displays an alternate viewer size exactly matching the image dimension The values are based on the current width and height of the viewer If you choose one of the proposed viewer sizes the image will cover the entire view port Debugging load errors When enabling the debug mode FSI Viewer outputs error information if problems retrieving images from the imaging server occur Please note that this feature requires the imaging server to reside in the same domain as FSI Viewer or using Flash plug in version 7 together with a valid crossdomain xml file copied to the servers root directory 54 NeptuneLabs FSI Viewer Plug ins NeptuneLabs FSI Viewer Automated Implementation of Images Rather than creating individual configuration files for each image it is recommended to provide FSI parameters via HTTP queries appended to the FSI Viewer URL when implementing large numbers of images As some browsers require the obsol
61. e The default value _blank opens a new browser window InitialMouseMode Description Mouse mode on startup Syntax Number Default 0 Context lt Options gt Specifies the selected mouse mode on startup Possible values 0 Zoom 1 Pan NeptuneLabs FSI Viewer 37 Configuration 2 Rotate 3D 3 Rotate 2D Some plug ins provides additional mouse modes Please refer to the corresponding plug in reference for details HandCursor Description Shape of the mouse cursor Syntax Bool Default true Context lt Options gt Flash Version No effect with Flash versions prior to version 6 If you set this parameter to true the default arrow cursor will be used instead of the hand cursor when hovering over the image or the survey window ZoomLimit Description Maximum magnification Syntax Number Default 100 Context lt Options gt Defines the maximum magnification in percent relative to the source image The default value 100 permits magnification to the physical resolution of the source image Possible values are 1 to 1000 ZoomLimitMin Description Minimum magnification Syntax Number Default 100 Context lt Options gt Defines the minimum magnification in percent relative to the initial image The default value 100 permits magnification to the size of the Viewer Smaller
62. e You may have several profiles i e if you use watermarking or different imaging servers ZoomCache5Only Description Only use ZoomCache with Flash 5 plug ins Syntax Bool Default false Context lt Options gt Use ZoomCache only for Flash Plug ins version 5 IgnoreQuery Description Ignore all parameters passed via query except cfg Syntax Bool Default false Context lt Options gt Version 2 0 0 or higher If this parameter is activated the viewer ignores all parameters passed via HTTP query except for the cfg parameter This way you can disable modification of FSI configuration by query MaxZoomLevel Description Load image details at maximum zoom Syntax Boolean Default True Context lt Options gt Version 3 2 1 or higher By default FSI Viewer adds a zoom level for the maximum magnification this is FSI Viewer loads image details when reaching the maximum magnification For extremely high resolution 2D images exceeding 32 000 pixel in width or height you can set this value to false to prevent display problems at the maximum magnification 44 NeptuneLabs FSI Viewer Configuration TileSizeX and TileSizeY Description Size of image detail tiles Syntax Number in pixel or in percent of the viewer size Default 50 Context lt Options gt Version 2 3 0 or higher
63. e values range from 0 to 100 0 transparent 100 opaque 106 NeptuneLabs FSI Viewer Plug in Reference Size Description Size of progress indicator Syntax Number Default 60 Context Plug in Tag Defines the overall size of the progress indicator in pixel Color1 Description Color of the area representing the amount of pending data Syntax HexColor Default 000000 Context Plug in attributes A 6 digit hexadecimal number defining the color of the area representing the amount pending data Color2 Description Color of the area representing the amount of data already loaded Syntax HexColor Default FFFFFF Context Plug in attributes A 6 digit hexadecimal number defining the color of the area representing the amount data already loaded LineColor Description Line color Syntax HexColor Default 000000 Context Plug in attribute A 6 digit hexadecimal number defining the color of the lines NeptuneLabs FSI Viewer 107 Plug in Reference TextColor Description Text color Syntax HexColor Default 000000 Context Plug in attribute A 6 digit hexadecimal number defining the color of the text posX Description Horizontal Position Syntax String Number Default Depends on MenuAlign parameter Context Plug in attribute Def
64. elected language DetailBuffer Description Enable or disable the detail buffer Syntax Boolean Default true Context lt Options gt Version 3 0 0 and above Enabling the detail buffer keeps previously loaded image details visible when zooming in or out instead of displaying the low resolution preview image while loading additional image details This way zoom transitions appear smoother NeptuneLabs FSI Viewer 27 Configuration NoNav Description Hide the survey window Syntax Bool Default false Context lt Options gt Show or hide the survey window displaying the miniature image and the current image section NavWidth and NavHeight Description Maximum size of the survey window Syntax Number in percent or pixel Default 80 Context lt Options gt Version 3 0 0 and above Defines the maximum width and height of the image inside the survey window The value can be defined absolutely or in percent of the viewer size Use parameter NoNav to hide the survey window NavFrame Description Show the selection frame of the survey window Syntax Boolean Default true Context lt Options gt Version 3 0 0 and above Specifies whether to show true or hide false the selection frame of the survey window NavFrameColor Description Color of the selection frame
65. election requires plug in SelectFrame Measure A string representing the current measurement requires plug in Measure NeptuneLabs FSI Viewer 99 Plug in Reference NeptuneLabs FSI Viewer Plug in Plug in NavExtension Plug in Target User interface A Plug in Location 4 b plugins navextension plg v 4 Function Additional navigation control Syntax Plugin src navextension visible true The NavExtension plug in adds a dragable navigation control to the FSI Viewer user interface that can be hidden and shown with a corresponding button in the menu bar The control automatically adds buttons for Scenes and scene sets depending on the image configuration Plug in Parameters MenuOffset Description Indentation of the menu button Syntax Number Default 0 Context Plug in attributes Specifies the space in pixel left of the menu button of the plug in Visible Description Initial display state Syntax Bool Default false Context Plug in attribute Defines the initial visibility state of the control 100 NeptuneLabs FSI Viewer Plug in Reference X Description Initial X position in pixel Syntax Number Default 0 Context Plug in Tag Initial horizontal position of the control in pixels relative to the top left corner of the viewer
66. en using JSBridge plug in or FSI Viewer Component 136 NeptuneLabs FSI Viewer Plug in Reference The following events apply to this plug in Event ID Parameter Description onMeasureEnable Boolean The measure tool gets enabled or disabled onMeasureStart String The user starts measuring The parameter provides the current distance and angle as displayed in the measure tool onMeasure String The user drags the measure tool The parameter provides the current distance and angle as displayed in the measure tool onMeasureStop String The user stopped measuring The parameter provides the current distance and angle as displayed in the measure tool NeptuneLabs FSI Viewer 137 Plug in Reference NeptuneLabs FSI Viewer Plug in Plug in SelectFrame Plug in Target 1 6 033196178 User interface 0 21943717 0 46821367 0 31171482 0 m Selection View Plug in Location plugins selectframe plg Function Provides a resizable select frame Syntax Plugin src selectframe This plug in adds a resizable select frame into FSI Viewer Pressing SHIFT locks the aspect ratio of the selection Pressing CTRL resizes the selection relative to the center Pressing ALT rotates the selection Pressing ALT SHIFT rotates the selection in steps of 5 deg
67. entire source image structure 46 NeptuneLabs FSI Viewer Configuration 3D Parameters The following FSI configuration parameters apply to virtual 3D presentations only TilesX and TilesY Description Number of individual images for 3D presentations Syntax Number Default 1 Context lt FPX gt Query FPXTilesX and FPXTilesY Number of individual images contained in the source image in x and y direction respectively Example 3D image containing 6 Nes x 4 tiles arranged in 3 scene sets 4T Rd WX FOR ud Es CG Ka ts A 4 a 7 8 left the number of tiles would be 6 in the x direction and 4 in the y 7 6 1 Even with asymmetrical scene 1 orders like in the example to the A direction HN T 7 3 LIT I 19 20 22 2 uu 24 Example Definition of 3 scene sets containing 6 x 4 24 tiles lt FPX gt TilesX value 6 gt lt TilesY value 4 FPX Options lt SceneSets value 1 8 9 16 17 24 lt Options gt NeptuneLabs FSI Viewer 49 Configuration SceneSets Description Scene sequence definition 3D Syntax String Default 1 n tiles Context lt Options gt Using this parameter you can define scene sets for images containing multiple scenes TilesX TilesY Scene sets define the order of scenes to be displayed The default
68. er plug in FSI Viewer requests image data from Single Source Imaging Servers Using FSI Viewer you can present two dimensional images as well as three dimensional presentations consisting of multiple individual images By using Single Source Imaging Servers only one high resolution source image is required for each image to be displayed By using the Macromedia Flash plug in FSI Viewer and FSI Showcase Add on can be integrated almost independently of the browser version As today the penetration of this plug in exceeds 95 of all internet users FSI products can usually be used without downloading or setting up a browser plug in By means of a large number of configuration options and optional FSI Skins FSI Viewer and FSI Showcase Add on can widely be adjusted to integrate seamlessly into your website Using the FSI Plug in system you can integrate additional functionality into FSI Viewer at runtime without increasing the download size in general Thank you for using NeptuneLabs software WWW fsi viewer com Online Resources for FSI Viewer Please be sure to visit www fsi viewer com for software updates regularly updated samples tutorials and downloads To access restricted areas on the website you can use the username and password that came with your licensed copy of FSI Viewer NeptuneLabs FSI Viewer 9 Introduction Compatibility and System Requirements Imaging Servers FSI products covered by this manual can at presen
69. essage Opening FPX Please check the given path to the source image file on the imaging server Adjust the parameters FPXSrc or FPXBase accordingly Error Viewer stops displaying the message Loading Plug in Please check the Src parameter of the specified plug in Make sure that the corresponding plug in file exists in the plugins subdirectory of your setup directory of your web server NeptuneLabs FSI Viewer 143 Error Messages Error The image appears entirely black or distorted This might happen due to an error during the conversion of your image to the FPX format Please make sure that the source image has not been saved in grayscale mode and that it does not contain multiple alpha channels Be sure to save the image without FPX data compression Please try converting your image to RGB color mode and remove all alpha channels prior to FPX conversion Error The Viewer displays multiple images at a time You might be using an FPX containing multiple images without defining the parameters TilesX and TilesY or these parameters have been defined incorrectly Please check the output of the Debug Window for the scene sets setting Error The Viewer displays a clipped image You might have defined the parameters TilesX and TilesY for a 2D image Or The parameters ViewerWidth and ViewerHeight do not match the corresponding settings in the lt object gt or lt embed gt tag using Flash plug in version 5
70. ete lt embed gt tag queries have to be added to both the lt object gt and the lt embed gt tag HTML Source Code FSI Viewer is able to request image specific parameters like the source image dimension parameters FPXWidth and FPXHeight from your imaging server Retrieving Parameters Automatically Using this feature reduces the required work to dynamically providing the path to the source image parameter FPXSrc It is recommended to use server side script like ASP PHP JSP Perl etc when implementing large numbers of images All subsequent code examples in this section refer to PHP but can be easily adapted in any other server side scripting language Steps to be taken when using large numbers of images 1 Defining default parameters Be sure to provide as many recurring parameters as possible in the default fsi file This way you don t have to pass these parameters via query The most important parameter is FPXBase as this parameter enables you to subsequently define FPXSrc parameters using relative addressing If there are some images that require different parameter values than defined in the default fsi file you can still overwrite the default setting by passing the value via query 2 Creating image specific URLs Be sure to have image specific data available for server scripting by using a database your content management system or any other appropriate source You will at least need to provide the FP
71. evious custom buttons Syntax Number in pixel Default 0 Context Plug in Tag Specifies an offset for the button named ID in pixel to previous custom buttons ID Url Description Url to open on click Syntax String Default Context Plug in Tag Specifies an URL to open when the user clicks the button named ID You can specify a URL to a web page or alternatively a script call eg javascript void alert foo Please note You can use templates to be replaced by FSI Viewer at runtime The button appears disabled if no URL is specified ID Frame Description HTML frame to open the specified URL in Syntax String Default self Context Plug in Tag Specifies the HTML frame to open the specified Url in for the button named ID Besides using an identifier of a frame inside your HTML frame set you can as well use one of the predefined values se1 top blank or parent ID ToolTip Description Tool tip text Syntax String Default Context Plug in Tag Specifies the tool tip to be displayed when the user places the cursor above the custom button named ID NeptuneLabs FSI Viewer 97 Plug in Reference ID LabelFrame Description Symbol displayed on the button Syntax Number Default 1 Context Plug in Tag Specifies the symbol to be disp
72. f the source image 90 NeptuneLabs FSI Viewer Plug in Reference NeptuneLabs FSI Viewer Plug in Plug in Max Zoom Plug in Target F Je r User interface X og 11 Plug in Location plugins maxzoom plg Function Zoom to physical resolution of the image Syntax Plugin src maxzoom The MaxZoom plug in expands the user interface by a button to quickly zoom to the physical resolution of the source image Plug in Parameters MenuOffset Description Indentation of the menu button Syntax Number Default 0 Context Plug in attribute Specifies the space in pixel left of the menu button of the plug in 921 NeptuneLabs FSI Viewer Plug in Reference NeptuneLabs FSI Viewer Plug in Plug in History Plug in Target History inal History Forward User interface Vemm a ei iQ vin Q KA Vieusar Plug in Location plugins history plg Function History functionality to jump to previously viewed image sections Syntax Plugin src history length 25 gt The History plug in extends the user interface by 2 buttons History Back and History Forward Using these two buttons the user is able to navigate through image sections previously viewed Plug in Parameters MenuOffset Description Indentation of the menu buttons Syntax Number Default 0 Context Plug in Tag Specifies the space in pixel left of the menu b
73. ffix 20inches Example 2 If you know the width of a part of the image but you do not know the width of the entire image you should follow the steps below 1 Add the measure plug in without any parameters Plugin src measure gt 2 Open the image inside the FSI Viewer and choose the Measure mouse mode 3 Measure the part of the image you know the real width of The Measure plug in will display a decimal number 7 between 0 and 1 4 The value w for the ImageWidth parameter is w RealWidth n 0 91388889 The Measure plug in displays n 0 91388889 The real length Z of the engine is 214 5 mm ImageWidth w L n 214 5 0 91388889 234 7112459 The corresponding plug in tag is the following lt plugin src measure ImageWidth 234 7112459 Suffix mm gt NeptuneLabs FSI Viewer 133 Plug in Reference Please note You might as well define all plug in parameters via query or inside the lt options gt group by using the prefix measure E g cfg engine amp Measure ImageWidth 234 7112459 amp Measure Suffix 20mm Accuracy The plug in does not support any perspective correction This means that measuring scanned maps diagrams will be accurate measuring 3 dimensional objects is less accurate Plug in Parameters The following attributes can be assigned to the plugin tag You might as well define all plug in parameters via query or inside the options gr
74. fic mouse mode buttons 86 NeptuneLabs FSI Viewer Plug in Reference Example Remove Drag Button lt Plugin src mousemodes Model false gt The example above shows how to hide the button for mouse mode 1 Drag Mode n Mouse Mode Moden Qj Zoom Modei Drag Mode2 Rotate X Y Axis 9 Mode3 v Rotate Z Axis NeptuneLabs FSI Viewer 87 Plug in Reference NeptuneLabs FSI Viewer Plug in Plug in Mousemode Select Plug in Target E User interface m Q Plug in Location LIFES 3 gt Cy WI QO plugins mousemodeselect plg Function Integrates a button and a dropdown menu into the menu bar to select the mouse mode Syntax lt Plugin src mousemodeselect gt The Mousemode Select plug in adds a button and a dropdown menu to the menu bar to select the mouse mode Some plug ins e g plug in Measure add additional mouse mode buttons to the V menu bar If you include these plug ins after including the MouseModes plug in these additional buttons will be added to the MouseModeSelect submenu Plug in Parameters MenuOffset Description Indentation of the menu button Syntax Number Default 0 Context Plug in Tag Specifies the space in pixel left of the menu button of the plug in Mode 7 Description Removes the button for mouse mode 7 from the menu Syntax Bool Default Se
75. g section will be ignored rc Src value image fpx FPX Using HTTP Queries In addition to using XML configuration files you can define FSI parameters by adding a HTTP query to the URL of the FSI Viewer movie clip Parameters have to be provided in the following form Parameter1 Value1 amp Parameter2 Valuez2 Characters that are not URL compatible such as and amp within the values have to be URL encoded Example Providing parameters by HTTP query lt OBJECT classid clsid D27CDB6E AE6D 11cf 96B8 444553540000 codebase http download macromedia com pub shockwave cabs flash swfl ash cab version 5 0 42 0 width 320 height 240 gt lt PARAM NAME movie VALUE fsi fsi swf cfg foo amp debug 1 amp MenuAlign TL gt lt OBJECT gt As you cannot define parameter groups when providing FSI parameters by query you have to prefix parameters with the name of the corresponding parameter group Example Prefixing parameters with group names XML Syntax lt FPX gt Src value foo tif gt lt ServerType value eRez gt lt FPX gt Equivalent HTTP Query FPXSrc foo tif amp FPXServerType eRez 22 NeptuneLabs FSI Viewer Configuration As most parameters belong to the options group these parameters do not need to be prefix to keep queries as short as possible Example Providing lt Options gt
76. ges tiles displaying the same object after different steps of rotation The number of horizontal and vertical image tiles must be specified using the parameters TilesX and TilesY Figure A displays a source image containing 12 tiles representing a rotation of 360 around the Y axis in steps of 309 In this case you simple add the parameters TilesX 3 and Tilesy 4 to your FSI configuration aum Be a m Y lj l D 3 la li 5 j o 7 wo o moute KM i ES A ls jJ nm LEEK E 19 20 2l 22 23 24 Fig A Rotation around Y axis in 30 steps Fig B Rotation around Y axis in 45 steps and 3x4 12 tiles partial rotation around X axis in 15 steps 6 x 4 24 tiles in 3 scene sets Example Configuration for a 3D presentation as displayed in Figure A lt FPX gt TilesX value 3 TilesY value 4 FPX Figure B shows a more complex 3D view representing a rotation of 360 around the X axis in 45 steps and an additional rotation of 15 around the Y axis To present rotations around more than one axis or to present an object in different states you need to define 5 Scene Sets 47 NeptuneLabs FSI Viewer Configuration A Scene Set describes a sequence of individual images The user can select individual images of a scene set using the keys 7 or 9 in the num block or using the mouse mode rotate moving the mouse horizontally The user c
77. ging server All FPXSrc parameters containing relative paths without http will be extended by the path defined by FPXbase Examples FPXBase application Definition of FPXBase within the default fsi file lt FPX gt Base value http domain com erez src gt lt FPX gt NeptuneLabs FSI Viewer 31 Configuration Specification of the FPXSrc within configuration files 1 FPXBase parameter is used for relative addressing lt FPX gt lt SRC value folder image tif gt lt FPX gt The resulting address is http domain com erez src folder image tif 2 FPXBase is not used for absolute addressing lt FPX gt lt SRC value http domain com erez src project image tif gt lt FPX gt Width and Height Description Size of the Flash movie clip Syntax Number in pixels Default Context lt Viewer gt Query ViewerWidth and ViewerHeight Width and height of the viewer in pixel These parameters are only necessary for Flash 5 plug ins and must match the width and height parameters in the lt object gt or lt embed gt tag Providing incorrect values leads to skewed or incorrectly scaled presentations of FSI Viewer as far as Flash plug ins version 5 are concerned For Flash MX or higher you can either leave out the parameters or enter auto Border Description Size of the Flash movie cl
78. hat do not occupy the entire width or height of the ken Ca viewer Image 19 Image 20 The chapter Advanced Parameters provides a description of parameters which can be used to resize and or colorize all elements of the thumbnail framework If you just want to change the general color scheme you can use the parameter BaseColor instead You can rescale the thumbnail using the parameter BaseScale Thumbnail Framework Thumbnail Labels ImageMarginX ImageMarginX dech ImageWidth ImageBorder I m a g e ImageMarginY T LabelMarginTop Image ImageHeight Thumb Label LabelTextSize Line two LabelSpaceY J ImageMarginv 1 LabelMarginBottom Thumb Label K LabelSpaceX LabelSpaceX EdgeRadius NeptuneLabs FSI Viewer 65 FSI Showcase Add on Using FSI Showcase and FSI plug ins You can use additional plug ins just like with FSI Viewer There are some rules you should follow when working with additional plug ins e You can not add plug ins dynamically after FSI Showcase loaded You can on the other hand disable plug ins for individual images adding an lt options gt parameter with the name of the plug in to the corresponding lt image gt tags of the image list Example Disabling a plug in inside an lt image gt definition lt Images gt lt Image label No Magnifier gt lt FPX gt lt SRC value image2 fpx gt lt Width value 8096 gt lt Height value 12300 gt FPX
79. heellInit if document all return t document getElementsByTagName object Le ite et oc ounts 0p Orr lengths arte if t i className FSIViewer FSIViewers count t i t i SetVariable CatchMouseWheel false NeptuneLabs FSI Viewer 103 Plug in Reference document onmousewheel function for 1 0 1 lt FSIViewers length i if FSIViewers i GetVariable CatchMouseWheel true FSIViewers i SetVariable WheelDelta vent wheelDelta return false Ve m lt script gt 3 Add the function call WheelInit to the onload event of the body tag E g lt BODY onload WheelInit 4 Add the MouseWheel plug in to your default fsi or image specific fsi file Example Adding the Mousewheel plug in Plugins Plugin src mousewheel Plugins MouseWheel Plug in Parameters You can specify 4 different actions to take place when the user uses the mousewheel Zoom Zoom Default Rotate Rotate Z Axis Scene Rotate Y Axis SceneSet Rotate X Axis Default Description Default mousewheel action Syntax String Default Zoom Context Plug in Tag Defines the default action of the mouse wheel provided that no other action has been defined using the Mode n parameter 104 NeptuneLabs FSI Viewer Plug in Reference lt Plugin src mousewheel default
80. i providing the FSI parameter NoNav with a value of true Please refer to the FSI Viewer manual for a list of all FSI Parameters and for details on how to create a query string that provides FSI parameters SelectImage Description Select another image FSI Showcase only Syntax Number Default Context HotSpot tag Clicking the HotSpot selects another image inside FSI Showcase The index can be specified absolutely by providing a number only The first image is being represented by 0 Alternatively you can select an image relatively from the currently selected image To select an image relatively you have to provide a number prefixed by or e g 1 selects the next image Hotspot Authoring Tips The following section provides tips on how to obtain the string value required to define the Spot and the optional View parameter of a HotSpot The Spot parameter consists of 7 numbers concatenated with commas and provides the scene set the Scene the image section as a rectangle and the rotation Example 1 10 0 19056 0 33579 0 44862 0 59385 35 scene set 1 Scene 10 Rectangle 0 19056 0 33579 0 44862 0 59385 rotation 35 9 Although you can of manually enter the parameters it is recommended to use the plug in 5SelectFrame to obtain this value NeptuneLabs FSI Viewer 121 Plug in Reference Obtaining Hot Spot positions Include the plug in SelectFrame by
81. ieved automatically YaWah eRez Iseemedia True Spectra Imaging Server Imaging Server Imaging Server FPXWidth Yes Yes Yes FPXHeight Yes Yes Yes FPXTilesX Yes IPTC data FPXTilesY Yes IPTC data s SceneSets Yes IPTC data SE When will these values be automatically retrieved FSI Viewer tries to retrieve the parameters FPXWidth and FPXHeight from the server if the values have not been defined manually If the server delivers additional parameters e g FPXTilesX FPXTilesY these parameters will only get effective if they have not been defined manually Requirements for Automatic Parameter Supply 1 Cross Domain Access As Flash movie clips can generally not access data across domain boundaries FSI Viewer has to be setup to the same domain IP address as the imaging server For imaging servers that integrate into common web browsers eRez TrueSpectra Bridge this can easily be accomplished by setting up FSI Viewer to a subdirectory of the web server For imaging servers delivering images through their own server engine the following solutions apply Setting up FSI Viewer to a web server on the same IP as the imaging server using a different port e g port 8080 Using NeptuneLabs ZoomCache to route FSI Viewer requests Setting up FSI Viewer to a subdirectory of the imaging server that is able to deliver standard file types e g servercode of the Iseemedia Imaging server
82. image sharpening blurring Sharpen or tr If no effect is specified the default settings of the server apply Please refer to your imaging server for a list of available parameters Example quality The quality or glt parameter specifies the JPEG compression of images delivered by the imaging server Practical values range from 50 to max 90 Example quality 5 Example quality 90 l Bra lt effects value quality 5 gt effects value quality 90 gt Example sharpen The sharpen or ftr parameter blurs negative values or sharpens positive values images delivered by the imaging server Example sharpen 300 blur Example sharpen 150 effects value sharpen 300 effects value sharpen 150 Other effects change for example the color saturation hue or contrast Please refer to your imaging server documentation for a complete description of available image effect commands NeptuneLabs FSI Viewer 41 Configuration Example saturation 0 Example hue 180 amp cnt 1 4 lt effects value saturation 0 gt lt effects value hue 180 amp cnt 1 4 The format of the effects parameter is similar to a HTTP query You can combine different effects by concatenating the parameter value pairs with an ampersand amp character effects value quality 65 sharpen 30 gt When passing effects by HTT
83. ines the horizontal position of the progress indicator Possible values C Centered horizontally Number gt 0 Offset from left Number lt O Offset from right posY Description Vertical position Syntax String Number Default Depends on MenuAlign parameter Context Plug in attribute Defines the vertical position of the progress indicator Possible values C Centered vertically Number gt O Offset from top Number lt 0 Offset from bottom 108 NeptuneLabs FSI Viewer Plug in Reference NeptuneLabs FSI Viewer Plug in Plug in Music Plug in Target User interface Plug in Location plugins music plg Function Adds streaming background music or sound to the FSI Viewer Syntax lt Plugin src music song music mp3 autoplay true gt Requirements Flash MX or higher The Music plug in adds a background sound or music to FSI Viewer Additionally a button will be added to the menu bar to switch the music on or off Plug in Parameters MenuOffset Description Indentation of the menu button Syntax Number Default 0 Context Plug in attribute Specifies the space in pixel left of the menu button of the plug in AutoPlay Description Start playing the sound on startup Syntax Bool or String Default false Context Plug in attribute Set the value to Bo
84. ion file or the _default fsi file The required plug in files are located in the plugins folder of the FSI setup directory Plug in parameters have to be specified as attributes of the plug in tag Example Using FSI Plug ins fsi parameter Plugins Plugin src mousemodes Plugin src history length 10 Plugins fsi parameter The Src attribute which applies to all plug ins specifies the plug in to be included Src Description Name of the plug in Syntax String Default Context lt Plugins gt Version 2 0 0 or higher This attribute defines the name of the plug in e g history The value has to be stated without the file extension plg Example Using the Src Parameter Plugin src mousemodes MenuOffset 10 gt 58 NeptuneLabs FSI Viewer Plug ins Alternatively you can integrate plug ins by HTTP query using the plugins parameter with a comma separated list of the desired plug ins This option is available from FSI version 3 0 only Example Integrating plug ins using HTTP queries lt PARAM NAME movie VALUE fsi fsi swf plugins mousemodes history gt The example above integrates the plug in mousemodes and the plug in history Deactivating Plug ins To disable previously integrated plug ins e g plug ins defined in the _default fsi file you can set a parameter with the
85. ip Syntax HexColor or false Default Context lt Viewer gt Query ViewerWidth and ViewerHeight Display a thin border around FSI Viewer The default value is False displaying no border Enter one 6 digit hexadecimal color e g FF0000 for a solid border If you specify two hexadecimal colors e g FF0000 OOFFOO the top left border will use the first color while the bottom left border uses the second color 32 NeptuneLabs FSI Viewer Configuration MenuAlign Description Alignment of the menu bar Syntax String Default TL Context lt Options gt Possible values TL top left TR top right BL bottom left BR bottom right Language Description Interface language Syntax String Default english Context lt Options gt Version FSI Viewer 2 0 or higher FSI Showcase 2 15 or higher Defines the language of tool tips for the user interface Possible values depend on the language files located in the sub index languages of the FSI Viewer setup path To specify a language please enter the filename without file extension e g german Some language files contain the pattern font in the filename These files include a corresponding font for the specified language Though the size of these files is greater than those without an embedded font the included font ensures correct display on systems with character sets not matching the s
86. is a single scene set containing all scenes image tiles from scene 1 to the last scene image left to right top to bottom In the viewer scenes can be selected by moving the mouse horizontally and scene sets can be selected by moving the mouse vertically Syntax Individual sets have to be separated with semicolon Scenes within the sets are separated with comma and specify the 1 based index of the image from left to right top to bottom up to the total number of scenes TilesX x TilesY Instead of individual scenes you can also specify scene ranges e g 5 10 If you leave out the start or the finish of a scene range 1 or respectively the last scene will be assumed If you specify a range using gt the scenes from the first number to the last scene image plus the first scene image up to the second number will be assumed Example Definition of multiple scenes and scenesets Options SceneSets value 2 3 5 10 10 1 5 8 gt 3 gt lt Options gt The example defines 4 scene sets in total Assumption The source image is created from 10 individual images scenes 5 in a row two rows This leads to the following image order for the individual scenes Set 1 Scenes 2 3 5 6 7 8 9 10 Set 2 Scenes 10 9 8 7 6 5 4 3 2 1 Set 3 Scenes 5 6 7 8 9 10 Set 4 Scenes 8 9 10 1 2 3 You can review the resulting scene sets in the Info section of the Debug Window 50 NeptuneLabs FSI Viewer
87. layed on top of the custom button named ID The predefined symbols are GFX ID Example 1 1 Information x 2 Close 3 Resize or Restore m 4 Open window ii 5 Print Additionally you can create your own graphics that can be used as a label for custom buttons To create new graphics you have to modify the file custombutton gfx fla located in the plugins directory of your FSI setup directory with Macromedia Flash or any compatible editor Open the file plugins fla custombutton gfx fla in your Flash editor Choose an existing or create a new key frame in the main timeline Add your graphic to Layer 1 GFX Compile save and upload the modified file Use the index of the key frame step 2 as the LabelFrame parameter for your custom button DB e IE Please note o Make sure to upload the modified file properly after editing o You should not modify the Flash file except for adding your custom graphic s o The dimension of your graphics must match your FSI Skin Usually the dimension should not exceed 18 x 18 pixels 98 NeptuneLabs FSI Viewer Plug in Reference Using Templates in URL parameters Starting from FSI version 3 2 3 you can use templates when defining URLs for custom buttons These templates will be replaced by FSI Viewer when the user clicks a custom button This way you can retrieve parameters from FSI Viewer dynamically and pass the values to a JavaScript
88. m 9 ck Rotate around the y axis to the right 3D only Num g Rotate around the x axis upwards 3D only or previous view Num g Rotate around the x axis downwards 3D only or previous view Num 0 CH Hide display user interface D ___ If you have activated the debug mode you can hide or display the debug window using this key Outputs information about the current image segment I and further status information in the debug window e g for InitalView 14 NeptuneLabs FSI Viewer Setup NeptuneLabs FSI Viewer Setup Setting up FSI Viewer is as easy as copying all FSI Viewer files to your web server The only file that will directly be accessed by the web browser is fsi swf located in the main index As the URL to this file is part of each HTML code presenting FSI Viewer it is recommended to keep the path to fsi swf as short as possible by either a Creating a subdirectory for FSI Viewer in the root directory of you web server This way the file can easily be addressed relatively from any location of your website Example HTML code addressing FSI Viewer in root directory lt PARAM name Movie VALUE fsi fsi swf cfg foo gt b Creating a sub domain to access FSI Viewer absolutely Example HTML code addressing FSI Viewer by subdomain lt PARAM name Movie VALUE http fsi domain com fsi swf cfg foo gt Index structure of FSI Viewer Directory
89. mand fsi event params callback function introduced in Step 3 NeptuneLabs FSI Viewer 129 Plug in Reference Detailed Event Parameter Description INFO The Info event parameter provides attributes of the source image currently being displayed Example width 8000 height 6000 TilesxX 4 TilesY 3 SceneSets ImageIndex 4 The attribute ImageIndex applies to FSI Showcase only and provides the 0 based index of the image currently selected ImageURL To receive this notification you have to set the ImageUrls parameter of the plug in to true Please refer to Plug in Parameters below for details The ImageURL event parameter provides an URL template that can be used to retrieve rhe image currently displayed in FSI Viewer Example http imageserver domain erez3 erez src images zoomimage fpx amp width width amp height height amp left 0 amp top 0 amp right 1 amp bottom 1 amp tmp template The URL template can for example be used to set the src attribute of an lt IMG gt tag Prior to using the template you have to replace the place holders bold in brackets with valid values The template place holder applies to eRez imaging servers only ToolTip The ToolTip event parameter provides the tool tip text that is about to be displayed The values depend on the tool tip language selected You have to use the JavaScript function unes
90. mensions Syntax Number in pixels Default Context lt FPX gt Query FPXWidth and FPXHeight Required parameters specifying the width and height of the source image Please refer to the chapter Retrieving Parameters Automatically for information on how to automatically retrieve these values from the imaging server Example Width and height specifications for a source image lt FPX gt Width value 3330 gt Height value 4660 lt FPX gt NeptuneLabs FSI Viewer 29 Configuration Optional Parameters The following parameters do not need to be defined They can be used to alter the appearance of FSI Viewer user interface Skin Description Filename of FSI Skin to use without extension Syntax String Default Context lt Options gt Filename of FSI Skin file to use omit the file extension FSI Skins determine the appearance of the user interface and are located in the subdirectory skins In addition to the default skins that ship with FSI Viewer customized skins are available on demand Please note that using unregistered skins activates the evaluation mode Intro Description Filename of start animation to use without extension Syntax String Default Context lt Options gt Filename of animation to display on startup omit the file extension FSI Viewer ships with a default start animation Cu
91. n 2 means a magnification of 200 and so on The maximum level of magnification is 8 Reflections Description Show or hide glass reflections Syntax Bool Default true Context Plug in attribute Show true or hide false glass reflections of the magnifier 112 NeptuneLabs FSI Viewer Plug in Reference NeptuneLabs FSI Viewer Plug in Plug in HotSpots Plug in Target Show Hide Hotspots User Interface and Zoom Area J e oeh Mem Plug in Location plugins hotspots plg Function By defining clickable areas hotspots the user is able to L interact with the image by clicking on areas inside the zoomable image S M Syntax VW Plugin src hotspots V od x Enterprise editions of FSI Viewer contain this plug in by default For all other editions this plug in can be optionally obtained The HotSpots plug in adds an image map like functionality to the FSI Viewer The plug in adds a button to the menu bar which allows the user to show or hide the HotSpots The clickable areas are defined via XML inside the image specific fsi file and enable an increased interaction with the Viewer There are 4 different combinable actions that can be assigned to each hotspot Display a tool tip Zoom to the area defined by the hotspot Open a HTML page Restart the Viewer with a different image configuration NeptuneLabs FSI Viewer 113 Plug in Refe
92. nan E Nanaonan anian 53 Enabling the Debug MOdGi seio oin i pan e Ee EY oi o HER E a eoe E dae 53 Using the Debug WiIndoOW use eus Va rx ent eo PvE paa aX rx pe v ee ege 53 AUTOMATED IMPLEMENTATION OF IMAGES 55 QR U CLIE cp 58 NeptuneLabs FSI Viewer 5 Contents Using PINGING o gege eet e RM 58 Deactivating PIUG INS EE 59 Pl igesifi Pal atiie ele eege Sen SE a api ege 60 Providing Plug in Parameters by Query eeeeeeennennnnnn 60 FSI SHOWCASE ADD ON 1 orna EREE EE KREE KREE EE enk 61 Integrating FSI e EE 61 Defining Image E 61 Defining the Showcase Layout 64 Using FSI Showcase and FSI plug ins eeeeeeeeereeneeeee 66 Showcase ET 67 Alphabetical Index of FSI Showcase Parameters sssesse 68 Basic ln 69 Imagebist Parameters diio at uvesk eere d eere Serve taa eco ke one tere vasa 74 Advanced Paratmiters sseusssi os pant thx ore ER SEE ape NR pRR CRRA FE SR EXE SREUE Res EXER ER 76 PLUG IN REFERENCE 2 piae ho ener ey Ra EV ees kara SNE Pav Rer RES 86 Plug in le ue niinen ipn Cien nene ERE ubr cv ute ER ba kan 86 Plug in Mousemode Select 1 irons rrr an narrar nra EEN enn nra n 88 Plug in Zoom Meter scs e Lotus Eege 90 Gul e te NEE Ee eu EE 91 PUG SII HISTON EE 92 Pl g It GK 94 lettre rer EE 96 Plug in NavExtension EE 100 Plug in Software CURSOR E 102 Plug in MouseWheel s ssssssrsss
93. nd the thumbnail Enter 0 to disable the border The corresponding parameters for active and selected state are ThumbBorderActiveWidth and ThumbBorderSelectedWidth 78 NeptuneLabs FSI Viewer FSI Showcase Add on ThumbBorderHighlight Description Highlight color of the thumbnail border Syntax HexColor Default Color derived from BaseColor Context Showcase plug in node or HTTP query prefixed with showcase_ Defines the color of the highlighted section of the thumbnail border left and top The corresponding parameters for active and selected state are ThumbBorderActiveHighlight and ThumbBorderSelectedHighlight ThumbBorderShadow Description Shadow color of the thumbnail border Syntax HexColor Default Color derived from BaseColor Context Showcase plug in node or HTTP query prefixed with showcase_ Defines the color of the darkened section of the thumbnail border right and bottom The corresponding parameters for active and selected state are ThumbBorderActiveShadow and ThumbBorderSelectedShadow EdgeRadius Description Radius of rounded thumbnail edges Syntax Pixel Default 6 Context Showcase plug in node or HTTP query prefixed with showcase_ Defines a radius for drawing rounded edges of the thumbnail frame Use 0 for straight edges and positive values for rounded edges NeptuneLabs FSI Viewe
94. ng thumbnail texts LabelSpaceY Description Additional vertical space for thumbnail text Syntax Pixel Default 0 Context Showcase plug in node or HTTP query prefixed with showcase_ You can use this value to increase or decrease the height of the thumbnail text area If you want to use multiple lines of text you can increase the height of the text area by the following rule 84 NeptuneLabs FSI Viewer FSI Showcase Add on LabelSpaceY AddtionalLines x LabelTextSize If the thumbnail text is too long to be displayed in the text area you can either increase this value or enable tool tips parameter ToolTips LabelMarginTop and LabelMarginBottom Description Margin above below the thumbnail text Syntax Pixel Default 0 Context Showcase plug in node or HTTP query prefixed with showcase_ You can use this value to add additional space above LabelMarginTop or below LabelMarginBottom the thumbnail text LabelOffsetTop Description Adjust vertical position of the thumbnail text Syntax Pixel Default 0 Context Showcase plug in node or HTTP query prefixed with showcase_ You can use this value to adjust the vertical position of the text area of the thumbnail Negative values move the text area up while positive values move the text area down PreloadThumbs Description Load all thumbnail images on st
95. olean true to make the sound play on startup From version 1 3 of the plug in you can additionally set the value to onLoad to start the sound after image data has been loaded completely NeptuneLabs FSI Viewer 109 Plug in Reference Song Description Path to an MPEG3 audio file mp3 Syntax URL Default Context Plug in attribute Defines a relative path to an MPEG3 file mp3 located in the music subdirectory of the fsi folder Loop Description Loop Play the sound once Syntax Bool Default false Context Plug in attribute Defines if the sound is being played once or in a continuous loop Volume Description Sound volume Syntax Number 0 100 Default Context Plug in attribute Defines the volume of the sound from 0 quiet to 100 maximum KeepState Description Keep Stop Play state when selecting images Syntax Boolean Default True Context Plug in attribute For viewers with multiple images only Keep the playing state and ignore the AutoPlay parameter when switching from one image to another This way AutoPlay true does not start the sound if the user switched the button off 110 NeptuneLabs FSI Viewer Plug in Reference NeptuneLabs FSI Viewer Plug in Plug in Magnifier Plug in Target User interface Plug in Location plugins magnifier plg
96. olor scheme by defining a BaseColor rather than defining all colors individually To change the overall scale of thumbnails you can use the basic parameter BaseScale Background Description Color of the background of the thumbnail bar Syntax HexColor Default Defined by parameter BaseColor Context Showcase plug in node or HTTP query prefixed with showcase Color of the background of the thumbnail bar BackgroundAlpha Description Opacity of the background of the thumbnail bar Syntax Number Default 100 Context Showcase plug in node or HTTP query prefixed with showcase Defines the opacity of the thumbnail bar background from 0 invisible to 100 opaque ScrollBaseColor Description Base color of the scroll bar Syntax HexColor Default Derived from BaseColor Context Showcase plug in node or HTTP query prefixed with showcase Defines a color for the scroll bar ScrollTrack Description Color of the track bar of the scroll bar Syntax HexColor Default Derived from ScrollBaseColor Context Showcase plug in node or HTTP query prefixed with showcase Defines a color for the track area of the scroll bar 6 NeptuneLabs FSI Viewer FSI Showcase Add on ScrollArrow Description Color of the arrows of the scroll bar Syntax HexColor Default Derived from Sc
97. on 3 2 5 and above Specifies whether the plug in fires plug in events Plug in events can be handled when using JSBridge plug in or FSI Component The following events apply to this plug in Event ID Parameter Description onSelectFrameEnable Boolean The select has been enabled or disabled onSelectFrameStart The user starts selecting onSelectFrame String The user modifies the select frame The parameter provides a string representing the current selection onSelectFrameStop String The user stopped modifying the selection The parameter provides a string representing the current selection 141 NeptuneLabs FSI Viewer Error Messages Error Messages Please make sure to enable the debug mode when encountering errors Usually it is easy to locate the reason for an error by examining the output in the debug window or the step of the initialization process where the FSI Viewer stops Warning NeptuneLabs ZoomCache required for Flash 5 Plug in You may ignore this warning if you plan to use the FSI Viewer with Flash plug ins version 6 and above only To use FSI Viewer with Flash plug ins from version 5 NeptuneLabs ZoomCache is required Warning ViewerWidth and ViewerHeight required You may ignore this warning if you plan to use the FSI Viewer with Flash plug ins version 6 and above only If you plan to use the FSI Viewer with Flash plug ins prior to version 6 you have to adju
98. optional and specify the image segment and the rotation around the z axis Please use the plug in SelectFrame to easily retrieve valid values for this parameter Example InitalView Options SS er Der ergeet Wile Sr OO Om 95 0 Sr XOU ss Options The example displays the above left quarter of the 5th scene in the 1st scene set rotated 90 to the right 33 NeptuneLabs FSI Viewer Configuration Initial ViewPersistent Description Keep the Initial View as default view Syntax Bool Default false Context Options Version 2 0 0 or higher If this parameter is activated clicking the Reset button will display the image section defined by the InitialView parameter instead of the entire image If this parameter is set to false the initial view will be displayed on startup but pressing the Reset button will reset the view to the entire image InitialAction Description Action on startup Syntax String Default Context lt Options gt Specifies an action to execute on startup The action is repeated until the user presses a button or key While the action is being executed no image details are loaded Possible values NextScene rotate around the y axis to the right 3D only PreviousScene rotate around the y axis to the left 3D only NextSceneSet rotate around the x axis to the right 3D only PreviousScene
99. oup by using the prefix measure with the parameter name e g measure ImageWidth MenuOffset Description Indentation of the menu button Syntax Number Default 0 Context Plug in attribute Specifies the space in pixel left of the menu button of the plug in ImageWidth Description Real width of the entire image Syntax Number Default 100 Context Plug in attribute Defines the real width of the entire image e g 120 inches Please see the explanation in the previous section 134 NeptuneLabs FSI Viewer Plug in Reference Prefix Description Defines a prefix for the length value Syntax String Default Context Plug in attribute Defines the prefix for the length value e g length Suffix Description Defines a suffix for the length value Syntax String Default Context Plug in attribute Defines the suffix for the length value e g inches Usually this is a length unit Decimals Description Number of decimals of the length value Syntax Number Default 0 Context Plug in attribute Defines the number of decimals of the length value ShowText Description Display the current measurement string Syntax Bool Default True Context Plug in attribute Hides the text displaying the current measurement if set to false
100. owcase Add on ImageBorderHighlight Description Highlight color of the border around the thumbnail image Syntax HexColor Default Derived from BaseColor Context Showcase plug in node or HTTP query prefixed with showcase Defines the color of the highlighted section of the image border left and top ImageBorderShadow Description Shadow color of the border around the thumbnail image Syntax HexColor Default Derived from BaseColor Context Showcase plug in node or HTTP query prefixed with showcase Defines the color of the darkened section of the image border right and bottom ThumbFace Description Color of the thumbnail face Syntax HexColor or color transition Default Color transition derived from BaseColor Context Showcase plug in node or HTTP query prefixed with showcase Defines the color of the thumb face This value can be either defined as a solid color e g OOFFOO or as a linear color transition from top left to bottom right by entering two color values separated by comma e g FFAA00 OOFFOO The corresponding parameters for active and selected state are ThumbActiveFace and ThumbSelectedFace ThumbBorderWidth Description Thickness of the thumbnail border Syntax Pixel Default 1 Context Showcase plug in node or HTTP query prefixed with showcase Thickness of the border arou
101. parameters by query XML Syntax lt Options gt lt Debug value true gt lt MenuAlign value TL gt lt Options gt HTTP Query equivalent debug true amp MenuAlign TL The FSI parameter reference contains the parameter group a parameter belongs to as well as the long parameter names to be used with HTTP queries Hierarchy of Configuration Parameters As explained before parameters can be provided in three different ways 1 The default configuration file default fsi located in the same folder as the main viewer file fsi swf will always be evaluated 2 You can store image specific parameters in separate fsi files 3 You can provide parameters by HTTP query Parameters specified multiple times for example in the default configuration and by query will be evaluated in the following way e Parameters defined in configuration files supersede parameters defined in the default configuration file default fsi e Parameters provided by query supersede parameters in configuration files Configuration Hierachy I HTTP Query II Configuration file fsi III Default configuration file _default fsi NeptuneLabs FSI Viewer 23 Configuration Choosing a Configuration Method FSI Viewer can be configured by any combination of e Default configuration file _default fsi e Configuration files fsi e HTTP query The following considerations might be helpful when deciding where to
102. place a certain parameter Default Configuration As the default configuration gets cached by the browser and you can easily change global parameters for all images by editing a single file it is the recommended configuration method for e Global parameters valid for all images in particular o FPXServerType o FPXBase o Licence Key e General configuration options like o Plug ins o MenuAlign and alike Configuration Files Separate configuration files can be used for parameters specific to individual images or to a group of images e g flowers fsi cars fsi or SmallView fsi LargeView fsi etc HTTP Query Recommended for parameters from databases or parameters defined by user interaction Using server side script or JavaScript you can build queries to pass parameters to FSI Viewer If you want to display an image with minimal variation in configuration it is recommended to use the same FSI configuration file and to provide varying parameters by HTTP query Example Providing parameters View 1 lt PARAM NAME movie VALUE fsi swf cfg flower View 2 lt PARAM NAME movie VALUE fsi swf cfg flower amp NoNav 1 24 NeptuneLabs FSI Viewer Configuration Retrieving Parameters Automatically Depending on the type of imaging server being accessed FSI Viewer is able to retrieve some image specific parameters automatically The following table shows the parameters that can be retr
103. r 79 FSI Showcase Add on OffsetTop Description Offset from the top of the viewer instance Syntax Pixel Default 0 Context Showcase plug in node or HTTP query prefixed with showcase This value defines the offset from the top of the viewer instance to the top of the thumbnail bar of the showcase Please see the Showcase measurements figures for details OffsetBottom Description Offset from the bottom of the viewer instance Syntax Pixel Default 0 Context Showcase plug in node or HTTP query prefixed with showcase This value defines the offset from the bottom of the viewer instance to the bottom of the thumbnail bar of the showcase Please see the Showcase measurements figures for details OffsetLeft Description Offset from the left of the viewer instance Syntax Pixel Default 0 Context Showcase plug in node or HTTP query prefixed with showcase This value defines the offset from the left of the viewer instance to the left of the thumbnail bar of the showcase Please see the Showcase measurements figures for details OffsetRight Description Offset from the right of the viewer instance Syntax Pixel Default 0 Context Showcase plug in node or HTTP query prefixed with showcase This value defines the offset from the right of the viewer instance to the right of the thumbnail bar of the sho
104. r 0 1 or true false HexColor FFOOFF Color Transition FFOOFF FFFFFF NeptuneLabs FSI Viewer 67 FSI Showcase Add on Alphabetical Index of FSI Showcase Parameters Dieppe i 70 Matgin Top eoi reet dee neret 81 Backoround eiirin anaiai 76 Mimimize nzelect 72 BackoroundAlpha 76 OffsetBottom esee 80 BaSeColof iiidid aiaa 69 Offsetbeft iiti ie nee 80 BaseScale eret ctecdcteteaeedascaezea as 69 OffsetRight ree ees 80 p M 74 Offset Kei DEE 80 Re 71 PaddingBottom cccccceececeeeceeeeeeeeeeees 82 DragMenil 3 cxt rine eere axes 71 baddingol et 82 Edoehadius niisiis anii 79 baddingobioht 82 HoverRotation eene 83 baddingfop aa 82 HOVErZOOM EE 83 breload Tbumbe eese 85 nien 70 el c A A A AS 74 ImageBorderHighlight 78 SCrollAETOW iiec ien ene t EE Endet 77 ImageBorderShadow 78 ScrollBaseColor sssssssssesrrrsrrrrrrrrrnrnnrnernnns 76 ImageBorderWidth sereen 77 Stelle ET 76 ImageHeight uk NEEN 77 oca P ER 75 ImageMarginX een 77 TextOutsideFrame sssssseeeererrrerererernen 72 ImageMarginY uk niii 77 ThumbActiveFace sssessee 78 ImageWidth esses 77 ThumbBorderActiveHighlight 79 InitialImage ira ries 72 ThumbBorderActiveShadow 79 InitialSiz6 5
105. r higher Syntax lt Plugin src resize MaxWidth 800 MaxHeight 600 gt Using the resize plug in you can define the viewer dimension in percent of your HTML document After resizing the plug in rearranges the user interface according to the size of the object tag without reloading the entire viewer instance and without the need for client side scripting Plug in Parameters MaxWidth and MaxHeight Description Maximum width and height Syntax Number in pixel Default Context Plug in Tag FSI Viewer can not be resized to a dimension greater than specified by these values MinWidth and MinHeight Description Minimum width and height Syntax Number in pixel Default Context Plug in Tag FSI Viewer can not be resized to a dimension smaller than specified by these values 94 NeptuneLabs FSI Viewer Plug in Reference EnlargeBy Description Resize viewer in steps of 7 pixels Syntax Number Default 1 Context Plug in tag Specifies the steps FSI Viewer will be resized by Entering 1 means that the viewer resizes exactly according to the size of the object tag Entering greater numbers forces the viewer to resize by the number of pixel specified Using values 1 increases the chance of imaging server cache hits and might thus reduce server load NeptuneLabs FSI Viewer 95 Plug in Reference NeptuneLabs FSI Vie
106. rees Plug in Parameters The following attributes can be assigned to the plugin tag You might as well define all plug in parameters via query or inside the options group by using the prefix measure with the parameter name e g selectframe window MenuOffset Description Indentation of the menu button Syntax Number Default 0 Context Plug in attribute Specifies the space in pixel left of the menu button of the plug in 136 NeptuneLabs FSI Viewer Plug in Reference Visible Description Show or hide the plug in on startup Syntax Boolean Default False Context Plug in attribute Show or hide the select box on startup Window Description Show or hide the output window Syntax Boolean Default True Context Plug in attribute Show or hide the output window of the plug in Rotate Description Enable rotation of the selection Syntax Boolean Default True Context Plug in attribute Enable rotating the selection by pressing ALT key or ALT SHIFT keys and dragging the handles of the select box MaskColor Description Color of the mask Syntax HexColor Default FFFFFF Context Plug in attribute Define a 6 digit hexadecimal color value for the mask of the select box MaskAlpha Description Opacity of the mask Syntax Number Defa
107. rence Adding Hotspot Functionality to your Images Integrating the Plug in To integrate the HotSpot plug in into the viewer you have to add the following line to the Plugins section of either the default fsi file or to an image specific fsi configuration file Plugin src hotspots gt Defining the HotSpots Section To define HotSpots for an image you have to add an XML section to your image specific fsi file The definition syntax is similar to image maps for static images inside a HTML page Each HotSpot is being defined by a single XML node inside the lt HotSpots gt group The basic structure of a HotSpot definition is the following Example HotSpot definition lt HotSpots visible true alpha 70 gt KGulmcike isi qa ioe 7s lt rect spoe UU tip url gt lt HotSpots gt In contrast to other main groups like e g FPX you can assign attributes to the HotSpot group itself Most of these attributes define the default behavior of all included HotSpots so that you can omit these attributes in subsequent HotSpot nodes 114 NeptuneLabs FSI Viewer Plug in Reference Global HotSpot Parameters The attributes you can assign to the lt HotSpots gt group tag include Visible Description Initial visibility of the HotSpots Syntax Bool Default false Context lt HotSpots gt group tag Defines the initial visibility of HotSpots The HotSpot button
108. rollBaseColor Context Showcase plug in node or HTTP query prefixed with showcase Defines a color for the arrows on the buttons of the scroll bar Please note that the same color will be used for the button labels of the drag bar menu ImageWidth and ImageHeight Description Dimension of thumbnail images Syntax Pixel Default 45 Context Showcase plug in node or HTTP query prefixed with showcase Defines the maximum physical dimension of thumbnail images in pixel The actual size of thumbnail images depends on the aspect ratio of an image ImageMarginX and ImageMarginY Description Space around thumbnail image Syntax Pixel Default 0 Context Showcase plug in node or HTTP query prefixed with showcase Space between image border and thumbnail border left right of the image ImageMarginX and above below the image ImageMarginY If you choose round edges parameter EdgeRadius this value will automatically be increased if required to ensure that the image does not overlap the thumbnail edge ImageBorderWidth Description Thickness of the border around the thumbnail image Syntax Pixel Default 1 Context Showcase plug in node or HTTP query prefixed with showcase Defines the thickness of the border around the thumbnail image Setting this parameter to 0 disables the image border NeptuneLabs FSI Viewer FSI Sh
109. rsararesareranarenannrnnrsnnnansnaranenanerennsennne 103 PIUG INSCIOCKPFOGI OSS oi iixpasses ii pae uk uo RE and e E 106 Pl g Ini TEE 109 Te Ste We Ell TEE 111 eTo IAR eene 113 Plug in JavaScript Bridge EE 123 Pl gsin Medsul e tege EE 132 Plug in SelectFrame ssssessssrsrsssnsananosarenanaronannrnnrsnnnansnaranenanerennsennne 138 ERROR ME Eeer ere Ed 142 APPENDIX deeg gefeelt cowGiacsnctinatetesdeivens 145 NOESEN EE ee 149 6 NeptuneLabs FSI Viewer Contents Alphabetical Index of FSI Viewer Parameters ANIMAU EE 39 EI UE 33 AnimationSpeed sek KENNEN EEN 39 MaxZoombLevel eene 44 O e E E E DR 27 MenuAlign E 33 ConcurrentRequests ENN 45 W Gute CG 43 Debug steet geed e 30 W e EE 34 De PAUIECEG ccc iniii iania 27 NavbrameColor 34 Detailbutter AAA 33 NavHeight EE 34 Effects E 40 NavMaskaAlpha eren 35 ExtendedViewport eeeeee 39 NavMaskcColor eeeeeeeee 35 EPXBAS6 oci v ddr vete nied 31 NavWidth iioii tee t Sere 34 EPXbeight 4 diete rhetor esa oigo Ee petere 29 NoImageBlend esee 40 FPXServerTemplate eee 28 Mel LEE 34 FPXServerType occicece eiie nennt eti nni 28 NoSceneAnimation sssssesserrrrrerrrrneerrrees 51 EPXSIG 5 2 roov REESE e RR RR REDE EY 28 NoSceneLoop eeeenneeenm n 52 FPXTilePaddingX esessssss 51 Noe opp tere
110. s el 31 Clock Progress ess 106 HandCursor ctn ets 38 HISTO i eeu cree eva v nacho nne vence 92 laf 29 32 HotSpot enses tne ennt 113 HelpURL riae nn 37 KI re e E 123 HelpUrlTarget AAA 37 ole IT 111 HideU ERES 40 S I c PE 132 IgnoreQuery eene 44 Mouse Mode Select 88 InitalView eese 35 Mouse Modes uk EEN 86 InitialAction uk 36 Mousewheel eene 103 InitialActionDelay uk 36 MUSIC osr HER 109 InitialActionPersistent 37 Nav Extension 100 InitialMouseMode eee 37 btc 94 96 InitialViewPersistent 36 SelectFrame eeeeeeenn nnne 138 jugo sistas ered LP 30 Software Cursor eeeenennne 102 Language e nee nete 33 ZOOM Meter Aiaran e etre 90 MaxZoombLevel eeeeeeseeeee 44 TE E 86 149 NeptuneLabs FSI Viewer Relative Addressing 29 Survey window 13 33 34 35 ROtatiOn sc 3 2 eres re ene HERR RE 12 14 Thumbnail Effects eeeeesssss 73 ies 50 51 144 ViewerBorder enne 32 150 NeptuneLabs FSI Viewer FSI Viewer FSI Showcase Flash based Single Source Image Viewer NeptuneLabs GbR P O B 1207 32818 Blomberg Germany Fon 49 0 5236 888559 Fax 49
111. sections Basic Parameters and Advanced Parameters This section describes general layout considerations and measures Parameter Layout Shrinks the size of the Shrinks the size of the Floats above the viewer viewer by the initial size image view port by the without modifying the of the thumbnail bar initial size of the viewer or image size thumbnail bar Parameter Align The figures above show the alignment with Layout set to Outside and MenuAlign set to BL Bottom Left You can achieve various layouts by modifying the 2 Showcase parameters Layout and Align and the Viewer parameter MenuAlign In addition to the layout parameters explained above you can define Offsets Margins and Paddings for each side of the Showcase If you use the Inside or Floating layout you will most likely have to define an offset to avoid parts of the Showcase being hidden below the menu bar 64 NeptuneLabs FSI Viewer FSI Showcase Add on The actual values depend on the FSI Skin being used The figure to the right illustrates the parameters OffsetTop MarginTop and PaddingTop The values for the right left and bottom side can be set accordingly Padding e Use Offset to offset the entire thumbnail bar e Use Margin to offset the scroll bar and thumbnails e Use Padding to offset the thumbnails en ey Image 9 Image 10 Tip Using Offset values you can define small thumbnail bars t
112. si swf cfg foo amp debug 1 Please use the files in the samples folder of the installation archive as a guide line 16 NeptuneLabs FSI Viewer Setup Licensing You can use FSI Viewer without a valid licence key for evaluation purposes In this case the phrase Evaluation Copy appears on top of the image and the about box displays Unregistered Evaluation Copy in the Licensed to section After purchasing an FSI Viewer licence you will receive a licence key that removes the Evaluation Copy mark and your name appears in the licensed to section of the about box Entering the Licence Key After receiving your licence key you need to add the key to your default fsi file located in the main index of your FSI Viewer setup directory Open the file default fsi using a text editor of your choice Copy the licence key you received Paste the licence key encapsulated in a Licence tag Save the modified file ee E Example Licence key added to the default fsi file fsi parameter licence Licence key goes here licence fsi parameter Make sure to flush your browser cache as the default fsi file might have been cached by your browser Please note that setting up FSI Viewer on additional domains or using unregistered FSI Plug ins or FSI Skins might activate the evaluation mode despite of the licence key you entered NeptuneLabs FSI Viewer 17 Setup
113. st or add the FSI parameters ViewerWidth and ViewerHeight according to the dimension of the lt object gt and lt embed gt tag Error FSI Viewer does not show up at all Please check the parameters of the lt object gt and lt embed gt tag Make sure that the HTML code lt PARAM NAME movie VALUE URL and parameter gt contains the correct URL to the FSI Viewer file fsi swf Please make sure to have Flash plug in 5 or above installed Please make sure that all required files have been transferred in binary mode to your web server If not adjust the corresponding configuration options of your FTP client accordingly and upload all FSI Viewer files once again 142 NeptuneLabs FSI Viewer Error Messages Error Loading default fsi failed Please make sure that the file default fsi resides in the setup directory of your FSI Viewer Check the default fsi file for XML syntax errors Error Loading fsi failed Or Error FPXSrc undefined Please make sure that the configuration file defined by the CFG parameter is valid Please make sure that the FSIBase parameter in the default fsi file points to the correct directory Please check the XML syntax of the corresponding FSI file Error The Viewer stops displaying the message Loading Skin and FSI Module Please make sure that all files have been uploaded to the location provided when ordering your FSI product Error The Viewer stops displaying the m
114. stom intros are available on demand Please note that using an unregistered intro activates the evaluation mode Debug Description Activate debug mode Syntax Bool Default false Context lt Options gt Activate the debug mode providing configuration details warnings and error messages It is strongly recommended to activate the debug mode when implementing new images with FSI Viewer Please refer to the chapter Debug Mode for a detailed description 30 NeptuneLabs FSI Viewer Configuration FSIBase Description Path to FSI configuration files Syntax Relative path Default Context lt Options gt _default fsi only Enter the relative path from FSI Viewer to the image specific configuration files here If this parameter is specified the path is added to all relative CFG parameters Example 1 Definition of FSIBase in the _default fsi file lt Options gt lt FSIBase value config gt lt Options gt Example 2 Specifying FSI files using the CFG parameter lt OBYECR 42 5 lt PARAM NAME movie VALUE fsi fsi swf CFG imagedir imagel gt lt OBJECT gt The content of the parameter CFG will be extended by the parameter FSIBase to config imagedir imagel fsi Base Description Image Server URL Syntax URL Default Context lt FPX gt Domain and path to the ima
115. t be securely run with eRez Imaging Server from version 2 54 iseeMedia Zoom Image Server from version 4 and TrueSpectra version 4 1 1 Macromedia Flash FSI Viewer requires a Flash Plug in version 5 or newer for the display in browsers If you are using Flash 5 NeptuneLabs ZoomCache is required to output the zoom images This does not apply to eRez Imaging Server which supports Flash 5 plug ins without ZoomCache To run FSI Showcase Add on Flash version 6 or newer is required FSI Viewer has been successfully tested with the following software versions YaWah eRez Imaging Server 2 5 4 3 1 0 iSeeMedia ZoomImageServer 4 0 4 6 TrueSpectra Image Server 4 1 1 Service Patch 3 Flash Plug in 5 0 42 0 to 7 0 19 0 The presentation of FSI Viewer may marginally vary depending on the operating system If problems arise please check the versions mentioned above and enquire about newer versions of the FSI products if necessary 10 NeptuneLabs FSI Viewer Using FSI Viewer Using FSI Viewer FSI Viewer is navigated by the menu bar above and by using Vi V e A the mouse directly on the image For example you can 9 f e 2 2 En Qi e 100 directly select a section of the image you want to magnify The mouse functions are determined by the Drag corresponding buttons on the menu bar zoom pan rotate etc H The example to the left shows the mouse mode zoom
116. t on active and selected thumbnails 72 NeptuneLabs FSI Viewer FSI Showcase Add on Thumb Effects Description Image manipulation parameters applied to thumbnail images Syntax String Default Context Options Version 3 1 1 or higher Applies image manipulation effects like sharpen or quality to all thumbnail images Please refer to the FSI Viewer effects parameter for a detailed description NeptuneLabs FSI Viewer 73 FSI Showcase Add on ImageList Parameters If you are using eRez imaging server version 3 or above with FSI Showcase you can additionally use automatically generated showcase configuration files for a specific directory on the server or according to a search query The generated showcase configuration contains all required data listing images in alphabetical order To modify showcase parameters e g ThumbWidth you can pass the parameters by HTTP query attached to the Showcase URL FSI Parameters Experienced users might additionally edit the server template files used to generate the image list The corresponding file is located in the WEB INF templates fsi directory of your eRez imaging server Filename Description image list xml Creates the Images section of the Showcase configuration The following parameters have to be passed to the Showcase in order to use automatic showcase configurations
117. t rere ee 51 FPXTilePaddingY ssssss 51 Scene Effects iison iiie tei eati 43 EPXTileSX de E EE Donec 49 ScenePreload eeeeenennnnene 51 ix a eR 49 Seene Sets EN 50 NAU EE 29 SKM EE 30 ETag eege eege EN TileEffects oin iniia Dem ed 43 HandCursor eene 38 THESIZOX E 45 HelpUtl geg ege Er Eee eene ts 37 THESIZOY e 45 Helo IR Target ssssesesssssseererrerrrerrrreerree 37 UISwitchable eeeeeeeeeeeeee 40 HideUT oe ee ER Donec eed 40 ViewerBorder eene 32 IgnoreQuery etiatn 44 Viewertleioht esee 32 InitialAction eene 36 ViewerVWidth kk 32 InitialACtionDelay c cccsceceeesssesssseseeeeeees 36 ZOOMCACHE uertit ieee 43 InitialActionPersistent 37 ZoomCache5Only eene 44 InitialMouseMode eere 37 ZoomCachelD eeeeee nennen 44 InitialView necem 35 ZoomLevelFrequency eeeeees 46 InitialViewPersistent 36 Beie Tu 38 Iro 30 Zoom mim EEN 38 7 NeptuneLabs FSI Viewer Introduction NeptuneLabs FSI Viewer Introduction FSI Viewer Flash based Single Source Image Viewer and FSI Showcase Add on have been designed to display high resolution images on the internet requiring low bandwidth only Using the Macromedia Flash brows
118. te sesto eta ree bins 20 NoGcenehnimation sssssessesersrerrrrerernnn 51 Installation uk NEEN ENNEN 15 NoGcenel oop EEN 52 Keyboatd wires eis cite Gian ened 14 NoSetL00p 5 ie roit riter xav cbe tuuc 51 Meri bar Juana 11 SceneFffects eee 43 Mouse cursor em 38 ScenePreload eeeeeennnnene 51 Mouse Modes eeeeennn mne 12 SceneSets urine 50 51 144 Navigation eeeenn irie 11 Gerver Template A 28 Object Tag nce in eerste standin 18 S rverType ui coitus tree rere Create Das 28 Parameter SKI niece opere ecu oed oet erede 30 Animation 39 KI 28 58 Animationtpeed uk 39 UU Ce CHEN 43 Cfg vicina rende edi e nett ee mr 27 TileSiZeX ir etr ner ce n nnn nnne 45 ConcurrentRequests ss 45 TIESA T 49 144 RT EE 14 30 RUE SE 49 144 DefaultCFG ti heroe rone 27 UlISwitchable eere 40 DetailBuffer eeeeeeenne 33 WIth ic iesus Loren GEERT ort es 29 32 Effectes ceto tct iste eripe 40 Kee L 43 ExtendedViewport ss 39 ZoomCacheb5Only NN 44 EPXBaSS6 3 einer eee E 31 ZOOMCACHEID REENEN 44 FPXServerTemplate 28 Zoomleveltreouency 46 FPXServerType eeeeeeeennnnennn 28 Ee eil BIEN 38 EPXSIC arraig ETAS 28 143 ZOOMLIMICMIN EE 38 FPXTilePaddingX AAA 51 Plugin Reference eeseeeees 86 FPXTilePaddingY AN 51 Plugin
119. ting the FSICMD variable of the FSI Viewer movie clip using the SetVariable function Example Button Zoom In MSIE lt input type button value Zoom In onMouseDown document all fsiviewer SetVariable FSICMD Veo p Ww onMouseUp document all fsiviewer SetVariable FSICMD Y gt Command Parameters There are 3 different command types you can pass to FSI Viewer FSI Showcase 1 Initiate an action directly e g ZoomIn or Reset 2 Press and release of FSI Viewer buttons e g Button Mouse Mode 0 3 Zoom to a specified image section e g Goto 1 6 0 4 0 2 0 6 0 4 Please see the Obtaining Image Section Parameters section for details on how to obtain valid image section parameters The following tables list possible values you can pass to FSI Viewer Please note that especially regarding the Button command there might be more or not all commands listed available depending on your FSI Viewer skin and integrated plug ins All command strings have to be provided exactly as stated in the lists below especially regarding upper lowercase writing and white spaces 1 Direct Commands Usage FSIViewer SetVariable FSICMD command To stop the initiated action use FSIViewer SetVariable FSICMD ii 124 NeptuneLabs FSI Viewer Plug in Reference Command Description empty string Stop current action
120. ts that do not contain the Move attribute DefaultSkew Description Permit skewing of HotSpots Syntax Bool Default true Context lt HotSpots gt tag Defines the default value for all subsequent HotSpots that do not contain the Skew attribute DefaultColor Description Default color of HotSpot borders Syntax String Default FF0000 Context lt HotSpots gt tag Defines the default color of HotSpot borders The value has to be a 6 digit hexadecimal number like FFFFOO for yellow or 0000FF for blue 116 NeptuneLabs FSI Viewer Plug in Reference DefaultFill Description Fill the HotSpot area by default Syntax Bool Default true Context lt HotSpots gt group tag Defines the default value for all subsequent HotSpots that do not contain the Fill attribute If this value is set to false all HotSpots will by shown as outlines by default Defining Individual HotSpots Each HotSpot definition must at least contain the name of the HotSpot shape and the Spot attribute which defines the position of the HotSpot The tag name of each definition specifies the shape of the HotSpot Possible shapes are rect Square Rectangle circle Circle Ellipse star Star Example HotSpot definition lt HotSpots visible true DefaultTarget blank BaseURL http Domain gt xcrrcele9spot Vl 110595942 Um 859 99
121. ugins jsbridge plg Function Integrates a JavaScript interface to enable interaction between FSI Viewer and JavaScript contained in the hosting HTML page Syntax Plugin src jsbridge gt Requirements Browser with live connect support between Flash and JavaScript Livewire This plug in can be optionally obtained Using the plug in without a valid licence key activates the evaluation mode The JavaScript Bridge plug in provides a scripting interface to control FSI Viewer using JavaScript Using the JavaScript bridge you can control viewer functions like ZoomIn and Reset you can remotely press release Buttons inside the FSI Viewer and you can zoom to specified image sections directly Additionally you can implement a JavaScript function receiving FSI event notifications Though the integration of the plug in is very easy basic knowledge of JavaScript is required to use JSBridge plug in especially regarding browser dependent JavaScript implementations Implementing the JavaScript Bridge plug in 1 Add an ID attribute to your FSI Viewer Object and Embed tag E g lt object id fsiviewer classid gt lt embed NAME fsiviewer gt This way you are able to access the viewer object via Javascript NeptuneLabs FSI Viewer 123 Plug in Reference 2 Provide the appropriate action via SetVariable command To control the FSI Viewer from JavaScript you have to pass the appropriate command by set
122. ult 75 Context Plug in attribute Defines the opacity of the mask of the select box 0 invisible NeptuneLabs FSI Viewer 139 Plug in Reference AspectRatio Description Aspect ratio of the selection Syntax String Default Context Plug in attribute Defines an aspect ratio for the selection e g 320 200 Use SHIFT to lock or unlock the aspect ratio when resizing the selection InvertShift Description Inverts the function of the SHIFT key Syntax Boolean Default False Context Plug in attribute You can use this parameter to invert the function of the SHIFT key while dragging Callback Description JavaScript callback function Syntax String Default Context Plug in attribute Specify the name of a custom JavaScript function to call each time the selection changes The arguments passed to this function are e SceneSet Scene Left Top Right Bottom Rotation Current View Example JavaScript callback function function onSelect s doSomething it Scene I Ep x loy wot Stiewilew 4 Additionally you can as use the template selections s for the CustomButton plug in 140 NeptuneLabs FSI Viewer Plug in Reference Events Description Fire plug in events Syntax Boolean Default False Context Plug in attribute Versi
123. utton s of the plug in Length Description Length of the history list Syntax Number Default 10 Context Plug in tag The number of image sections that will be stored in the view history from 1 to 99 If the list exceeds the amount of entries defined by the length parameter the first entry of the list will be replaced 92 NeptuneLabs FSI Viewer Plug in Reference Loop Description Loop the history list Syntax Bool Default false Context Plug in tag If this value is set to true the viewer will display the first viewed section when exceeding the last entry of the history and the last entry when stepping before the first entry of the history list Providing the default value false the history will not be looped this is the history list stops at the first and the last position SmallButtons Description Size of menu buttons Syntax Bool Default true Context Plug in tag If this value is set to false the buttons of this plug in will be displayed in the default button size Otherwise the buttons appear slightly smaller than other buttons NeptuneLabs FSI Viewer 93 Plug in Reference NeptuneLabs FSI Viewer Plug in Plug in Resize Plug in Target User interface Plug in Location plugins resize plg Function Rearranges user interface elements after resizing the viewer Requirements Flash MX o
124. vaScript function to your HTML page receiving the event notifications via FSCommand like in the example below IMPORTANT The function name has to be exactly like in the example below and it has to start with the ID NAME parameter specified in step 2 If you do not use the ID NAME fsiviewer you have to replace the corresponding script sections in the example below printed bold by your ID NAME parameter Example JavaScript Callback Function script language javascript type text javascript function fsiviewer DoFSCommand fsi event params switch fsi event case LoadProgress break Hook for Internet Explorer if navigator appName amp amp navigator appName indexOf Microsoft 1 amp amp navigator userAgent indexOf Windows 1 E navigator userAgent indexOf Windows 3 1 1 document write lt SCRIPT LANGUAGE VBScript gt Mn document write on error resume next n document write Sub fsiviewer FSCommand ByVal fsi event ByVal params n document write call fsiviewer DoFSCommand fsi event params n document write end sub n document write lt SCRIPT gt n lt script gt 128 NeptuneLabs FSI Viewer Plug in Reference After following the 3 steps described before you will receive the following event notifications Event Parameter Description fsi_event params
125. wcase Please see the Showcase measurements figures for details 80 NeptuneLabs FSI Viewer FSI Showcase Add on MarginTop Description Margin from the top of the thumbnail bar Syntax Pixel Default 0 Context Showcase plug in node or HTTP query prefixed with showcase_ This value defines the margin in pixel from the top of the thumbnail bar to the content and scrollbar of the thumbnail bar of the showcase Please see the Showcase measurements figures for details MarginBottom Description Margin from the bottom of the thumbnail bar Syntax Pixel Default 0 Context Showcase plug in node or HTTP query prefixed with showcase_ This value defines the margin in pixel from the bottom of the thumbnail bar to the content and scrollbar of the thumbnail bar of the showcase Please see the Showcase measurements figures for details MarginLeft Description Margin from the left of the thumbnail bar Syntax Pixel Default 0 Context Showcase plug in node or HTTP query prefixed with showcase_ This value defines the margin in pixel from the left of the thumbnail bar to the content and scrollbar of the thumbnail bar of the showcase Please see the Showcase measurements figures for details MarginRight Description Margin from the Right of the thumbnail bar Syntax Pixel Default 0 Context Showc
126. wer Plug in Plug in CustomButton Plug in Target Custom Button 1 User interface Custom Button 2 Plug in Location ae plugins custombutton plg 2j t EJ AO Function Adds custom buttons to the menu bar Syntax Plugin src CustomButton buttons btnl btn2 The CustomButton plug in can be used to integrate one or more custom buttons into the menu bar of FSI viewer Clicking a button invokes the URL specified in the plug in parameter This way you can integrate buttons performing a JavaScript call or opening up a web page Plug in Parameters MenuOffset Description Offset in pixel to previous menu elements Syntax Number in pixel Default 0 Context Plug in Tag Defines an offset of all custom buttons in pixels to elements of the menu bar Buttons Description Comma separated list of unique identifiers Syntax String Default Context Plug in Tag Enter a list of unique identifiers separated by commas Each identifier represents a new button that can be configured using the parameters below E g btni btn2 adds two custom buttons To specify parameters for these buttons you have to prefix the parameters by the unique identifier plus e g btnl Uri defines the Url to use for the button named btn 96 NeptuneLabs FSI Viewer Plug in Reference ID offset Description Offset of the button in pixels to pr
127. yntax Bool Default false Context HotSpot tag Zoom to the image section covered by the HotSpot if the user clicks the HotSpot You can use the DefaultMove parameter to change the default behavior Skew Description Allow skewing of the HotSpot area Syntax Bool Default false Context HotSpot tag If this parameter is set to false the width of the hotspot area will equal the height of the HotSpot regardless of the values provided with the Spot parameter You might want to use this parameter to ensure that e g HotSpots defined with the circle tag look like circles instead of ellipses You can use the DefaultSkew parameter to change the default behavior Color Description Color of the HotSpot border Syntax String Default FF0000 Context HotSpot tag Defines the color of the HotSpot border The value has to be a 6 digit hexadecimal number like FFFFOO for yellow or 0000FF for blue You can use the DefaultColor parameter to change the default border color Fill Description Fill the HotSpot area Syntax Bool Default false Context HotSpot tag If this value is set to false the HotSpot will by shown as an outline You can use the DefaultFill parameter to change the default behavior NeptuneLabs FSI Viewer 119 Plug in Reference URL Description Hyperlink of the HotSpot Syntax

NeptuneLabs Document

Contents

Download Pdf Manuals

Related Search

Related Contents