1. Manuals
  2. Brands
  3. NeptuneLabs Manuals
  4. Portable Multimedia Player
  5. FSI Viewer JS
  6. User manual

NeptuneLabs FSI Viewer JS User Manual

Hide thumbs
1
2
Table Of Contents
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
Table of Contents

Advertisement

Quick Links

Download this manual
FSI VIEWER
Let your website visitors have a closer look
User Manual
Version 2017

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the FSI Viewer JS and is the answer not in the manual?

Questions and answers

Summary of Contents for NeptuneLabs FSI Viewer JS

  • Page 1 FSI VIEWER Let your website visitors have a closer look User Manual Version 2017...
  • Page 2 February 2017 FSI TouchZoom 17.02 FSI Viewer JS 17.02 FSI Pages JS 17.02 FSI ImageFlow 17.02 FSI QuickZoom 17.02 Manual Revision All brands and product names are trademarks or registered trademarks of the respective producers. FSI Viewer, FSI Server and NeptuneLabs are registered trademarks of NeptuneLabs GmbH, Germany.

  • Page 3: Table Of Contents

    2.2.1 The Menu Bar 2.2.2 Mouse Modes 2.2.3 Additional Buttons 2.2.4 Using the navigator window 2.3 Index structure of FSI Viewer JS 2.4 Configuration 2.4.1 Using XML Configuration Files (*.xml) 2.4.2 Hierarchy of Configuration Parameters 2.4.3 Retrieving Parameters from FSI Server 2.4.4 Using Custom Language Files...
  • Page 4 5 FSI ImageFlow 5.1 How it works 5.2 FSI ImageFlow Parameters 5.3 Embedding the viewer at runtime via JavaScript 5.4 JavaScript Interface 6 FSI Showcase JS 7 FSI Pages JS 7.1 How it works 7.2 Usage 7.2.1 Defining Image Collections 7.2.2 Aspect Ratio of the Pages 7.2.3 Printing Pages 7.2.4 Special URL Values 7.2.5 FSI Pages JS Presets in FSI Server Interface "Publish to Web"...
  • Page 5 8.10.5 Configuration Files 8.10.6 Passing Parameters by HTTP Query 8.10.7 Retrieving Parameters from Imaging Servers 8.10.8 Parameters 8.10.9 Applying Effects to Specific Images Only 8.10.10 Using Custom Language Files 8.11 Virtual 360° Presentations 8.11.1 Parameters for Virtual 360° Presentations 8.12 Debug Mode 8.12.1 Enabling the Debug Mode 8.12.2 Using the Debug Window 8.13 Automated Implementation of Images...
  • Page 6 9.23 Basic Parameters 9.24 Parameters for the Front- and Backcover 9.25 Parameters defining Layout and Appearance 9.26 Parameters for Links on Pages 9.27 Parameters for FSI Pages Thumbnails 9.28 Parameters for Statistics 9.29 Advanced Parameters 10.1 FSI Pages mobile 10.1.1 Pages Mobile Parameters 10.1.2 Pages Mobile Plug-in Attribute targetdevice 11 FSI Showcase Add-on 11.1 Using FSI Showcase...
  • Page 7 12.21 Notepad 12.22 PagesLibrary 12.23 PagesMirror 12.24 PageSounds 12.25 PagesThumbBar 12.26 PrintSave 12.27 Resize 12.28 SelectFrame 12.29 ShoppingList 12.30 SoftwareCursor 12.31 StickyNotes 12.32 Synchronize 12.33 ZoomMeter 13 Appendix A Escaping or URL-encoding parameter values B HTML Tags available in FSI Viewer C Example of a _default.xml file for FSI Viewer Flash D Example of an image specific FSI configuration file E Example of a FSI Viewer JS skin css file...

  • Page 8: Introduction

    FSI Server, only one high resolution source image is required for each image to be displayed. Thank you for using NeptuneLabs software! www.neptunelabs.com : Online Resources for FSI Viewer Visit www.neptunelabs.com for software updates, regularly updated samples, tutorials and downloads. NeptuneLabs - FSI Viewer...

  • Page 10: Fsi Viewer Js

    2 FSI Viewer JS 2 FSI Viewer JS FSI Viewer JS is a JavaScript based tool to display 2D image zoom and 360° Object spins on desktop computers and mobile devices. Depending on the device capabilities it offers in place zoom or pinch zoom support. FSI Viewer JS also supports optional multiple axis spin.

  • Page 11: How It Works

    2 FSI Viewer JS Integrate FSI Viewer JS <body> […] <fsi-viewer width="500" height="600" src="/images/foo.tiff"> //here you can place the fallback content in case the browser // cannot display the viewer, e,g,: <b>Sorry</b>, your browser is not capable of running FSI Viewer </fsi-viewer>...

  • Page 12: Using Fsi Viewer Js

    Note on Internet Explorer: In order to make FSI Viewer JS work, Internet Explorer must run in IE8 quirks, IE9 or higher quirks or standards mode. You can ensure that by adding an X- UA- Compatible meta tag to the head section of your web page, for example: <meta http-equiv="X-UA-Compatible"...

  • Page 13: The Menu Bar

    Undoes zoom, pan and rotation and restores the initial view. (identical with pressing space bar) Zoom In Zoom Out 2.2.2 Mouse Modes The → Mousemodes or → MousemodeSelect plug- in is required to display the following mouse mode buttons. NeptuneLabs - FSI Viewer...

  • Page 14: Additional Buttons

    To reset rotation, hold down the CTRL-key and click on the image. 2.2.3 Additional Buttons Hide / Display menu Displays or hides the user interface. Information Viewer Displays information about the viewer (optional, can be hidden by altering the skin CSS) NeptuneLabs - FSI Viewer...

  • Page 15: Using The Navigator Window

    *.js, *.xml 2.4 Configuration 2.4.1 Using XML Configuration Files (*.xml) FSI Viewer JS uses XML configuration files which can easily be edited with any text editor. The default configuration file "_ default.xml" - which is located in WEBAPPS/fsi/viewer/ is the most important XML configuration file and will always be evaluated first.
  • Page 16 "value" attribute of the node. Structure of XML configuration files <fsi_parameter> <image> <parameter value="" /> </image> <plugins> <parameter value="" /> </plugins> <options> <parameter value="" /> </options> </fsi_parameter> NeptuneLabs - FSI Viewer...

  • Page 17: Hierarchy Of Configuration Parameters

    <!-- <path value="anotherimage.tif" /> --> </image> 2.4.2 Hierarchy of Configuration Parameters As explained before parameters can be provided in two different ways: default configuration file "_ default.xml" - located in WEBAPPS/fsi/viewer/ - will always be evaluated first NeptuneLabs - FSI Viewer...
  • Page 18 Configuration Hierarchy 1. Configuration file (*.xml) 2. Default configuration file (_default.xml) Choosing the adequate Configuration Method So far you learned that FSI Viewer JS can be configured by any combination of: The default configuration file (_default.xml) Additional configuration files (*.xml) These configuration options are not only alternate methods.

  • Page 19: Retrieving Parameters From Fsi Server

    2.4.3 Retrieving Parameters from FSI Server FSI Viewer JS is capable of retrieving image specific parameters from FSI Server dynamically. This way you do not need to define these parameters explicitly.

  • Page 20: Enabling The Debug Mode

    "/debug" directory of your FSI setup directory. Example: If FSI Viewer JS does not work or look as expected in an HTML page you can quickly debug FSI Viewer as follows: Open the HTML page containg FSI Viewer JS Open the"Inspect Element"...
  • Page 21 JavaScript Description console Syntax Boolean Default false Context FSI Viewer JS Display debug and status information in the browser's JavaScript console. headers display debug and status information in the JavaScript Description console Syntax String Default "cors"...
  • Page 22 Time in seconds for a full rotation Syntax float Default Context FSI Viewer JS Time in seconds for a full rotation. Negative values reverse spin direction. Description relative path to an XML configuration file in FSI Viewer format Syntax String Default ""...
  • Page 23 2 FSI Viewer JS noNav Description hides the navigation window Syntax boolean Default false Context FSI Viewer JS Hides or displays the navigation window. autoHideNav Description automatically hides the navigation window Syntax boolean Default false Context FSI Viewer JS Hides or displays the navigation window automatically if the magnification is at minimum.
  • Page 24 Description defines the width of the progress bar Syntax float Default Context FSI Viewer JS Defines the width of the progress bar in percent of the viewport width. progressBarHeight Description defines the height of the progress bar Syntax float...
  • Page 25 Description defines the vertical position of the progress bar Syntax string Default "bottom" Context FSI Viewer JS Defines the horizontal position of the progress bar, possible values: top, middle(or center), bottom. urlLoadingAnimation Description defines the loading animation shown Syntax string Default "/skins/resources/loading.svg"...
  • Page 26 Default true Context FSI Viewer JS Enable the user to zoom in and out. On touch enabled devicesthe zoom is based on the native pinch zoom gesture. On non touch enabled devices, in place zoom by clicking the object or dragging up/down will be enabled instead.
  • Page 27 Defines the path to single images used for FSI Viewer JS. imagesources Description paths to single images used for FSI Viewer JS Syntax String Default "" Context FSI Viewer JS Defines the paths to single images used for FSI Viewer JS. Example: "dir1/1.jpeg, dir1/2.jpeg, dir2/1.jpeg,..." NeptuneLabs - FSI Viewer...
  • Page 28 Syntax 6-digit hex-color Default #FFFFF Context FSI Viewer JS The background color to use. The color should match the video's or image's background color (usually white or black). mouseSensitivity Description sensitivity of the mouse movement when rotating the object...
  • Page 29 ("pellets") drawn on the video Syntax float Default 0.09 Context FSI Viewer JS Opacity of the dots ("pellets") drawn on the video, if the pellets parameter is enabled. drawCube draws a 3D cube wireframe representing the spin object Description...
  • Page 30 Syntax Float Default Context FSI Viewer JS Defines the diameter of the virtual rotating table plate in mm. This option only works on desktop computers using the HTML canvas element. drawGroundPlate Description draws a virtual ground plate...
  • Page 31 Syntax String Default "" Context FSI Viewer JS 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 images both values default to 1. initialViewPersistent...
  • Page 32 Syntax boolean Default true Context FSI Viewer JS If this parameter is set to false,a static image will be showninsted of the spin while loading. If initialView is defined, the image defined there will be shown. showProgressbar Description shows/hides progess bar while loading...
  • Page 33 Description prevents the image transparency Syntax Boolean Default false Context FSI Viewer JS Prevents using the image transparency if a transparency channel exists. useDevicePixelRatio Description Use the device's pixel ratio to display even sharper images. Syntax Boolean Default true...
  • Page 34 Description allows pinch-zoom on FSI VIewer JS instance Syntax string Default "auto" Context FSI Viewer JS Activates pinch document zoom on FSI Viewer instance. Possible values: true false pinch document zoom is activated on all touch-enabled auto: devices autoDisablePointerActions...
  • Page 35 Reload images in the new required resolution after a resize Description event Syntax Boolean Default "true" Context FSI Viewer JS Reload images in the new required resolution after a resize event. maxZoom Description defines the maximum magnification level Syntax Float Default...
  • Page 36 2 FSI Viewer JS initialMouseMode Description Mouse mode on startup Syntax String Default "auto" Context FSI Viewer JS Specifies the selected mouse mode on startup. Possible values: (Zoom) (Pan) (Spin 360°) menuButtonOrder Description defines the button order of the menu bar buttons...
  • Page 37 Automatically destroy instances created with the fsi-viewer tag upon removing the tag from the document DOM. spinDirectionImage Description defines direction of rotation Syntax String Default "left" Context FSI Viewer JS Specifies the direction of the spin rotation. SceneSets Description Scene sequence definition Syntax String Default 1 – n tiles Context FSI Viewer JS Defines the minimum instance size of the viewer.
  • Page 38 Example: SceneSets="1-12;13-24;25-36;37-48" reverseSceneSets Description reverses the Scene Sets Syntax boolean Default false Context FSI Viewer JS Reverses the order of the Scene Sets. NoSetLoop Description No 360° rotation around the y-axis Syntax Boolean Default false Context FSI Viewer JS The first and the last scene set will be considered ending points.

  • Page 39: Global Parameters For Hot Spots

    Description enables or disables hot spots Syntax boolean Default true Context FSI Viewer JS You can set this value to false if hot spots have been defined, but shall not be displayed. hotspotCallbackFunction Description callback function for hot spots Syntax...
  • Page 40 "mouseover", action "mouseout", "mousedown" or "click" viewer the FSI Viewer JS viewer instance calling the method idViewer the value of the "id" attribute of the viewer's <div> tag idHotspot the 0-based id of the hotspot node the <div>...
  • Page 41 Syntax 6-digit hex color Default #FFFF00 Context FSI Viewer JS The lighter color of the hot spot marker circle's gradient. hotspotDotColor2 Description darker color of the hot spot marker lines Syntax 6-digit hex color...

  • Page 42: Camera> Section

    Default Context FSI Viewer JS The value depends on the size of the optical sensor chip of the camera. For full frame cameras the value is "1.0". Common values are between 1.5 to 1.6. The crop factor is the same factor that affects the focal length of your camera's objective.
  • Page 43 22.3mm x 14.9mm) as an example: 36² + 24² 1.6132 22.3² + 14.9² focalLength Description focal length of the camera objective Syntax float (in mm) Default Context FSI Viewer JS The focal length of the camera objective. NeptuneLabs - FSI Viewer...
  • Page 44 2 FSI Viewer JS position, targetPosition Description defines the position of the camera and the object Syntax float (in mm) Default Context FSI Viewer JS postion (x,y,z) and targetPosition (x,y,z) can used instead distanceToTableCenter, heightAboveTable and targetHeightOffset. (see illustration below) position(x,y,z) image...
  • Page 45 Syntax float (in mm) Default Context FSI Viewer JS The straight distance from the cameras image plane to the center of the turn table in mm (see illustration below). heightCamera Description distance from image plane of the camera to the ground...
  • Page 46 Syntax float (in mm) Default Context FSI Viewer JS The height of the camera target spot at the center of the turn table in mm. If you vertically target the table center the value is 0.0 mm. (see illustration below)
  • Page 47 Syntax float (in mm) Default Context FSI Viewer JS Defines the lenght of the robot arm; default value is the distance of the camera to the camera target. Only relevant if hotspots are used. NeptuneLabs - FSI Viewer...
  • Page 48 Syntax float (in mm) Default Context FSI Viewer JS Defines the position (x,y,z) of the robot arm joint; default value is equal to the camera targetPostion. Only relevant if hotspots are used. armAngleMeasureSetup Description angle where distance from camera to target is measured...

  • Page 49: Virtualspace> Section

    Syntax float (in degrees) Default Context FSI Viewer JS Defines the end angle of the rotation around the x- axis. Only relevant if hotspots are used. 2.5.3 <virtualSpace> Section The virtualSpace section is optional and only required if you want to verify the 3D projections for use with hot spots.
  • Page 50 Syntax float Default Context FSI Viewer JS You can specify a rotation offset in degrees. This is required only, if you started the 360° shooting session at an angle other than 0°. rotationXRange, rotationYRange...

  • Page 51: Hotspots3D> Section

    Syntax float Default Context FSI Viewer JS Alternative parameter to shiftX,shiftY, shiftZ - positon(x,y,z) is optional and defines an offset of the spin object on the turn table in mm. 2.5.4 <hotspots3d> Section The hotspots3d section is optional and only required if you want to display hot spots on your 360°...
  • Page 52 (in mm) Default Context FSI Viewer JS The x, y and z distance in mm on the real object measured from the center of the object (usually equal to the center of the turn table). Combined with the required <camera> parameters, the viewer calculates the rotated and projected position of the hot spot on screen.
  • Page 53 Default "" Context FSI Viewer JS The HTML content to display for this hot spot. Note that the value needs to be XML encoded if the content contains invalid characters for XML attribute values (e.g. '&amp;' for '&', '&lt;' for '<', '&gt;' for '>' and '&quot;' for ").
  • Page 54 Syntax float Default Context FSI Viewer JS Defines the horizontal position of the marker line on the tooltip. Range: [0.0 ... 1.0] The value 0.0 marks the left corner of the tooltip while 1 marks the right corner. verticalMarkerPosition...
  • Page 55 Description angle of the vertical hot spot marker Syntax float Default Context FSI Viewer JS Defines the angle of the vertical hot spot marker. perimeterAngle Description viewing angle in degrees at which to display the hot spot Syntax float...
  • Page 56 Syntax float Default Context FSI Viewer JS The angle range in which the hot spot shall be visible. E.g. a perimeterAngle of "90" and a perimeterAngleRange of "40" would display the hot spot from 70 to 110 degrees (+/- 20°).
  • Page 57 Default Context FSI Viewer JS The angle range in which the hot spot shall be faded in and out. A value of "0" means that the hot spot will be displayed or hidden immediately when entering or leaving the perimeterAngleRange. Values greater than 0 extend the perimeterAngleRange by the given degrees in which the hot spot's opacity changes.
  • Page 58 Syntax boolean Default false Context FSI Viewer JS The hot spot content area will not react on mouse over, click actions and alike when setting "interactive" to false. actionParameter Description value will be passed on to the hot spot callback function...
  • Page 59 URL in Syntax string Default _self Context FSI Viewer JS The target frame or window to open the URL in. Use e.g. "_blank" to open hyperlinks in a new window. focusOnClick Description zoom and/or rotate to hotspot position on click...
  • Page 60 Description zoom to hotspot Syntax boolean Default true Context FSI Viewer JS Setting this parameter to true zooms to thehotspot, while false keeps the current zoom. focusRadius Description size of section when zooming to a hotspot Syntax float Default 0.25...
  • Page 61 Example CSS classes: It is recommended to add the following CSS classes to the HTML document containing FSI Viewer JS instances with hot spots. These classes will be used if you do not define "normalClass", "hoverClass" and "activeClass" parameters for your hot spots.
  • Page 62 </style> cssClass CSS class name to add to the hot spot's content <div> Description Syntax string Default "" Context FSI Viewer JS An additional CSS class name to add to the hot spot's content <div> tag. NeptuneLabs - FSI Viewer...

  • Page 63: Video> Section

    Default "" Context FSI Viewer JS A additional CSS style value to add to the hot spot's content <div> tag. 2.5.5 <video> Section The video section is optional and only required if you want to enable ultra smooth rotations by providing a video of the spin.
  • Page 64 Scene Set the video is used Syntax string Default "" Context FSI Viewer JS If Scene Sets are used, this parameter defines in which Scene Set the video will be used for smooth rotation. base Description optional prefix for all "source" parameters...
  • Page 65 Syntax integer Default Context FSI Viewer JS The number of frames to capture from the video. The more frames you define the smoother the rotation will appear. More frames require more time to capture the videos on startup. 120 frames (default) means 3° per frame.
  • Page 66 Default Context FSI Viewer JS An optional factor to adjust the width of the video to the width of the images on screen. You might want to adjust the value if the image do not match the video dimension.

  • Page 67: Plugin Parameters

    Default Context FSI Viewer JS An optional factor to adjust the vertical position of the video to the vertical position of the images on screen. You might want to adjust the value if the image do not match the video position.
  • Page 68 Default Context FSI Viewer JS Has the same function as → FSI Viewer JS Parameters , but is used here in the context of the plug-in. Time in seconds for a full rotation. Negative values reverse spin direction. preventClickZoomWhileSpinning Description...
  • Page 69 Indentation of the menu buttons Syntax Integer Default Context FSI Viewer JS Specifies the space in pixels left of the menu button(s) of the plug-in. Mode n Description Removes the button for mouse mode n from the menu bar Syntax...

  • Page 70: Creating And Using Spin Videos

    String Default 0,1,3,2 Context FSI Viewer JS You can alter the sequence of the buttons by providing the modes separated by commas (see the table above). Example: "1,0,2,3" alters the sequence of the buttons to "Pan, Zoom, Rotate 3D, Rotate 2D".

  • Page 71: Embedding The Viewer At Runtime Via Javascript

    "images/Rocker Shoe.tif"); node.setAttribute("debug", "true"); document.body.appendChild(node); $FSI.initCustomNode(node); // Important: call this AFTER adding the node to the DOM I) Passing parameters via JavaScript object: NOTE: In this case any parameters passed via node attribute will be ignored. NeptuneLabs - FSI Viewer...
  • Page 72 // Important: call this AFTER adding the node to the DOM $FSI.initCustomNode(node); Note: $FSI.initCustomNode(node) initializes the given node. When adding multiple viewers you can initialize all new FSI Viewer JS nodes in one go, using this command: $FSI.initCustomTag("fsi-viewer"); or, when using different custom tags (fsi-viewer, fsi-imageflow,…): $FSI.initCustomTags();...

  • Page 73: Javascript Interface

    2 FSI Viewer JS 2.8 JavaScript Interface The JavaScript interface of FSI Viewer JS can be useful if you want to change the current image or config or add additional content depending on the object spin position or hot spot actions.
  • Page 74 Spins to the position indicated by the target parameters. Note that you can only spin to a position that has a corresponding HD image, not to a position that shows a video only. nMousemode getMouseMode(); Returns the current active mouse mode. NeptuneLabs - FSI Viewer...
  • Page 75 Returns the number of the viewer object. void destroy(); Destroys the given FSI Viewer JS object. You should destroy the instance before you remove the object spins <div> tag from the DOM tree. strVersion getVersion(); Returns a string containing the FSI Viewer JS software version.
  • Page 76 = 100 for maximum magnification. bPreliminary: Set to true if the magnification level is temporary only. In this case no additional image data will be loaded. bAnimate: Set to true to animate from the current to the given magnification level. NeptuneLabs - FSI Viewer...
  • Page 77 FSIHotspotID is the consecutive number of the Hotspot (1,2,3,..) The boolean "bAnimated" can be used to specify, wether the view should be displayed immediately or in form of an animated movement from the current view to the specified view. NeptuneLabs - FSI Viewer...
  • Page 78 Sets the menu button to active. void releaseMenuButton(strButtonID) Disables the active menu button. void registerExternalMenuButton(elButton, strButtonID, strTip) Registers an external menu button. void unregisterExternalMenuButton(elButton) Unregisters an external menu button. void registerExternalMenuButtonsFromContainer (elContainer) Registers an external menu button from a specific container. NeptuneLabs - FSI Viewer...
  • Page 79 Enables the FullScreen mode. bSuccess setFullScreenElement(elFullScreenContainer) Defines the FullScreen element. nFrames getSpinFrames() Returns the amount of spin frames. bTransparent getImageIsTransparent() Returns the info if the image is transparent. oDimension getSrcDim() Returns the dimensions of the source image. NeptuneLabs - FSI Viewer...
  • Page 80 Transforms a value into a boolean value, e.g. "1" to true, "false" to false bDefaultValue is optional and false if not defined. mixed getPluginParameter(strPluginName, strParameterName, defaultValue, bMakeBoolean); Returns the parameter defined for the given plugin. defaultValue and bMakeBoolean are optional. example: iViewer.getPluginParameter("pages", "dir"); NeptuneLabs - FSI Viewer...

  • Page 81: Callbacks

    2 FSI Viewer JS 2.8.2 Callbacks You can define callback functions by assigning methods to the FSI Viewer JS instance. Using Callbacks Method A – Create a function in window scope Example: <script> function onFSIViewerViewChanged(strView){ console.log(strView); <script> a) assignment in Custom Tag: Example: <fsi-viewer onViewChanged=”onFSIViewerViewChanged”...
  • Page 82 You cannot change, add or remove callbacks after the viewer started. The following callback methods exist: onReady(); Called as soon as FSI Viewer finished loading data and gets interactive. onDestroy(); Called when the fsi-viewer element is destroyed. NeptuneLabs - FSI Viewer...
  • Page 83 Called when a spin and/or zoom animation finishes. onAnimationStart(); Called when a spin and/or zoom animation starts. onChangeConfig(strCfgFileName, oParameters); Called when the config file is changed. onChangeImage(oParameters, strView); Called when the image is changed. NeptuneLabs - FSI Viewer...
  • Page 84 This optional callback function can be used call an action when a button is enabled or disabled. onMenuButtonPressed(strButtonID, evt); This optional callback function can be used to set an action that starts when a button is pressed. NeptuneLabs - FSI Viewer...
  • Page 85 This optional callback function can be used to call an action when the mouse mode is changed. onStartDragging(bInNavWindow); This optional callback function can be used to call an action when the user starts dragging the image. NeptuneLabs - FSI Viewer...
  • Page 86 This optional callback function can be used to call an action as soon as a certain Hotspot event occurs. The following events are possible: mouseover, mousedown, mouseout & click. NeptuneLabs - FSI Viewer...

  • Page 88: Fsi Touchzoom

    </script> </head> It is possible to pass optional parameters via JavaScript. In this case it is crucial to embed the TouchZoom script before defining the parameters: Exanple: <script type="text/javascript src="/viewer/applications/touchzoom/js/fsitouchzoom.js"></script> <script type="text/javascript> $FSI.touchZoomParameters = {debug:true, useDevicePixelRatio:false}; </script> NeptuneLabs - FSI Viewer...

  • Page 89: Initializing Fsi Touchzoom Manually

    I) let FSI.TouchZoom initialize automatically and add image manually: Exanple: <script type="text/javascript src="/viewer/applications/touchzoom/js/fsitouchzoom.js"></script> <script type="text/javascript> addMyImagesToTheDom(); // add your images here // make FSI.TouchZoom look for new images $FSI.touchZoom.scanForNewImages(); </script> II) initialize FSI.TouchZoom manually after adding your images: NeptuneLabs - FSI Viewer...

  • Page 90: Fsi Touchzoom Parameters

    You can optionally modify the way FSI TouchZoom works by passing parameters to the script. To do so, pass an object containing the parameters and value as an object to the constructor: Example: <script type="text/javascript"> FSITouchZoom = new $FSI.TouchZoom({debug:true, zoomPrecision:6}); FSITouchZoom.init(); </script> NeptuneLabs - FSI Viewer...
  • Page 91 For huge amounts of images on a single web page you might want to disable this feature, if the positions of the images do not change (e.g. there is no javascript modifying the DOM tree). NeptuneLabs - FSI Viewer...
  • Page 92 Specifies whether or which image to display at the bottom right of the viewport while new images are being retrieved from FSI Server. You can use true or false to enable/disable the loading image display or provide an URL to a custom image. NeptuneLabs - FSI Viewer...

  • Page 93: Initializing Fsi Touchzoom Manually

    You can combine this parameter with the enableByCSSClass parameter. 3.3 Initializing FSI TouchZoom manually Initializing or adding images manually If you are adding images by script, you can decide to: I) let FSI.TouchZoom initialize automatically and add image manually: NeptuneLabs - FSI Viewer...
  • Page 94 // prevent $FSI.TouchZoom from initializing automatically // on document load $FSI.touchZoomParameters = {autoInit:false}; function onBodyLoaded() addMyImagesToTheDom(); // add your images here // create and initialize FSI.TouchZoom var parameters = {debug:true, useDevicePixelRatio:true}; myTouchZoom = new $FSI.TouchZoom(); myTouchZoom.init(parameters); </script> NeptuneLabs - FSI Viewer...

  • Page 95: Javascript Interface

    Note: you can as well call scanForNewImages() after adding an <img> node. void removeImages(arImageDOMElements, bSilent); Removes one or more touch zoom images and restores their original state. arImageDOMElements: an <img> node object or an array of <img> node objects NeptuneLabs - FSI Viewer...
  • Page 96 Use this method to modify the parameter zoomPrecision at runtime. void destroy(); Destroys FSI TouchZoom. void init(); Initializes FSI TouchZoom. strVersion getVersion(); Returns a string containing the FSI ImageFlow software ver- sion. strVersion getBuild(); Returns a string containing theFSI ImageFlow software build number. void enable(bEnable); Enables FSI TouchZoom. NeptuneLabs - FSI Viewer...
  • Page 97 3 FSI TouchZoom void lockImage(elImage, bLock); Locks a certain image . void lockImageSourceImage(elImage, bLock); Locks a certain image to it's source dimensions. void lockUpdates(bLock); Locks updates . void resetImage(elImg); Resets a certain image. void triggerRefresh(); Triggers a refresh. NeptuneLabs - FSI Viewer...

  • Page 98: Fsi Quickzoom

    QucikZoom script before defining the parameters: Exanple: <script type="text/javascript src="/viewer/applications/quickzoom/js/fsiquickzoom.js"></script> <script type="text/javascript> $FSI.quickZoomParameters = {debug:true, useDevicePixelRatio:false}; </script> Alternatively it is possible to use an external JavaScript for defining the parameters. This is useful if the parameters are valid for multiple HTML documents. NeptuneLabs - FSI Viewer...

  • Page 99: How It Works

    <script type="text/javascript"> FSIQuickZoom = new $FSI.QuickZoom({debug:true, magnification:6}); FSIQuickZoom.init(); </script> debug displays debug & status information in the javascript Description console. Syntax Boolean Default false Context FSI QuickZoom Display debug and status information in the browser's javascript console. NeptuneLabs - FSI Viewer...
  • Page 100 CSS class names. Only images containing at least one of the given class names will be modified by this script. All other images are displayed as normal images that do not use FSI QuickZoom. You can combine this parameter with the disableByCSSClass parameter. NeptuneLabs - FSI Viewer...
  • Page 101 Syntax Float Default "" Context FSI QuickZoom Defines the magnification level of the image section displayed in the zoom window. It is also possible to define the magnification for each image tag individually by adding FSIQuickZoomMagnification . NeptuneLabs - FSI Viewer...
  • Page 102 Defines the maximum height of the zoom window displayed next to the original image. minZoomWindowWidth Description defines the minimum zoom window width Syntax Float Default Context FSI QuickZoom Defines the minimum width of the zoom window displayed next to the original image. NeptuneLabs - FSI Viewer...
  • Page 103 QuickZoom will not be applied to it. skipImageHeight Description defines minimum image height for QuickZoom use Syntax Boolean Default Context FSI QuickZoom If the image height is smaller than the height defined with this parameter, FSI QuickZoom will not be applied to it. NeptuneLabs - FSI Viewer...
  • Page 104 Default Context FSI QuickZoom Defines the horizontal offset of the zoom window to the original image. Defining box-shadow and fade-in The box- shadow and the fade- in of the FSI QuickZoom zoom window can be defined via CSS. NeptuneLabs - FSI Viewer...

  • Page 105: Initializing Fsi Quickzoom Manually

    I) let FSI.QuickZoom initialize automatically and add image manually: Exanple: <script type="text/javascript src="/viewer/applications/quickzoom/js/fsiquickzoom.js"></script> <script type="text/javascript> addMyImagesToTheDom(); // add your images here // make FSI.QuickZoom look for new images $FSI.quickZoom.scanForNewImages(); </script> II) initialize FSI.QuickZoom manually after adding your images: NeptuneLabs - FSI Viewer...

  • Page 106: Javascript Interface

    If you on the other hand add images to the DOM tree at runtime or modify the position of images by script, the following interface is available to update the images and positions: FSIQuickZoom = new $FSI.QuickZoom(); FSIQuickZoom.init(); I) Public Methods NeptuneLabs - FSI Viewer...
  • Page 107 Note: you can as well call scanForNewImages() after adding an <img> node nInstanceID getInstanceID(); Returns the number of the viewer object. strVersion getVersion(); Returns a string containing the FSI ImageFlow software version. strVersion getBuild(); Returns a string containing theFSI ImageFlow software build number. NeptuneLabs - FSI Viewer...
  • Page 108 <img> tags at runtime, you need to call this method in order to make the script aware of new image(s). II)Callbacks void fnPositionAndSizeCallback(); Returns the position and size. fnPositionAndSizeCallbackScope The scope used when calling fnPositionAndSizeCallback. NeptuneLabs - FSI Viewer...
  • Page 109 = 200; oModify.srcZoomImage += "&effects=Sepia()"; // oInfo contains various information you can read // modifying oInfo does not change anything // e.g. // oInfo.elementPosition (clientPosition of the original image tag) // oInfo.imgPaddings (margin and border of the image) NeptuneLabs - FSI Viewer...

  • Page 110: Fsi Imageflow

    Add the desired dimension to it and image source (directory) to it: Exanple: <body> […] <fsi-imageflow width="100%" height="150" src="/images/foo/" > </fsi-imageflow> Parameters are added to the <fsi-imageflow> tag. Note that you can as well use configuration files: NeptuneLabs - FSI Viewer...

  • Page 111: How It Works

    You can optionally modify the way FSI ImageFlow works by passing parameters to the script. You can either use an XML configuration passing the path using a "cfg" parameter or pass parameters and values as an object to the constructor: NeptuneLabs - FSI Viewer...
  • Page 112 The background color for the image carousel. Syntax String Default "#FFFFFF" Context FSI ImageFlow The background color for the image carousel. Use "none" if the background should be visible. Use a web color (e.g. #FFFF00) to define the color of the background. NeptuneLabs - FSI Viewer...
  • Page 113 The path to the source image folder on FSI Server to display. imagesources Description paths to single images used for FSI ImageFlow Syntax String Default "" Context FSI ImageFlow Alternative way to define the paths to single images used for FSI ImageFlow. Example: "dir1/1.jpeg, dir1/2.jpeg, dir2/1.jpeg,..." NeptuneLabs - FSI Viewer...
  • Page 114 Syntax Boolean Default true Context FSI ImageFlow Moves the currently zoomed image to the center of the carousel. zoomCenteredImageOnly Description zoom the centered image only Syntax Boolean Default false Context FSI ImageFlow NeptuneLabs - FSI Viewer...
  • Page 115 Note: If the resulting image height limits the image dimension, there is a spacing even if you define elementSpacing with a value of "0". In this case you either need NeptuneLabs - FSI Viewer...
  • Page 116 Description The number of images to pre-load. Syntax Integer Default Context FSI ImageFlow The number of images to pre-load although they are currently not visible. Possible values are integers greater or equal to 0. NeptuneLabs - FSI Viewer...
  • Page 117 Syntax Integer Default Context FSI ImageFlow Defines the padding of the scroll bar. scrollHeight Description height of the scroll bar Syntax Integer Default Context FSI ImageFlow Defines the heigth of the scroll bar. NeptuneLabs - FSI Viewer...
  • Page 118 Defines the amount that should be cut off the image from each side. Values can be provided as pixel (e.g. "20px") or percent (e.g. "10%") or floating point numbers (e.g. "0.25"). Use 4 values for left, top, right, bottom. Example: 10%,0,10%,0 NeptuneLabs - FSI Viewer...
  • Page 119 The FSI Server template to request images. Syntax String Default "jpg" Context FSI ImageFlow The FSI Server template to request images. Usually this is "jpg" or "png". The default quality is part of the server template definition. NeptuneLabs - FSI Viewer...
  • Page 120 The height of the optional mirror effect relative to the image Description height. Syntax Float Default Context FSI ImageFlow The height of the optional mirror effect relative to the image height. 0 turns the mirror effect off. 1.0 uses the entire image height. NeptuneLabs - FSI Viewer...
  • Page 121 An optional value to determine the depth to clip images. Syntax Float Default Context FSI ImageFlow An optional value to determine the depth to clip images. If images appear and disappear abruptly at the sides you might want to decrease the value to e.g. 0.1. NeptuneLabs - FSI Viewer...
  • Page 122 Context FSI ImageFlow This value determines the y-position of images in the back. 0 means that all images are equally bottom aligned. Values greater than 0 increase the radius like viewing the images from an elevated position. NeptuneLabs - FSI Viewer...
  • Page 123 Space holders appear while the actual images data is being loaded. Use "none" to disable drawing placeholders. presentationType Description The overall image presentation appearance. Syntax Enum Default "carousel" Context FSI ImageFlow Selects the overall image presentation (carousel, stacks, flat) appearance in FSI Imageflow. NeptuneLabs - FSI Viewer...
  • Page 124 Width of the border around zoomed images. zoomBackgroundColor The CSS background-color property to use for zoomed Description images. Syntax String Default "#FFFFFF" Context FSI ImageFlow The CSS background-color property to use for zoomed images. Use "none" for a transparent background. NeptuneLabs - FSI Viewer...
  • Page 125 The color to use to fade out the document behind the zoomed image. zoomFadeOpacity Description The opacity to use to fade out behind the zoomed image. Syntax Integer Default Context FSI ImageFlow The opacity (0 to 100) to use to fade out the document behind the zoomed image. NeptuneLabs - FSI Viewer...

  • Page 126: Embedding The Viewer At Runtime Via Javascript

    Automatically destroy instances created with the fsi-imageflow tag upon removing the tag from the document DOM. 5.3 Embedding the viewer at runtime via JavaScript It is also possible to embed the viewer at runtime via JavaScript. I) Passing parameters via node attribute: NeptuneLabs - FSI Viewer...
  • Page 127 $FSI.initCustomNode(node) initializes the given node. When adding multiple viewers you can initialize all new FSI ImageFlow nodes in one go, using this command: $FSI.initCustomTag("fsi-imageflow"); or, when using different custom tags (fsi-viewer, fsi-imageflow,…): $FSI.initCustomTags(); to initialize all new FSI custom tags. NeptuneLabs - FSI Viewer...

  • Page 128: Javascript Interface

    Shows all API methods in the console in alphabetical order. void destroy(); Destroys the FSI ImageFlow instance leaving the empty container <div> only. You can re-use the same container calling FSIImageFlow.init() bInitDone getInitDone(); Returns if the initialization process is done. NeptuneLabs - FSI Viewer...
  • Page 129 Remove the zoomed image if any. II] Callback functions The optional JavaScript callback functions enables developers to react on events fired by FSI ImageFlow. To use a callback you need to implement a corresponding NeptuneLabs - FSI Viewer...
  • Page 130 Called once after loading the image list. callBackClick(oInstance, idElement, nImageIndex, strImagePath); Called each time the user clicks an image. callBackFocus(oInstance, idElement, nImageIndex, strImagePath); Called each time the foreground image changes. callBackZoomStart(oInstance, idElement, nImageIndex, urlZoomedImage); Called each time a zoomed image starts loading. NeptuneLabs - FSI Viewer...
  • Page 131 5 FSI ImageFlow callBackZoomEnd(oInstance, idElement); Called each time a zoomed image has been closed. NeptuneLabs - FSI Viewer...

  • Page 132: Fsi Showcase Js

    FSI Server and add the following scripts to the <head> section of your website: Example: <head> […] <script src="applications/viewer/js/fsiviewer.js" type="text/javascript"></script> <script src="applications/imageflow/fsiimageflow.js" type="text/javascript"></script> </head> FSI Showcase is build of combining the FSI Viewer JS and FSI ImageFlow tags, assigning theViewer JS to ImageFlow with a specific viewer id: NeptuneLabs - FSI Viewer...
  • Page 133 6 FSI Showcase JS Example: <body> […] //Adding FSI Viewer <fsi-viewer id="viewer1" width="100%" height="600" noNav="1" plugins="fullScreen"> </fsi-viewer> //Adding FSI ImageFlow, assigning the Viewer JS with the viewerID <fsi-imageflow viewerID="viewer1" width="100%" height="150" src="/images/foo/" presentationType="flat"> </fsi-imageflow> NeptuneLabs - FSI Viewer...

  • Page 134: Fsi Pages Js

    The user can drag the pages left and right to browse through the catalog and zoom in/out either using pinch zoom or by double-clicking on the page. Hovering over embedded areas displays a tool tip and/ or hyperlink. 7.2 Usage I) add the fsipages.js script to the head of your document: NeptuneLabs - FSI Viewer...
  • Page 135 // cannot display the viewer, e,g,: <b>Sorry</b>, your browser is not capable of running FSI Pages JS </fsi-pages> Parameters are added to the <fsi-pages> tag. Note that you can as well use FSI Pagesr configuration files : NeptuneLabs - FSI Viewer...

  • Page 136: Defining Image Collections

    FSI Server. You can either do so by using the "Publish to Web" option in FSI Server web interface or by specifying the server address and a directory or search query manually. NeptuneLabs - FSI Viewer...
  • Page 137 Creating collections manually using XML configuration files <Images> <Image file="image1.xml" label="My First Image" /> <Image file="image2.xml" label="My Second Image" /> </Images> Method 2 and Method 3 can be freely combined while Method 1 retrieves a complete image list ignoring previously defined <images> nodes. NeptuneLabs - FSI Viewer...

  • Page 138: Aspect Ratio Of The

    If you want to enable users to print pages from within FSI Pages you can enable the built-in print function by setting the FSI Pages JS parameter → Print to "true". Enabling Print Options <Plugins> <Plugin src="pages" > <Print value="true" /> <PrintResolution value="1024" /> </Plugin> </Plugins> NeptuneLabs - FSI Viewer...

  • Page 139: Special Url Values

    URL to a JPEG image. Forces FSI Pages to zoom to the area covered by #zoom the link's shape(s) Magnifies the area covered by the link‘s shape(s) in #zoomarea place Forces FSI Pages to zoom to the image area #zoom=1,1,0,0,0.5,0.5 NeptuneLabs - FSI Viewer...

  • Page 140: Fsi Pages Js Presets In Fsi Server Interface "Publish To Web

    7.3 FSI Pages JS Parameters You can optionally modify the way FSI Pages JS works by passing parameters to the script. To do so, pass an object containing the parameters and value as an object to the constructor: NeptuneLabs - FSI Viewer...

  • Page 141: General Parameters

    Defines the skin which will be displayed. FSI Pages JS comes with three default skins, "black", "white" and "silver". Skins are defined via CSS and can be found here: WEBAPPS/fsi/viewer/skins. It is also possible to alter existing skins or to define custom skins in this location. NeptuneLabs - FSI Viewer...
  • Page 142 Description User interface language Syntax String Default "" Context FSI Pages JS Defines the language of tool tips for the user interface (menu bar). Possible values depend on the XML based language files located in the sub-index NeptuneLabs - FSI Viewer...
  • Page 143 UI is hidden if in place zoom is deactivated adaptiveUISize Description determines if interface scales according to the zoom level . Syntax Boolean Default true Context FSI Pages JS When set to true, the interface scales according to the zoom level. NeptuneLabs - FSI Viewer...
  • Page 144 Determines the button order in the menu bar. Use the button ID which can be found in the respective skin.css (viewer\skins\resources\fsi-pages-core.css) for listing them. Example MenuButtonOrder="ToggleFullscreen, FirstPage, LastPage" Currently the following button IDs exist: PrintPage, FirstPage, PreviousPage, PageInputEnter, NextPage, LastPage, ToggleBookmarkList, ToggleBookmark, ToggleTableOfContents, TogglePageIndex, ToggleFullScreen NeptuneLabs - FSI Viewer...
  • Page 145 Specifies whether a text box for the page input is displayed in the menu bar. PageInputEnterButton Description Enables / disables page overview Syntax Boolean Default true Context FSI Pages JS Specifies whether the enter button for the page input field is displayed in the menu bar. NeptuneLabs - FSI Viewer...
  • Page 146 FSI Pages JS. You can use URLs starting with "javascript:" to have a Javascript function called when the user clicks the viewer. NeptuneLabs - FSI Viewer...
  • Page 147 Enable or disable the user to print current pages, the complete catalog or specific pages from the image collection shown with FSI Pages JS. PrintResolution Description Specifies the print resolution Syntax Integer Default 2000 Context FSI Pages JS Specifies in which resolution the user is allowed to print the pages. NeptuneLabs - FSI Viewer...

  • Page 148: Layout/ Appearance Parameters

    (like in FSI Pages mobile)."flip" shows a page turn effect. InitialPage Description Page to display on startup Syntax Integer Default Context FSI Pages JS Specifies the page to display on startup, e.g. "1" for the front cover. NeptuneLabs - FSI Viewer...
  • Page 149 Default "0,0,0,0" Context FSI Pages JS Defines the amount that should be cut off the image from each side. Values can be provided as pixel (e.g. "20px") or percent (e.g. "10%") or floating point numbers (e.g. "0.25"). NeptuneLabs - FSI Viewer...
  • Page 150 Description moves pages vertical Syntax Boolean Default "false" Context FSI Pages JS When set to true, the pages scroll in the vertical direction instead of the usual horizontal. Note: only valid if PageLayout is set to "scroll"! NeptuneLabs - FSI Viewer...
  • Page 151 If set to "false", the pages will not be displayed as coherent double pages. Note: only valid if PageLayout is set to "scroll"! autoDoublePageMode Description Syntax Boolean Default "true" Context FSI Pages JS Note: only valid if PageLayout is set to "scroll"! NeptuneLabs - FSI Viewer...
  • Page 152 BackCover Description Enables/disables the back cover Syntax Boolean Default "true" Context FSI Pages JS Setting "BackCover" parameter to false disables access to the back cover and forces FSI Pages to add a blank content page if required. NeptuneLabs - FSI Viewer...
  • Page 153 The cover page(s) will be added to the images in the image list. BlankBackCover Description Use a blank page for back cover Syntax Boolean Default "true" Context FSI Pages JS Use a blank page as back cover. NeptuneLabs - FSI Viewer...
  • Page 154 Turns pages automatically when idle Syntax Boolean Default false Context FSI Pages JS Run the FSI Pages JS in demonstration mode and turn pages automatically when the user does not interact (= moves the mouse) for 2 seconds. NeptuneLabs - FSI Viewer...
  • Page 155 Default Context FSI Pages JS Show each page for at least n seconds when flipping pages automatically. Please note that a page might be displayed for longer if loading the page takes longer than the time specified. NeptuneLabs - FSI Viewer...
  • Page 156 The default value of "0" forces FSI Pages JS to display Roman numbers for negative numbers and 0. If you set the value to "5" the display will be like this: I,II,III,IV,V,6,7,8,9… Note that you can use the Parameter → FirstPageNumber to offset all page number values. NeptuneLabs - FSI Viewer...
  • Page 157 Note: The parameter → FirstPageNumber has no impact on the custom page numbers. You can therefore use this parameter to modify the value of the first ordinary page number. NeptuneLabs - FSI Viewer...
  • Page 158 RememberLastViewedPage parameter. You might want to specify an expire time after that the last viewed page will be discarded. Please specify the expire time in seconds, e.g. "3600" for one hour. By default, the stored pages will be stored infinitely. NeptuneLabs - FSI Viewer...
  • Page 159 <li>Double-click or pinch-zoom on a page to zoom in</li> <li>Tap the full-screen icon to switch to full-screen mode</li> <li>Click on the index icon for a catalog overview</li> <li>Enter a number in the page input field to browse to a certain page</li> </ul> </fsi-pages-intro-content> </fsi-pages> NeptuneLabs - FSI Viewer...

  • Page 160: Link Parameters

    Specifies color & opacity of links in hover state Syntax String Default "FF00FFFF" Context FSI Pages JS 8-digit hexadecimal number specifying the color and opacity of links on the pages in hover state in the form "RRGGBBAA". NeptuneLabs - FSI Viewer...
  • Page 161 You can provide one or more identifiers that will be replaced in Link URLs. The identifiers are case sensitive and must be separated by commas. The values to insert have to be defined by the parameter "LinkTemplateData" explained below. NeptuneLabs - FSI Viewer...
  • Page 162 Force a link prefix / suffix for all links on pages Syntax String Default Context FSI Pages JS Force FSI Pages JS to use this prefix /suffix for all links on all pages. This overwrites any prefixes and suffixes specified in the page data. NeptuneLabs - FSI Viewer...
  • Page 163 DefaultLinkTarget Description Default target frame for all hyperlinks on all pages Syntax String Default Context FSI Pages JS Use this HTML target frame for links if no target frame has been specified in the page XML data. NeptuneLabs - FSI Viewer...
  • Page 164 Description Default target frame for all "javascript:" hyperlinks on all pages Syntax String Default Context FSI Pages JS Use this HTML target frame for "javascript:" links if no target frame has been specified in the page data. NeptuneLabs - FSI Viewer...

  • Page 165: Plug-In Parameters

    Adds a plug-in to the viewer. Multiple plug-ins can be listed seperated by comma. Please note: If you would like to add specific parameters to the plugins via the fsi-pages tag, you can do this by prefixing the parameter name with the name of the plug-in, e.g. pagesthumbbar_height="100" FullScreen NeptuneLabs - FSI Viewer...
  • Page 166 Enables/ disables the display of page numbers being below the thumbnails. Autohide Description Auto hides thumbar below 600px Syntax Boolean Default true Context FSI Pages JS If set to true, the thumbnails will not be displayed if the FSI Pages Instance is smaller than 600px. NeptuneLabs - FSI Viewer...
  • Page 167 Float Default Context FSI Pages JS Defines the maximum thumbnail size in the bookmark list in pixel. ShowIconsOnPages Description Shows icon on bookmarked pages Syntax Boolean Default true Context FSI Pages JS Shows icon on bookmarked pages. NeptuneLabs - FSI Viewer...
  • Page 168 FSI Pages JS. The user can directly access sections of a catalog by selecting the corresponding item in the select box. You can assign colors and different levels to each chapter using simple XML based data describing the document structures. NeptuneLabs - FSI Viewer...
  • Page 169 Width of the select box Syntax Integer Default Context FSI Pages JS Usually the FSI Pages JSskin defines the width and position of the select box. Alternatively you can specify a fixed width in pixels using this parameter. NeptuneLabs - FSI Viewer...

  • Page 170: Javascript Interface

    (optional): an object containing parameters If present, these parameters will overwrite the parameters defined upon initialization. void printAPI(); Shows all API methods in the console in alphabetical order. void init(domElement, oParameters, bDebug); Initializes the chosen Pages JS element. NeptuneLabs - FSI Viewer...
  • Page 171 Returns if the initialization process is done. void destroy(); Destroys the given FSI Viewer JS object. You should destroy the instance before you remove the object spins <div> tag from the DOM tree. bSuccess addListener(strListenerName, fn, iScope); Calls a specific listener..
  • Page 172 Sets the menu button to active. void releaseMenuButton(strButtonID) Disables the active menu button. void registerExternalMenuButton(elButton, strButtonID, strTip) Registers an external menu button. void unregisterExternalMenuButton(elButton) Unregisters an external menu button. void registerExternalMenuButtonsFromContainer (elContainer) Registers an external menu button from a specific container. NeptuneLabs - FSI Viewer...
  • Page 173 Returns the name of the current used skin class, e.g. fsi-skin- black bFullscreen getInFullScreenMode() Enables the FullScreen mode. bSuccess setFullScreenElement(elFullScreenContainer) Defines the FullScreen element. strPageNumber getCurrentPageNumber() Returns the current page number. strPageNumber getPageNumberString(nPage) Returns the current page number. oDimension getPageContainerDim() Returns the Page container dimensions. NeptuneLabs - FSI Viewer...
  • Page 174 Returns a string containing the FSI Viewer JS software version. strVersion getBuild(); Returns a string containing the FSI Viewer JS software build number. void showMenuToolTip(strTip, elSrc, x, y) Shows custom tooltips.. strTip: HTML code of thetooltip or ID in language.xml files elSrc: the DOM element wich is used to align the tooltip, usually event.target...
  • Page 175 Returns the value of the configuration parameter "strName". mixed togglePageIndex(); Toggles the page index. bResult makeBoolean(mixedCOnvert, bDefaultValue); Transforms a value into a boolean value, e.g. "1" to true, "false" to false bDefaultValue is optional and false if not defined. NeptuneLabs - FSI Viewer...

  • Page 176: Callbacks

    Called as soon as FSI Pages JS finished loading data and gets interactive. onDestroy(); Called when the fsi-pages element is destroyed. onChangeConfig(strCfgFileName, oParameters); Called when the config file is changed. onMenuEnabled(bEnabled); Calledi f the menu is enabled/disabled. onMenuDestroy(); Called if the menu is destroyed. NeptuneLabs - FSI Viewer...
  • Page 177 This optional callback function can be used to call an action as soonexternal menu buttons are registered. onAfterRegisterExternalButton(elButton, strButtonID, bButtonPresentInViewer) This optional callback function can be used to remove inactive buttons from the menu bar if you are using a custom skin. NeptuneLabs - FSI Viewer...
  • Page 178 This optional callback function can be used to call an action as soon as the chapters opened. onShowPrintDialog(bShow); This optional callback function can be used to call an action as soon as the print dialog is opened. NeptuneLabs - FSI Viewer...
  • Page 179 This optional callback function can be used to call an action as soon as the bookmarks are saved. onRemoveAllBookmarks(); This optional callback function can be used to call an action as soon as all bookmarks are removed. NeptuneLabs - FSI Viewer...
  • Page 180 This optional callback function can be used to call an action if links are clicked. Return "false" to prevent opening the link., return {strURL:"foo", strTarget: "bar"} to modifiy the URL or the target (both are optional) onResize(nWidth, nHeight, bResizeDone, BFullScreen); Called when the fsi-pages element is resized. NeptuneLabs - FSI Viewer...
  • Page 181 7 FSI Pages JS onSkinChanged(strCurrentSkinClass, strCurrentSkinClassBefore) This optional callback function can be used to call an action as soon as the skin class is changed. NeptuneLabs - FSI Viewer...

  • Page 182: Fsi Viewer

    (zoom, pan, rotate, etc.). The example to the right 360° Viewer 33,3% shows the mouse mode "zoom". The optional small navigator window (bottomright) displays the position of the image section currently viewed. NeptuneLabs - FSI Viewer...

  • Page 183: The Menu Bar

    Undoes zoom, pan and rotation and restores the initial view. (identical with pressing space bar) Zoom In Zoom Out Mouse Modes The → Mousemodes or → MousemodeSelect plug- in is required to display the following mouse mode buttons. NeptuneLabs - FSI Viewer...

  • Page 184: Additional Buttons

    To reset rotation, hold down the CTRL-key and click on the image. Additional Buttons Hide / Display menu Displays or hides the user interface. Information Viewer Displays information about the viewer and refers to a configurable help page (Parameter → HelpURL ). NeptuneLabs - FSI Viewer...

  • Page 185: Using The Navigator Window

    Refresh the image information in the debug window. Pos 1 FSI Pages: First Page Page Up FSI Pages: Previous Page Page Down FSI Pages: Next Page FSI Pages: Last Page NeptuneLabs - FSI Viewer...

  • Page 186: Index Structure Of Fsi Viewer

    The same applies to unregistered FSI Plug-ins or FSI Skins. In this case please check the FSI Viewer debug window ( → Using the Debug Window , which provides information on the licensing status and contact us if the problem persists. NeptuneLabs - FSI Viewer...

  • Page 187: Integration Into Html

    <PARAM name="menu" VALUE="false" /> <PARAM name="allowscriptaccess" value="always" /> <PARAM name="allowfullscreen" value="true" /> <PARAM name="quality" value="high" /> </Object> Embed Tag For browsers (e.g. Netscape 4.x) that do not support the <object>- tag, an additional, encapsulated <embed>-tag with identical parameters is required. NeptuneLabs - FSI Viewer...

  • Page 188: 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 recommended if you plan to display large numbers of images ( → Automated Implementation of Images ). NeptuneLabs - FSI Viewer...

  • Page 189: Using Xml Configuration Files (*.Xml)

    "cfg" parameter attached to the URL of the "fsi.swf" file: Specifying an XML configuration file for FSI Viewer PARAM name="movie" VALUE="/fsi/fsi.swf?cfg=foo"> Configuration files are structured into configuration groups (XML nodes) containing parameter names and values. Only parameters in these groups will NeptuneLabs - FSI Viewer...
  • Page 190 This does not apply when using the debug mode. make sure to save configuration files in UTF- 8 format if your configuration file contains language specific diacritics, Japanese characters and alike NeptuneLabs - FSI Viewer...

  • Page 191: Using Http Queries

    HTTP query you have to prefix parameters with the name of the parameter group they belong to. Prefixing parameters with group names XML Syntax: <image> <path value="foo.tif" /> <servertype value="fsi" /> </image> Equivalent HTTP Query: NeptuneLabs - FSI Viewer...

  • Page 192: Hierarchy Of Configuration Parameters

    Parameters defined in configuration files override parameters defined in the default configuration file "_default.xml". Parameters provided by HTTP query override parameters in all configuration files. The list below shows the hierarchy resulting from the sequential evaluation of the different configuration methods: NeptuneLabs - FSI Viewer...

  • Page 193: Default Configuration

    FSI Viewer instances, like "small_no_interface. xml", "large_with_hotspots.xml" as an example. Try to avoid adding global parameters like the base path to your imaging server "ImageServer" or alike in individual configuration files. This way you will only NeptuneLabs - FSI Viewer...

  • Page 194: Passing Parameters By Http Query

    FSI Viewer is capable of retrieving image specific parameters from FSI Server dynamically. This way you do not need to define these parameters explicitly. The list below shows some typical parameters that can be retrieved from FSI Server automatically: ImageWidth NeptuneLabs - FSI Viewer...

  • Page 195: Parameters

    <PARAM name="movie" VALUE="fsi.swf?cfg=foobar"> In this case the FSI Viewer first searches for the _ default.xml file in the installation folder where the file fsi.swf is located and evaluates the configuration parameters. The optional parameter → FSIBase from the NeptuneLabs - FSI Viewer...
  • Page 196 The URL to your FSI Serve including the servlet name , e .g. : <ImageServer value="http://mydomain.tld/fsi/server" /> If you do not specify this parameter, FSI Viewer will try to determine the URL based on it’s own URL and the default location of the „viewer" folder in the FSI Server setup. NeptuneLabs - FSI Viewer...
  • Page 197 Description Path of the image to display Syntax String Default — Context <Image> Version 5.5.0 or higher The path to the image on your FSI Server including the importer profile name, e.g.: <ImagePath value="images/samples/foo.jpg" /> NeptuneLabs - FSI Viewer...
  • Page 198 The following parameters are not required to run FSI Viewer. They can be used to alter the appearance of the FSI Viewer user interface. skin Description Filename of FSI Skin to use (without extension) Syntax String Default — Context <Options> NeptuneLabs - FSI Viewer...
  • Page 199 Activate the debug mode providing configuration details, warnings and error messages. It is strongly recommended to activate the debug mode when encountering any issues running FSI Viewer. Please refer to the chapter  → 8.12 Debug Mode for a detailed description. NeptuneLabs - FSI Viewer...
  • Page 200 Definition of FSIBase in the _default.xml file <options> <FSIBase value="config/" /> </options> Definition of FSIBase in the _default.xml file <object ...> <PARAM name="movie" VALUE="/fsi/fsi.swf? cfg=viewer_presets/no_nav"> </object> The content of the parameter "CFG" will be prefixed by the parameter "FSIBase" to "config/viewer_presets/no_nav.xml" NeptuneLabs - FSI Viewer...
  • Page 201 Values can be provided as pixel (e.g. "20px") or percent (e.g. "10%") or floating point numbers (e.g. "0.25"). MenuAlign Description Alignment of the menu bar Syntax String Default version 1-4: TL, from version 5: BC Context <Options> Version The "center" option "C" is available from version 5.0.0 Possible values: NeptuneLabs - FSI Viewer...
  • Page 202 Show or hide the optional pan buttons on the image. If the user points at a pan button, the image pans into the direction indicated. The buttons automatically disappear if the edge of the image has been reached. NeptuneLabs - FSI Viewer...
  • Page 203 Hide navigator window if magnification is lower or equal Description to 100% Syntax Boolean Default true Context <Options> Version Show or hide the navigator window displaying the miniature image and the current image section, if the magnification is lower or equal to 100%. NeptuneLabs - FSI Viewer...
  • Page 204 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 navigator window, e.g. "FFFFFF" for white. NeptuneLabs - FSI Viewer...
  • Page 205 Please use the plug-in → SelectFrame to easily retrieve valid values for this parameter. InitialView <Options> <InitialView value="1,5,0,0,0.25,0.25,90" /> </Options> The example displays the top left quarter of the 5th scene in the 1st scene set, rotated 90° to the right. NeptuneLabs - FSI Viewer...
  • Page 206 (rotate around the x-axis to the right 3D only), PreviousSceneSet (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) NeptuneLabs - FSI Viewer...
  • Page 207 URL of custom help page Syntax String Default http://help.fsi-viewer.com Context <Options> 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 parameter. NeptuneLabs - FSI Viewer...
  • Page 208 Syntax Number Default Context <Options> Specifies the selected mouse mode on startup. Possible values: (Zoom) (Pan) (Rotate 3D) (Rotate 2D) Some plug-ins provide additional mouse modes. Please refer to the corresponding plug-in reference → Mousemodes for details. NeptuneLabs - FSI Viewer...
  • Page 209 Shape of the mouse cursor Syntax Boolean Default true Context <Options> If you set this parameter to "false" the default arrow cursor will be used instead of the hand cursor when hovering over the image or the navigator window. NeptuneLabs - FSI Viewer...
  • Page 210 Syntax Boolean Default true Context <Options> Version With this option enabled it is possible to drag lists in addition to using the scroll bar. This can be used for e.g. FSI Showcase thumbnails, FSI Pages index, etc. NeptuneLabs - FSI Viewer...
  • Page 211 This option can be useful if you want the user to pan in one direction only, because the image width matches the view port width or height (e.g. when using FSI Pages with "autozoom=fitWidth" option). NeptuneLabs - FSI Viewer...
  • Page 212 Animate zoom and rotate actions (true) or zoom and rotate in a single step (false). AnimationType Description Defines type of zoom animation Syntax Number Default Context <Options> Version 5.0.0 Defines the type of the zoom animation (acceleration on start or end, bounce, etc.) Possible values are 0 to 6. NeptuneLabs - FSI Viewer...
  • Page 213 FSI Viewers on a single web page. RoundedSkinCorners Description Defines round skin corners Default — Context <Options> Version 5.0.0 Defines the radius of the rounded viewer corners. Possible values range from 0 (no rounded corners) to 99. NeptuneLabs - FSI Viewer...
  • Page 214 FF0000 for red. Use "false" for no border. NoImageBlend Subsequently loaded image details display without Description transition Syntax Boolean Default false Context <Options> Version 1.2.0 or higher If this parameter is activated, subsequently loaded image details are displayed abruptly without transition. NeptuneLabs - FSI Viewer...
  • Page 215 Typical manipulation parameters include the image saturation ("saturation") and image sharpening ("sharpen"). If no effect is specified, the default settings of the server (profile) apply. Please refer to your FSI Server documentation for a list of available effect parameters. NeptuneLabs - FSI Viewer...
  • Page 216 Practical values range from -100 to max. 100 Example – temperature(-100) <effects Example – temperature(100) <effects value="temperature(100)" /> Example "pixelize" The "pixelize" parameter or sharpens images creates a pixel effect by reducing the image details of the images delivered by the imaging server. NeptuneLabs - FSI Viewer...
  • Page 217 Example –pixelize(50) <effects value="pixelize(50)" /> Other effects change, for example, the color saturation, sharpness, hue or contrast. Please refer to your imaging server documentation for a complete description of available image effect commands. Example –brightness(10) <effects value="brightness(10)" /> NeptuneLabs - FSI Viewer...

  • Page 218: Applying Effects To Specific Images Only

    For example it is sometimes useful to sharpen the images inside the navigator window as small images tend to appear a little blurry. To do so you can add a corresponding "NavEffects" parameter. Sharpening Images in the navigator window: <NavEffects value="sharpen(35)"/> NeptuneLabs - FSI Viewer...
  • Page 219 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 NeptuneLabs - FSI Viewer...
  • Page 220 HTTP query. Example: <IgnoreQueryParameters value="language, skin" /> would prevent specifying the "skin" and "language" by HTTP query. Please note: "DefaultCfg", "Cfg" and "Debug" parameters cannot be disabled This parameter itself cannot be specified by query NeptuneLabs - FSI Viewer...
  • Page 221 Syntax Default — Context <Options> If you use NeptuneLabs ZoomCache, please specify the URL of the ZoomCache server here. You can receive this URL and a ZoomCache ID from your image hosting provider. ZoomCacheID Description ID of the ZoomCache access profile...
  • Page 222 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. NeptuneLabs - FSI Viewer...
  • Page 223 FSI Server. These query parameters will be appended to info and list requests passed to the imaging server. ConcurrentRequests Description Number of simultaneous image requests Syntax Number Default Context <Options> Version 2.3.0 or higher Specifies the number of image details (image tiles) being requested simultaneously. NeptuneLabs - FSI Viewer...
  • Page 224 You can for example use the path of the image or the name of a catalog. Do not use the following characters in UniqueIDs: [Space] ~ % & \ ; : " ‘ , < > ? # The → Notepad plug-in for example requires a UniqueID value. NeptuneLabs - FSI Viewer...
  • Page 225 The extension to add can be defined by the "addConfigFileExtension" parameter. Set "addConfigFileExtension" to "false" to never add a file extension. NOTE: FSI Viewer versions before 6.0.0 ALWAYS add ".fsi" to "cfg" parameters, if the value does not already end with ".fsi". NeptuneLabs - FSI Viewer...

  • Page 226: Using Custom Language Files

    You can duplicate existing language files or create new files as needed. To use custom language files, please use the "language" parameter and set the parameter value to the filename without the ".xml" extension. 8.11 Virtual 360° Presentations Preparing 360° Presentations NeptuneLabs - FSI Viewer...
  • Page 227 360° scenes. You can use the parameter → SceneSets to modify the sequence by configuration later on. You can either enter the complete path for each image or use the prefix and suffix attributes to have FSI Viewer assemble the file names from NeptuneLabs - FSI Viewer...
  • Page 228 Fig B: Rotation around Y-axis in 45° Fig A: Rotation around Y-axis in 30° steps and partial rotation around X-axis in steps 4 x 3 = 12 tiles 15° steps 6 x 4 = 24 tiles in 3 scene sets NeptuneLabs - FSI Viewer...
  • Page 229 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: NeptuneLabs - FSI Viewer...

  • Page 230: Parameters For Virtual 360° Presentations

    Add this node to the top level of a configuration file to list the individual images for a 360° presentation. You can add the attributes prefix and suffix instead of providing the complete path for each image individually. NeptuneLabs - FSI Viewer...
  • Page 231 You might want to use the parameter Images3DURLBase in your _default.xml configuration file to specify the URL base for all 360° image list URLs. Images3DPrefix, Images3DSuffix Description Prefix / Suffix to add to the image URLs Syntax String Default — Context <options> Version 4.0.7 NeptuneLabs - FSI Viewer...
  • Page 232 Example: image containing 6 x 4 tiles arranged in 3 scene sets. Even with ‘asymmetrical‘ scene orders - like in the example to the left - the number of tiles would be 6 in the x direction and 4 in the y direction. NeptuneLabs - FSI Viewer...
  • Page 233 Instead of individual scenes you can also specify scene ranges, e.g. "5-10". If you leave out the start or the end of a scene range, 1 or respectively the last scene will be assumed in this case. If you specify a range using "->" the scenes NeptuneLabs - FSI Viewer...
  • Page 234 This parameter can significantly influence loading times and traffic volumes. Setting this parameter to false leads to faster startup times and high resolution scene images will be loaded as soon as they need to be displayed. NeptuneLabs - FSI Viewer...
  • Page 235 No 360° rotation around the y-axis Syntax Boolean Default false Context <options> The first and the last scene set will be considered ending points. (E.g. for partial rotations < 360°). Please note: The blur animation is turned off if NoSetLoop is activated. NeptuneLabs - FSI Viewer...

  • Page 236: Debug Mode

    View the source code of the HTML document and search for the FSI Viewer HTML Code Copy the entire FSI Viewer URL (http://...fsi.swf?..) to the clipboard Paste the URL to the address bar of your browser appending "&debug=1" NeptuneLabs - FSI Viewer...

  • Page 237: Using The Debug Window

    If the Viewer runs in evaluation mode you will be presented the reason why evaluating the licence key failed here. Please refer to the plug-in section for a list of active plug-ins and to the Info section for the domain evaluated by FSI Viewer. Config section NeptuneLabs - FSI Viewer...

  • Page 238: Automated Implementation Of Images

    All subsequent code examples in this section refer to PHP, but can be easily adapted to any other server side scripting language. Steps to be taken when using large numbers of images: NeptuneLabs - FSI Viewer...
  • Page 239 $fsi_query=implode(‘&', $query_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 NeptuneLabs - FSI Viewer...
  • Page 240 <PARAM name=\"movie\" VALUE=\"$fsi_url\" /> <PARAM name=\"bgcolor\" VALUE=\"$bgcolor\" /> <PARAM name=\"menu\" VALUE=\"false\" /> <PARAM name=\"allowscriptaccess\" value=\"always\" /> <PARAM name=\"allowfullscreen\" value=\"true\" /> <PARAM name=\"quality\" value=\"high\" /> <EMBED TYPE=\"application/x-shockwave-flash\" PLUGINSPAGE=\"http://www.macromedia.com/shockwave/download /index.cgi?P1_ Prod_ Version=ShockwaveFlash\" SRC=\"$fsi_ url\" WIDTH=\"$width\" HEIGHT=\"$height\" BGCOLOR=\"$bgcolor\" MENU=\"false\" ALLOWSCRIPTACCESS="always" ALLOWFULLSCREEN="true" QUALITY="high"></EMBED> </Object>"; NeptuneLabs - FSI Viewer...

  • Page 241: Plug-Ins

    The required plug-in files are located in the "/plugins" folder of the FSI setup directory. 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: NeptuneLabs - FSI Viewer...

  • Page 242: Deactivating Plug-Ins

    "false" to the <Options> section of your configuration file or provide a corresponding parameter via HTTP query. Disabling the History Plug-in <Options> NeptuneLabs - FSI Viewer...

  • Page 243: Defining Plug-In Parameters

    /> <Plugin src="zoommeter"> <SRCRelative value="true"/> </Plugin> </Plugins> 8.14.3 Defining Plug-in Parameters dynamically 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 NeptuneLabs - FSI Viewer...
  • Page 244 FSI Viewer configuration files by prefixing the parameter name with the name of the plug-in. This way you can specify plug-in parameters without actually including the plug-in again. Providing plug-in parameters as global parameters <Options> <history_length value="10" /> <Options> NeptuneLabs - FSI Viewer...

  • Page 246: Fsi Pages Add-On

    Parameters for FSI Pages can be provided by adding parameters as attributes or child nodes of the FSI Pages plug- in node. As with all FSI plug- ins, you can additionally provide parameters by adding the parameter to the FSI Viewer query prefixed by "pages_". NeptuneLabs - FSI Viewer...

  • Page 247: Fsi Pages Converter

    By default FSI Pages uses the aspect ratio of the first image in the image collection to determine the aspect ratio for all pages. Alternatively you can manually define an aspect ratio for all pages using the "ratio" parameter. NeptuneLabs - FSI Viewer...

  • Page 248: Layout And Skins

    You can modify the layout of FSI Pages and FSI Viewer using the → MarginBottom, MarginLeft, MarginRight, MarginTop → ViewerMarginBottom, ViewerMarginLeft, ViewerMarginRight, ViewerMarginTop parameters. The following illustrations show the use of these parameters: MarginLeft MarginRight MarginTop MarginBottom Using Margin parameters to define the position of the pages and to provide space NeptuneLabs - FSI Viewer...

  • Page 249: Cropping

    Using ViewerMargin parameters to define the size and position of FSI Viewer inside FSI Pages. Usually you only specify ViewerMarginBottom to provide space for the FSI Pages interface. PageMarginInner PageMarginOuter PageMarginTop CropValue PageNumIndent PageMarginBottom PageNumPos, PageNumSize, etc. PagePaddingBottom 9.5 Cropping CropRect NeptuneLabs - FSI Viewer...

  • Page 250: Defining Image Collections

    → 11 FSI Showcase Add-on collections. There are three different ways of defining image lists: 1. Retrieving automatically generated image lists from FSI Server The most convenient way to create image collections is using the template system of NeptuneLabs - FSI Viewer...
  • Page 251 <!— Passing an encrypted string representing a directory --> <Plugin src="pages" server="..." dir="*XzPzLUFVSHtmeeFxOY0NUU0" /> </Plugins> 3. Creating collections manually using configuration files Creating collections manually using XML configuration files <Images> <Image file="image1.xml" label="My First Image" /> <Image file="image2.xml" label="My Second Image" /> </Images> NeptuneLabs - FSI Viewer...

  • Page 252: Page Reading Order

    Please note that the page adressing does not change so that e.g. setting the → InitialPage parameter to "10" shows the contents on startup independet of the → NeptuneLabs - FSI Viewer...

  • Page 253: Printing

    Please use the FSI Pages parameter → PrintTemplate in this case. You can limit the displayed options of the "Print" dialog using the FSI Pages parameter → PrintOptions . NeptuneLabs - FSI Viewer...

  • Page 254: Saving

    In order to enable the user to download a PDF document containing the page currently viewed in FSI Pages, the XML based data for a page needs to contain the corresponding URL or file name to that document. NeptuneLabs - FSI Viewer...
  • Page 255 For each section you can specify a separate document to offer for download. This way the user will be presented an option to download the current section (chapter) in the "Save" dialog. NeptuneLabs - FSI Viewer...

  • Page 256: Searching In Fsi

    FSI Server and receives an XML based list of matches. Based on these matches FSI Pages presents a list of thumbnails of those pages matching the search criteria. How does FSI Server determine matches? NeptuneLabs - FSI Viewer...
  • Page 257 Parameter → SearchCustomValue Both parameters can – as usual – be specified by query or by adding the parameter to a configuration file. Configuration parameters for external searching <Plugins> <Plugin src="pages" > <SearchCustomURL value= "http://foo.com/search.php" /> <SearchCustomValue value="12345" /> </Plugin> </Plugins> NeptuneLabs - FSI Viewer...

  • Page 258: Hyperlinks

    You might for example want to publish a PDF document containing links. In this case you can use FSI Pages Converter to extract the links from the PDF document and create the required XML data for FSI Pages for you. NeptuneLabs - FSI Viewer...

  • Page 259: Publishing Pdf Documents With Links Using Fsi Pages Converter And Fsi Server

    By default Pages XML page data Converter adds required IPTC data to the output TIFF files. The IPTC data for each page can then automatically be retrieved by FSI Pages using the FSI Server template system. This NeptuneLabs - FSI Viewer...
  • Page 260 Finally you need to provide FSI Pages with the information where the XML files can be found on your web server. Please add the Parameter → XMLBase to your configuration for this purpose. Say the XML files can be accessed via: http://www.myserver.com/xmldata/page01.tif.xml http://www.myserver.com/xmldata/page02.tif.xml … NeptuneLabs - FSI Viewer...
  • Page 261 <pages> node to the configuration file used for a catalog.fsi XML page data page. Note that this method requires an individual configuration file for each page. The example below shows the structure of page data added to a configuration file: NeptuneLabs - FSI Viewer...
  • Page 262 <Text>Some long descriptive text</Text> </Area> <Area tip="Another Tip" url="210"> <Shape coords="0.20,0.73, 0.25,0.73, 0.25,0.72,0.2,0.72" /> </Area> </Links> </Page> <page> node This is the root node for XML page data. The following attributes will be recognized by FSI Pages: NeptuneLabs - FSI Viewer...
  • Page 263 * The prefix and suffix will be used for relative links only. Special links beginning with "javascript:", "mailto:" or "#page=" will be skipped as well. <links> node <Page> <Links URLPrefix="http://foo.com/" DefaultTip="No Tip"> <area>...</area> </Links> </Page> <area> nodes This node represents a link on a page. NeptuneLabs - FSI Viewer...
  • Page 264 A valid shape must at least consist of 6 values (3 points). You can use multiple <shape> nodes in an <area> node if you want to specify multiple shapes for the same link. Attribute Description Comma separated coordinates describing the link shape Coords (see above) NeptuneLabs - FSI Viewer...

  • Page 265: Link Parameters And Hierarchy Of Link Parameters

    9.15 Link Parameters and Hierarchy of Link Parameters FSI Pages provides a number of ways to define link properties. This provides a flexible way to configure links without the need to change the page XML data, but NeptuneLabs - FSI Viewer...
  • Page 266 If the <area> node does not contain an URL attribute, FSI Pages uses the DefaultURL attribute of the parent <links> node. If this attribute is undefined, FSI Pages uses the global FSI Pages Parameter "DefaultLinkURL". The same process applies to the "target", "tip", "prefix", "suffix" and "javascripttarget" parameters: NeptuneLabs - FSI Viewer...

  • Page 267: Relative And Absolute Links

    The same applies to → Special URL Values like "javascript:" and "mailto:" as well as "FSI Pages command URLs" beginning with "#". For relative links FSI Pages adds the URLPrefix and/or URLSuffix values if specified. Relative Link URL <Page> <Links URLPrefix="http://foo.com/" URLSuffix="&test=1"> <Area URL="products.html?id=123">...</Area> NeptuneLabs - FSI Viewer...

  • Page 268: Special Url Values

    Please note that the special links starting with "#" need to be provided exactly as listed in the table above. Using e.g. "#zoomOnPage=[…]" or "foo.html#zoom" will link to the HTML anchor provided rather than executing an FSI Pages action. NeptuneLabs - FSI Viewer...

  • Page 269: Modifying Link Values At Runtime

    Replacing parts of link URLs at runtime Configuration: <Plugins> <Plugin src="pages" > <LinkTemplates value="[SESSION],[DATE]" /> </Plugin> </Plugins> FSI URL .../fsi.swf?LinkTemplateData=somesession,01.01.2010 This will replace all instances of "[SESSION]" by "somesession" and all instances of "[DATE]" by "01.01.2010" in all link URLs. NeptuneLabs - FSI Viewer...

  • Page 270: Page Overlays

    Page overlays are compiled Flash movies clips that can be used as an overlay, floating above a page in FSI Pages. You have probably seen the "Photo Album" example created with FSI Pages atwww.neptunelabs.com. The small sticky photo corners come from an overlay file.

  • Page 271: Fsi Pages Presets In Fsi Server Interface "Publish To Web

    "Publish as FSI Pages" option: Catalog with links Each image represents a page, no page margins, no overlays. If the imagecontains XML data in the "IPTC_FSI" data field, links will be presented on the page. NeptuneLabs - FSI Viewer...

  • Page 272: Event Notifications And Actions

    When using JS Bridge plug- in or FSI Viewer component you can use the following event notifications and actions to interact with FSI Pages Add-on. Please refer to JS Bridge plug- in for details on how to setup communication between JavaScript and FSI Viewer. NeptuneLabs - FSI Viewer...
  • Page 273 (true) or hides (false) the page index. Called each time the user starts onPagesShowZoom Boolean (true) or ends (false) page zoom. Called each time the user clicks a onPagesLinkClick link. The parameter contains the URL. Commands for FSI Pages Add-on NeptuneLabs - FSI Viewer...

  • Page 274: Parameters To Retrieve Image Collections

    Exit zoom view ShowHidePageIndex Show or hide the page index (thumbnail view) 9.22 Parameters to retrieve Image Collections Server Description Address of imaging server Syntax Default — Context Pages plug-in node or HTTP query prefixed with "pages_" NeptuneLabs - FSI Viewer...
  • Page 275 FSI Pages 3.3.0 or higher, FSI Pages mobile 1.0.0 Using this parameter you can add blank pages. The value of the parameter must contain one or more image page numbers of the blank pages to be inserted. E.g. NeptuneLabs - FSI Viewer...
  • Page 276 Set this parameter to "true" to reverse the page sequence of pages. Please note that this parameter does not change the reading order. Please see → Page Reading Order to change the reading order of a document. NeptuneLabs - FSI Viewer...

  • Page 277: Basic Parameters

    , e.g. for Arab documents. FirstPageNumber Description Offset for page numbering Syntax Number Default Context Pages plug-in node or HTTP query prefixed with "pages_" Version FSI Pages 3.0.0, FSI Pages mobile 1.0.0 NeptuneLabs - FSI Viewer...
  • Page 278 Default true Context Pages plug-in node or HTTP query prefixed with "pages_" Version FSI Pages 3.0.0, FSI Pages mobile 1.0.0 Enable (true) or disable (false) the user to show the page index containing thumbnails of all pages. NeptuneLabs - FSI Viewer...
  • Page 279 Version Defines the animation when flipping to another page. "flip" is the default and shows a page turn effect. "slide" slides the pages as if they were positioned next to each other (like in FSI Pages mobile). NeptuneLabs - FSI Viewer...
  • Page 280 Pages plug-in node or HTTP query prefixed with "pages_" Version 3.5.0 or higher, FSI Pages mobile 1.0.0 Enable (true) this option to automatically crop images to fill the entire pages. You need to specify an aspect ratio manually in this case. NeptuneLabs - FSI Viewer...
  • Page 281 Defines the animation speed of in place maginifications Description initiated by "#zoomarea" hyperlinks Syntax Number Default Context Pages plug-in node or HTTP query prefixed with "pages_" Version 5.0.0 or above Defines the speed of the zoom animation when zooming out. NeptuneLabs - FSI Viewer...
  • Page 282 Enable or disable interactivity in double page zoom mode Syntax Boolean Default false Context Pages plug-in node or HTTP query prefixed with "pages_" Version 5.0.0 When enabled the image will scroll when the user moves the mouse pointer. NeptuneLabs - FSI Viewer...
  • Page 283 Pages plug-in node or HTTP query prefixed with "pages_" Version With this option enabled you can drag the image while being in double page zoom mode. Otherwise, the double page zoom moves according to the mouse position. NeptuneLabs - FSI Viewer...

  • Page 284: Parameters For The Front- And

    Context Pages plug-in node or HTTP query prefixed with "pages_" Version 3.5.5 or higher Setting "BackCover" parameter to false disables access to the back cover and forces FSI Pages to add a blank content page if required. NeptuneLabs - FSI Viewer...
  • Page 285 A path to an image to use for the front or back cover. FSI Pages will use the → FSIBase parameter of FSI Viewer for relative paths. The cover page(s) will be added to the images in the image list. NeptuneLabs - FSI Viewer...
  • Page 286 The path to an image on your imaging server to be used as a background. If you use a relative path (recommended) the → FSIBase parameter will be used to get the absolute path to the image. NeptuneLabs - FSI Viewer...

  • Page 287: Parameters Defining Layout And Appearance

    By default FSI Pages creates a page for each image in the image collection. Using this parameter you can advise FSI Pages to use images on even or uneven pages only, inserting a blank page on the opposite side. NeptuneLabs - FSI Viewer...
  • Page 288 Pages plug-in node or HTTP query prefixed with "pages_" Version 4.0.0 or above Defines the 3D effect level of the pages in percent. Using a value of "0" disables the visual 3D effect. The value additionally affects the opacity of the drop shadow. NeptuneLabs - FSI Viewer...
  • Page 289 Alignment of the images on the pages. The default is "TC" which centers the images horizontally on top of the page. Please specify the alignment for even (left) pages. Uneven (right) pages will be aligned correspondingly. Possible values are any combination of: NeptuneLabs - FSI Viewer...
  • Page 290 Color of the page borders specified as 6 digit web color.Use "false" for no border at all. HelpImageURL Description Help image to be displayed left of the first page Syntax String Default — Context Pages plug-in node or HTTP query prefixed with "pages_" Version 3.6.0 or above NeptuneLabs - FSI Viewer...
  • Page 291 Color for the scroll bar's track bar Syntax HexColor Default DDDDDD Context Pages plug-in node or HTTP query prefixed with "pages_" Version 3.5.0 or higher 6-digit hex-color for the track bar of the scroll bar in the page index. NeptuneLabs - FSI Viewer...
  • Page 292 Pages plug-in node or HTTP query prefixed with "pages_" Margin on each side of FSI Viewer in pixel when zooming into a page. Usually you need to set "ViewerMarginBottom" to the height of the FSI Pages interface. NeptuneLabs - FSI Viewer...
  • Page 293 Context Pages plug-in node or HTTP query prefixed with "pages_" Show or hide page numbers on pages. PageNumPos Description Alignment of page numbers Syntax String Default "BL" Context Pages plug-in node or HTTP query prefixed with "pages_" NeptuneLabs - FSI Viewer...
  • Page 294 Pages plug-in node or HTTP query prefixed with "pages_" Size of page numbers in percent of the page height. PageNumColor Description Color of page numbers Syntax HexColor Default 000000 Context Pages plug-in node or HTTP query prefixed with "pages_" 6-digit hex color of page numbers. NeptuneLabs - FSI Viewer...
  • Page 295 Note that you can use the Parameter → FirstPageNumber to offset all page number values. RomanPageNumbersOffset Description Offset Roman page numbers by given value Syntax Number Default Context FSI Pages Version FSI Pages 5.0.4, FSI Pages mobile 1.0.0 Defines the value of the first Roman page number. NeptuneLabs - FSI Viewer...
  • Page 296 Same as CustomPageNumbers, but the page number values will be loaded from an XML file. You can either define a path relative to the fsi/config/pages_xml/ directory or an absolute URL. The required format of the XML file is as follows: <fsi> <pagenumbers>3,6,7</pagenumbers> </fsi> NeptuneLabs - FSI Viewer...

  • Page 297: Parameters For Links

    Pages plug-in node or HTTP query prefixed with "pages_" Version 3.5.0 or higher, FSI Pages mobile 1.0.0 Specify the opacity of the link areas from 0 (no fill) to 100 (opaque). The color corresponds to the color of the link area‘s border color. NeptuneLabs - FSI Viewer...
  • Page 298 "00FF0099" for semi-transparent green LinkRGBAActive Description Color and opacity of links in active state Syntax RGBA Default FF0000FF Context Pages plug-in node or HTTP query prefixed with "pages_" Version FSI Pages 3.0.0, FSI Pages mobile 1.0.0 NeptuneLabs - FSI Viewer...
  • Page 299 Note: this parameter does not affect "javascript:" and "mailto:" links. ForceJavascriptTarget Description Force a target frame for all "javascript:" links on pages Syntax String Default — Context Pages plug-in node or HTTP query prefixed with "pages_" Version FSI Pages 4.1.1 or above, FSI Pages mobile 1.0.0 NeptuneLabs - FSI Viewer...
  • Page 300 Pages plug-in node or HTTP query prefixed with "pages_" Version FSI Pages 3.6.0 or above, FSI Pages mobile 1.0.0 Force FSI Pages to use this tool tip for all links on the pages. This overwrites any tool tips specified in the page data. NeptuneLabs - FSI Viewer...
  • Page 301 Pages plug-in node or HTTP query prefixed with "pages_" Version FSI Pages 4.1.1 or above, FSI Pages mobile 1.0.0 Use this HTML target frame for "javascript:" links if no target frame has been specified in the page data. NeptuneLabs - FSI Viewer...
  • Page 302 The identifiers are case sensitive and must be separated by commas. The values to insert have to be defined by the parameter "LinkTemplateData" explained below. Please refer to the chapter → 9.18 Modifying Link Values at Runtime above for details. NeptuneLabs - FSI Viewer...

  • Page 303: Parameters For Fsi Pages Thumbnails

    Show / hide the user interface Syntax Bool Default true Context Pages plug-in node or HTTP query prefixed with "pages_" Version FSI Pages 3.0.0, FSI Pages mobile 1.0.0 Show (true) or hide (false) the user interface of FSI Pages add-on. NeptuneLabs - FSI Viewer...
  • Page 304 IdleAutoTurnMinPage IdleAutoTurnMaxPage. This way you can restrict the auto flip to a range of pages. If the initial page is outside the range specified, FSI Pages flips towards the range before looping between the range specified. NeptuneLabs - FSI Viewer...
  • Page 305 3.5.5 or higher HTML frame in which to open the URL specified by "DemoURL" parameter in. You can use default frame names like "_ self" or "_blank" or use a custom frame of your HTML frame set. NeptuneLabs - FSI Viewer...
  • Page 306 Defines whether the input form for page numbers is shown. ButtonsFirstLastPage Description Show or hide First/Last Page buttons Syntax Boolean Default true Context Pages plug-in Version 4.0.0 or higher Defines whether the navigation buttons for jumping to the first or last page are shown. NeptuneLabs - FSI Viewer...

  • Page 307: Parameters For Statistics

    [action] &page= [pagenum] &targetpage= [targetpage] &uniqueid= [uniqueid] &totaltime= [totaltime] &IID= [instanceid]&targeturl=[hyperlinkurl] You can alternatively call a Javascript function using the "javascript:" syntax. In this case you need to define a valid HTML target frame using the "PageLogTarget" parameter. NeptuneLabs - FSI Viewer...
  • Page 308 4.1.3 or higher By default FSI Pages uses the special target "_internal" which loads the URL from within the Flash plug- in. You can use this parameter to specify a different HTML target frame like "_self" or "_top". NeptuneLabs - FSI Viewer...

  • Page 309: Advanced Parameters

    → Dir parameter to identify the image collection automatically. If you create image collections manually, you additionally need to add the parameter → UniqueID so that the "last viewed page" can be assigned to this image collection. NeptuneLabs - FSI Viewer...
  • Page 310 If you do not specify this parameter FSI Viewer displays the entire image. PreloadForward Description Number of pages to pre-cache Syntax Number Default Context Pages plug-in node or HTTP query prefixed with "pages_" NeptuneLabs - FSI Viewer...
  • Page 311 Pages plug-in node or HTTP query prefixed with "pages_" Version 4.1.3 Defines the minimum time each page is being held in memory after it has been viewed the last time. Set this parameter to "0" to remove pages exceeding the "PageCacheLimit" immediately. NeptuneLabs - FSI Viewer...
  • Page 312 <Plugin src="pages" > <PageOverlays> <Overlay default="true" file="ov_photo.swf" /> <Overlay page="5" file="myOverlay1.swf" posX="6" posY="12"/> <Overlay page="21" file="myOverlay2.swf" posX="0" posY="98"/> </PageOverlays> </Plugin> </Plugins> The example defines the default overlay "ov_ photo- swf" and defines individual overlays for pages 5 and 21. NeptuneLabs - FSI Viewer...
  • Page 313 XML files rather than using IPTC data by setting the → ForceXMLDataFiles parameter to "true". The complete URL to load the XML file from will be created based on the XMLBase parameter value plus the image path with an ".xml" extension. Example: NeptuneLabs - FSI Viewer...
  • Page 314 Context Pages plug-in node or HTTP query prefixed with "pages_" Version 3.5.0 or higher Enable or disable the user to print the content of the current page. Please refer to the chapter → Printing Pages for details. NeptuneLabs - FSI Viewer...
  • Page 315 Defines image modification parameters to apply to images used for printing. The value of this parameter depends on the imaging server being used. With FSI Server you can sharpen the image and define the JPEG compression level, e.g. "effects=sharpen(230)&quality=95". NeptuneLabs - FSI Viewer...
  • Page 316 URL to a document containing all pages displayed in an FSI Pages instance. This is the URL the user will be redirected to when choosing the "Entire Document" option in the "Save" dialog. Please refer to the chapter → Saving Pages for details. NeptuneLabs - FSI Viewer...
  • Page 317 This parameter overrides the download URL specified in the "file" attribute of the page‘s XML data. Specifying this parameter forces FSI Pages to use the same download URL for all pages. Please refer to the chapter → Saving Pages for details. NeptuneLabs - FSI Viewer...
  • Page 318 Please refer to the chapter → Saving Pages for details. SaveEffects Description Image effects for the image to download Syntax String Default — Context Pages plug-in node or HTTP query prefixed with "pages_" Version 4.0.0 or higher NeptuneLabs - FSI Viewer...
  • Page 319 Using the parameter value: left,right enables saving the left or right page only. Please note that the options might as well not appear, if there is no data available or specified to download for any of these options. Please refer to the chapter → Saving Pages for details. NeptuneLabs - FSI Viewer...
  • Page 320 "iptc.fsi_search_data,iptc.caption, iptc.fsi_extra" Context plug-in node or HTTP query prefixed with "pages_" Version 5.5.6 or higher (FSI Server only) Comma separated list of meta data fields names to search in. FSI Server with FSI Viewer parameter SearchType="simplesearch" only. NeptuneLabs - FSI Viewer...
  • Page 321 Search Complete Action Syntax Boolean Default true Context Pages plug-in node or HTTP query prefixed with "pages_" Version 5.5.4 Select the first search result item when the search is complete (true, default) or just show the results (false). NeptuneLabs - FSI Viewer...
  • Page 322 Pages plug-in node or HTTP query prefixed with "pages_" Version 4.1.5 or higher Setting this parameter to "true" makes FSI Pages add quotes to search requests so that only exact matches will be returned. Setting this parameter implicitly disables the → SearchAutoWildCards parameter. NeptuneLabs - FSI Viewer...
  • Page 323 A custom string to pass to the server along with the search request. This option is useful when using a server other than FSI Server to return search results. Please refer to the chapter → Searching in FSI Pages for details. NeptuneLabs - FSI Viewer...
  • Page 324 Please refer to the chapter → Searching in FSI Pages for further details. SearchResultServerTemplate Description Template for the search result Syntax String Default pages_searchresult" (FSI Server) Context Pages plug-in node or HTTP query prefixed with "pages_" Version 5.5.5 or higher Specifies the server template to request in search queries. NeptuneLabs - FSI Viewer...
  • Page 325 Context Pages plug-in node or HTTP query prefixed with "pages_" Using this parameter you can enable or disable plug- in event notifications e.g. for the JS Bridge plug-in. Please see → JavaScript Bridge Plug-in for details. NeptuneLabs - FSI Viewer...
  • Page 326 Specifies the size of the interactive outer page edges you can use to flip pages. You can either specify the size in pixels or in percent of the page width. Setting this parameter to "0" disables interactive page flipping by dragging the page edges. NeptuneLabs - FSI Viewer...

  • Page 328: Fsi Pages Mobile

    Unsupported parameters will be ignored by FSI Pages mobile, thus it does not require additional configuration to publish your images on mobile devices as well. Please refer to the FSI Pages parameter list to see whether a certain parameter is supported by FSI Pages mobile. Requirements NeptuneLabs - FSI Viewer...

  • Page 329: Pages Mobile Parameters

    Help image to be displayed left of the first page Syntax String Default _service/FSI Pages mobile/instructions/landscape.tif Context Pages Version FSI Pages mobile 1.0.0 An absolute or relative ImageURL that FSI Pages mobile displays left of the first page of the catalog in landscape format. NeptuneLabs - FSI Viewer...
  • Page 330 Adds the option "Close Window" to the menu. DeferLinksToOpener Description redirects links in FSI Pages mobile to the opener window Syntax Boolean Default false Context FSI Pages mobile Version FSI Pages mobile 1.0.0 Redirects links in FSI Pages mobile to the opener window. NeptuneLabs - FSI Viewer...

  • Page 331: Pages Mobile Plug-In Attribute Targetdevice

    Defines whether a plug- in should be loaded on the desktop Flash application, the mobile device, or both of them. Plug- ins have default values according to the availability on each platform, so this should not be changed unless you know what you are doing. NeptuneLabs - FSI Viewer...

  • Page 332: Fsi Showcase Add-On

    XML configuration file. The format and options of the collections is the same as the collections for FSI Pages Add-on. There are three different ways of defining image lists: 1. Creating image nodes referencing external XML configuration files NeptuneLabs - FSI Viewer...
  • Page 333 <FPX> <SRC value="image2.fpx" /> <Width value="8096" /> <Height value="12300" /> </FPX> <Options> <NoNav value="true" /> </Options> </Image> </Images> 3. Retrieving automatically generated image lists from a server Complete XML configurations <Plugins> <Plugin src="showcase" server="..." dir="..." /> </Plugins> NeptuneLabs - FSI Viewer...
  • Page 334 (3) or in the <image> node of the image list (4). Due to the hierarchy displayed above parameters declared by query override all other parameter definitions. This can be especially useful if you want to override NeptuneLabs - FSI Viewer...

  • Page 335: Fsi Showcase Layout

    The figures to the left 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 FSI Viewer parameter "MenuAlign". NeptuneLabs - FSI Viewer...
  • Page 336 "BaseColor" instead. You can rescale the thumbnail using the parameter "BaseScale". Thumbnail Framework Thumbnail Labels ImageMarginX ImageWidth ImageMarginX ImageMarginY ImageBorder Image Image ImageHeight LabelTextSize ThumbLabel Line two LabelSpaceY ImageMarginY LabelMarginBottom ThumbLabel EdgeRadius LabelSpaceX LabelSpaceX NeptuneLabs - FSI Viewer...

  • Page 337: Showcase Parameters

    Example – Parameter provided as child nodes <Plugins> <Plugin src="showcase" > <Layout value="Outside" /> <Align value="Left" /> </Plugin> </Plugins> c) By HTTP query value prefixed with "showcase_" Example – Parameter provided by query <Param name="movie" value="fsi.swf?showcase_layout=Outside"> The following values can be used: NeptuneLabs - FSI Viewer...

  • Page 338: Basic Parameters

    Showcase plug-in node or HTTP query prefixed with Context "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 NeptuneLabs - FSI Viewer...
  • Page 339 "left", "top", "right", "bottom" Default "right" Showcase plug-in node or HTTP query prefixed with Context "showcase_" Defines the position of the thumbnail bar. Please note that the orientation of a possible scrollbar can be defined by the parameter "HScroll". NeptuneLabs - FSI Viewer...
  • Page 340 Boolean Default false Showcase plug-in node or HTTP query prefixed with Context "showcase_" false Arrange thumbnails vertically and use a vertical scroll bar if required true Arrange thumbnails horizontally and use a horizontal scroll bar if required NeptuneLabs - FSI Viewer...
  • Page 341 A floating point value defining the width of the drag bar of the thumbnail bar. DragMenu Description Show/Hide the buttons in the thumbnail bar Syntax Boolean Default true Showcase plug-in node or HTTP query prefixed with Context "showcase_" NeptuneLabs - FSI Viewer...
  • Page 342 Description Image selected at startup Syntax Number Default Showcase plug-in node or HTTP query prefixed with Context "showcase_" The index of the image selected on startup. Enter the index of the image from 1 to n images. NeptuneLabs - FSI Viewer...
  • Page 343 "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, it does not have an impact on active and selected thumbnails. NeptuneLabs - FSI Viewer...

  • Page 344: Imagelist Parameters

    Experienced users might additionally edit the server template files used to generatethe image list. The corresponding file is located in the ‘WEB- INF/templates/list/‘ directory of your FSI Server: Filename Description Creates the <Images> section of the Showcase image_list.xml configuration NeptuneLabs - FSI Viewer...
  • Page 345 This parameter can be omitted if the Showcase has been installed to the default location on the imaging server. Please note: Loading configurations across domain boundaries will fail due to a security restriction of the Adobe Flash™ plug-in. NeptuneLabs - FSI Viewer...

  • Page 346: Advanced Parameters

    Please note that you can easily change the color 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". NeptuneLabs - FSI Viewer...
  • Page 347 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 Showcase plug-in node or HTTP query prefixed with Context "showcase_" Defines a color for the scroll bar. NeptuneLabs - FSI Viewer...
  • Page 348 DragBarHighlight Description Highlight color of the drag bar Syntax HexColor Default Derived from BaseColor Showcase plug-in node or HTTP query prefixed with Context "showcase_" Version 3.5.0 or higher Defines the highlight color of the drag bar. NeptuneLabs - FSI Viewer...
  • Page 349 Syntax Pixel Default Showcase plug-in node or HTTP query prefixed with Context "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. NeptuneLabs - FSI Viewer...
  • Page 350 Thickness of the border around the thumbnail image Syntax Pixel Default Showcase plug-in node or HTTP query prefixed with Context "showcase_" Defines the thickness of the border around the thumbnail image. Setting this parameter to "0" disables the image border. NeptuneLabs - FSI Viewer...
  • Page 351 This value can be either defined as a solid color (e.g. "00FF00") or as a linear color transition from top/left to bottom/right by entering two color values separated by comma (e.g. "FF0000, 00FF00"). The corresponding parameters for active and selected state are: ThumbActiveFace and ThumbSelectedFace . NeptuneLabs - FSI Viewer...
  • Page 352 Showcase plug-in node or HTTP query prefixed with Context "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 . NeptuneLabs - FSI Viewer...
  • Page 353 Showcase plug-in node or HTTP query prefixed with Context "showcase_" This value defines the margin in pixels 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. NeptuneLabs - FSI Viewer...
  • Page 354 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: NeptuneLabs - FSI Viewer...
  • Page 355 The string may contain basic HTML tags (see → HTML Tags available in FSI Viewer ) to format the text. Additionally you can add templates being replaced at runtime. Please see → LabelTemplates parameter below for details. NeptuneLabs - FSI Viewer...
  • Page 356 1. SomeImageName.tif Size: 2048 x 1024 px The two templates <ImageIndex/> and <ImageLabel /> are built- in templates containing the numeric index of an image and the "label" attribute of the <image> node of the image list. NeptuneLabs - FSI Viewer...
  • Page 357 Showcase plug-in node or HTTP query prefixed with Context "showcase_" Align the thumbnail labels left, centered, or right in the availabel space for label texts. This value has no effect if the contents of a label contains <p align="[alignment] "></p> tags. NeptuneLabs - FSI Viewer...
  • Page 358 LabelMarginBottom and LabelMarginTop Description Margin above/below the thumbnail text Syntax Pixel Default Showcase plug-in node or HTTP query prefixed with Context "showcase_" You can use this value to add additional space above (LabelMarginTop) or below (LabelMarginBottom) the thumbnail text. NeptuneLabs - FSI Viewer...
  • Page 359 4.1.3 You can use this value to adjust the horizontal position of the text area of the thumbnail. Negative values move the text area to the left while positive values move the text area to the right. NeptuneLabs - FSI Viewer...
  • Page 360 3.5.0 or higher Automatically crop images to match the dimensions of the thumbnails. KeepImageSection Description Preserve the view when selecting thumbnails Syntax Boolean Default false Showcase plug-in node or HTTP query prefixed with Context "showcase_" Version 3.5.0 or higher NeptuneLabs - FSI Viewer...
  • Page 361 Usually FSI Showcase displays the entire image (or the image section specified by the parameter "InitialView") when selecting a thumbnail. Set this parameter to "true" to if you want to preserve the image section you are currently viewing when selecting another image. NeptuneLabs - FSI Viewer...

  • Page 362: Plug-In Reference

    The Plug-in Extends section lists the available plug-ins for FSI Viewer and Addons and what each plug-in extends. Please note that any plug-in that extends FSI Viewer may also affect FSI Pages in page zoom mode, as page zoom mode is FSI Viewer technically. NeptuneLabs - FSI Viewer...

  • Page 363: Addthis

    This value defines your AddThis username to login the AddThis service. TargetFrame Description defines the HTML frame to open the AddThis page in Syntax String Default — Context Plug-in tag This value defines the HTML frame to open the AddThis page in. NeptuneLabs - FSI Viewer...
  • Page 364 This value defines whether the service names in the dialog should be displayed. ShowTooltips Description defines whether tooltips should be displayed. Syntax Boolean Default false Context Plug-in tag This value defines whether tooltips describing the services should be displayed. NeptuneLabs - FSI Viewer...
  • Page 365 Syntax String Default Context Plug-in tag Comma seperated string: defines which services should be used. To get a list of all service codes available, please see the "listServices" parameter or visit the AddThis website. NeptuneLabs - FSI Viewer...
  • Page 366 Plug-in tag Comma seperated string: services to display first Default: "facebook_like,google_plusone_ share,twitter,email,stumbleupon,reddit,tumblr,pinterest,linkedin, blogger,delicious,wordpress,friendfeed,livejournal" RemoveServices Description defines whether tooltips should be displayed Syntax String Default Context Plug-in tag Comma seperated string: services to hide in the list Example:"twitter,hyves,google,email,facebook,linkedin" NeptuneLabs - FSI Viewer...
  • Page 367 This value defines the SWF file containing service icons and details. Details on the BoomarkURL: By default the plug-in uses the URL of the container HTML document if possible. You can on the other hand specify any other URL. NeptuneLabs - FSI Viewer...
  • Page 368 Viewer instance, but you can instead bookmark a specific page of the FSI Pages instance. All you need to do is extracting the "FSIPassthrough" query value from the documents URL and add this parameters to the FSI Viewer instance (e.g. in the writeFlashCode() Javascript call). NeptuneLabs - FSI Viewer...

  • Page 369: Backgroundimage

    Plug-in tag The path to an image on your imaging server to be used as a background. If you use a relative path (recommended) the FSIBase parameter will be used to get the absolute path to the image. NeptuneLabs - FSI Viewer...
  • Page 370 Optional effect parameters to pass to the imaging server Syntax String Default — Context Plug-in tag Like with the → Effects parameter for FSI Viewer itself you can optionally pass image effect parameters to your imaging server that affect the appearance of the background image. NeptuneLabs - FSI Viewer...

  • Page 371: Chapters

    <Index label="Chapter 1" page="10" color="00FF00"> <Index label="Chapter 1.1" page="20" color="00FF00"/> <Index label="Chapter 1.2" page="30" color="00FF00"/> <Index label="Chapter 1.3" page="40" color="00FF00"/> </Index> <Index label="Chapter 2" page="50" color="0000FF"/> <Index label="Chapter 3" page="60" color="CCCCCC"/> <Index label="Chapter 4" page="70" color="FF0000"/> </Indexdata> Plug-in Parameters NeptuneLabs - FSI Viewer...
  • Page 372 (characters >= 0x80). Withversion 2016 of FSI Server, it is possible to set this parameter to "auto" in order to request the information from the server instead of loading the information from the file. NeptuneLabs - FSI Viewer...
  • Page 373 Syntax Boolean Default true Context Plug-in attribute Display the color specified in the document structure XML data in front of the chapter labels. IndexMarginWidth Description Width of the colored page index Syntax Number Default Context Plug-in attribute NeptuneLabs - FSI Viewer...
  • Page 374 "false" to use the order in which the index items are listed in the XML file. Update Description Update the selected index on page flip Syntax Boolean Default true Context Plug-in attribute Version 4.1.5 or above NeptuneLabs - FSI Viewer...
  • Page 375 6-digit hexcolor for use with "ColoredIndex" parameter An absolute or relative URL to an MP3 file to play for this chapter (from version 4.0.7). musicSong Please note that you need to add the plug-in "music" as well in this case. NeptuneLabs - FSI Viewer...

  • Page 376: Clockprogress

    The following attributes can be used to customize the clockprogress plug-in: Alpha Description Opacity of progress indicator Syntax Number Default Context Plug-in attributes Defines the opacity of the progress indicator. Possible values range from 0 to 100. transparent 100: opaque NeptuneLabs - FSI Viewer...
  • Page 377 Color of the area representing the amount of data already Description loaded Syntax HexColor Default FFFFFF Context Plug-in attributes A 6- digit hexadecimal number defining the color of the area representing the amount of data already loaded. NeptuneLabs - FSI Viewer...
  • Page 378 Horizontal Position Syntax String / Number Default Depends on MenuAlign parameter Context Plug-in attribute Defines the horizontal position of the progress indicator. Possible values: Centered horizontally Number > 0 Offset from left Number < 0 Offset from right NeptuneLabs - FSI Viewer...
  • Page 379 Vertical position Syntax String / Number Default Depends on MenuAlign parameter Context Plug-in attribute Defines the vertical position of the progress indicator. Possible values: Centered vertically Number > 0 Offset from top Number < 0 Offset from bottom NeptuneLabs - FSI Viewer...

  • Page 380: Coloradjust

    Boolean Default true Context ColorAdjust Version 5.0.0 Hides the interface dialog when changing values. Blue, Green, Red Description Blue value, Green value, Red value Syntax Float Default Context ColorAdjust Version 5.0.0 Amount of blue, green and red. NeptuneLabs - FSI Viewer...
  • Page 381 SetValuesForEachImage Description Save Values for each image seperately Syntax Boolean Default false Context ColorAdjust Version 5.0.0 If enabled, the color values can be set for each image. If disabled (default) the values are used for all images. NeptuneLabs - FSI Viewer...
  • Page 382 12 Plug-in Reference ShowUI Description Show Interface Syntax Boolean Default true Context ColorAdjust Version 5.0.0 If disabled, the user interface will be hidden, enabling the effects. NeptuneLabs - FSI Viewer...

  • Page 383: Contextmenu

    About FSI Viewer... <Plugin src="contextmenu" /> This plug-in does not provide any parameters. You can on the other hand translate the menu items or additional items. The example below shows the built- in configuration of this plug-in. NeptuneLabs - FSI Viewer...
  • Page 384 <Item label="Zoom out" action="ZoomOut"/> </MenuItems> </Plugin> Plug-in Parameters MenuItems Description Refers to the XML describing the context menu entries Syntax String Default — Context Plug-in tag Version 5.0.0 Defines the XML snippet describing the context menu. NeptuneLabs - FSI Viewer...

  • Page 385: Custombutton

    Number in pixel Default 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 NeptuneLabs - FSI Viewer...
  • Page 386 ("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 NeptuneLabs - FSI Viewer...
  • Page 387 Specifies the tool tip to be displayed when the user places the cursor above the custom button named "[ID]". [ID].LabelFrame Description Symbol displayed on the button Syntax Number Default Context Plug-in Tag Specifies the symbol to be displayed on top of the custom button named "[ID]". The predefined symbols are: NeptuneLabs - FSI Viewer...
  • Page 388 JavaScript function or a server side script. Templates in CustomButton URLs <Plugin src="custombutton" buttons="btn1" btn1.URL="javascript:alert ("$$cfg.FPXWidth$$  $$cfg.FPXHeight$$'')" /> The example above outputs the size of the source image via JavaScript. NeptuneLabs - FSI Viewer...
  • Page 389 Current magnification relative to the initial size of the $$Zoom$$ image. A string representing the current selection $$Selection$$ (requires plug-in SelectFrame) A string representing the current measurement $$Measure$$ (requires plug-in Measure) NeptuneLabs - FSI Viewer...

  • Page 390: Fullscreen

    12 Plug-in Reference 12.8 Fullscreen Plug-in Extends: • FSI Viewer • FSI Showcase • FSI Pages • FSI Viewer JS • FSI Showcase JS Plug-in Location for Flash viewers: /plugins/fullscreen.swf Function: switch to fullscreen mode Syntax: <Plugin src="fullscreen" /> Viewer 100 % If using the object tag when embedding FSI Viewer, please note the parameter allowfullscreen has to be set as shown.
  • Page 391 NOTE: If the FSI Viewer JS is embedded in an iFrame, the attribute allowfullscreen="true" needs to be added to the iFrame. Otherwise the FullScreen Plug-in will not work due to security restrictions of the browser. NeptuneLabs - FSI Viewer...

  • Page 392: History

    Specifies the space in pixels left of the menu button(s) of the plug-in. Length Description Length of the history list Syntax Number Default Context Plug-in tag The number of image sections that will be stored in the view history from 1 to 99. NeptuneLabs - FSI Viewer...
  • Page 393 Size of menu buttons Syntax Boolean 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...

  • Page 394: Hotspots

    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" /> Defining the HotSpots Section NeptuneLabs - FSI Viewer...
  • Page 395 Defines the initial visibility of HotSpots. The HotSpot button state will be set accordingly. NOTE: also applies to FSI Viewer JS. All other parameters below solely apply to the Flash based viewers. For HotSpot configuration in FSI Viewer JS, please go to: → <hotspots3d> Section NeptuneLabs - FSI Viewer...
  • Page 396 The event value for event 1-3 is the hot spot’s tool tip or – if defined – the hot spot node’s "id" attribute. The event value for event 4 depends on the hot spot action and can be: NeptuneLabs - FSI Viewer...
  • Page 397 HTML frameset. DefaultMove Description Zoom to HotSpot area by default Syntax Bool Default true Context Plug-in attribute or <HotSpots> group tag Defines the default value for all subsequent HotSpots that do not contain the "Move" attribute. NeptuneLabs - FSI Viewer...
  • Page 398 Plug-in attribute or <HotSpots> 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 be shown as outlines by default. NeptuneLabs - FSI Viewer...
  • Page 399 "spot attribute which defines the position of the HotSpot. The tag name of each definition specifies the shape of the HotSpot. Available default shapes include: - rect (Square / Rectangle) - circle (Circle / Ellipse) - star (Star) (Polygon of n straight - polygon lines) NeptuneLabs - FSI Viewer...
  • Page 400 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 for more information on this parameter. NeptuneLabs - FSI Viewer...
  • Page 401 Please refer to the chapter → Hotspot Authoring for more information on this parameter. 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. NeptuneLabs - FSI Viewer...
  • Page 402 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. NeptuneLabs - FSI Viewer...
  • Page 403 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. NeptuneLabs - FSI Viewer...
  • Page 404 "image2.xml" 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. NeptuneLabs - FSI Viewer...
  • Page 405 Although you can define hotspot parameters manually, it is recommended to use the FSI Server web interface to edit hotspots. Obtaining Hot Spot positions Include the plug- in "SelectFrame" by adding the following parameters to the "_ default.xml" or any other configuration file. NeptuneLabs - FSI Viewer...
  • Page 406 <HotSpots> <Polygon spot="1,1" coords="0.5,0 ,1,0 ,1,0.5, 0.5,0.5" /> </HotSpots> Please note that the "spot" attribute is required only, if you want to specify the target scene and/or scene set for the hotspot when using a 3D image. NeptuneLabs - FSI Viewer...
  • Page 407 HotSpots in mind. The z- order of HotSpots 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 beneath. NeptuneLabs - FSI Viewer...

  • Page 408: Imprint

    <head>...</head> or <body>..</body> tags defined. Please see the FSI Pages mobile Technotes for styling instructions on www.neptunelabs.com. Please note: You need to use an external XML file in UTF- 8 format when using special language specific characters (characters >= 0x80). NeptuneLabs - FSI Viewer...
  • Page 409 FALSE if FSI Pages is activated. MenuOffset defines offset of all custom buttons in pixels to elements of Description menu bar. Syntax Number Default Context Plug-in tag Defines an offset of all custom buttons in pixels to elements of the menu bar. NeptuneLabs - FSI Viewer...
  • Page 410 Syntax Number Default Context Plug-in tag Defines the width of the dialog window. DialogHeight Description defines the height of the dialog window Syntax Number Default Context Plug-in tag Defines the height of the dialog window. NeptuneLabs - FSI Viewer...

  • Page 411: Javascript Bridge

    JavaScript implementations. Implementing the JavaScript Bridge plug-in 1) Add an ID-attribute to your FSI Viewer Object and Embed tag <object id="fsiviewer" classid= ...> <embed NAME="fsiviewer"...> This way you are able to access the viewer object via Javascript. NeptuneLabs - FSI Viewer...
  • Page 412 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', '‚); NeptuneLabs - FSI Viewer...
  • Page 413 Alternatively you can select an image relatively from the currently selected image. To select an image relatively you have to set "newImageIndex" to a number prefixed by "+" or "-", e.g. "+1" selects the next image. SwitchThumbs Show / Hide Thumb bar NeptuneLabs - FSI Viewer...
  • Page 414 Using this command remotely presses/releases a button in 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]'); To release the button previously pressed use: FSIViewer.SetVariable('FSICMD', ''); NeptuneLabs - FSI Viewer...
  • Page 415 1. Activate the debug window of the FSI viewer (set parameter "debug" to "true"). 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 3) Navigating to image sections NeptuneLabs - FSI Viewer...
  • Page 416 Or alternatively via HTTP query: ...fsi.swf?cfg=foo&jsbridge_callback=1 Step 2. Add a unique identifier to the <object> and the <embed> tag of FSI Viewer / FSI Showcase. Example: Adding ID / NAME parameters <object id="fsiviewer" classid= ...> <Param name="movie" value="...> <embed NAME="fsiviewer"...> </object> NeptuneLabs - FSI Viewer...
  • Page 417 LANGUAGE=VBScript\> \n'); 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('</SCRIPT\> \n'); </script> After following the 3 steps described before you will receive the following event notifications: NeptuneLabs - FSI Viewer...
  • Page 418 URL corresponding to the image being displayed in FSI ImageUrl URL template Viewer. *See details below this table. The action "ID" is currently Action Action ID being executed. The viewer enters a passive Modal true / false NeptuneLabs - FSI Viewer...
  • Page 419 (true) or an active (false) state. The mouse mode "ID" has MouseMode Mouse Mode ID been activated. The magnification has Zoom Magnification (percent) changed. A new image has been selected. ImageSelected Image index (0..nImages) (FSI Showcase only) FSI Pages only NeptuneLabs - FSI Viewer...
  • Page 420 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 to an event is to extend the switch...case block of params) callback function fsiviewer_ DoFSCommand (fsi_ event, introduced in Step 3. NeptuneLabs - FSI Viewer...
  • Page 421 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 decodeURIComponent () before displaying this parameter. NeptuneLabs - FSI Viewer...
  • Page 422 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. NeptuneLabs - FSI Viewer...
  • Page 423 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...

  • Page 424: Largetooltips

    &ext=.jpg to the src-URL. Furthermore images will always be inserted into the textflow, if it is desired to continue the text below the inserted image, extra line breaks will be needed. Plug-in Parameters NeptuneLabs - FSI Viewer...
  • Page 425 Use 0 to display the tool tips immediately without a delay. Shadow Description Display a drop shadow Syntax Boolean Default true Context Plug-in node or HTTP query prefixed with "largetooltips_" Display (true) or hide (false) a drop shadow for the tool tip box. NeptuneLabs - FSI Viewer...
  • Page 426 Plug-in node or HTTP query prefixed with "largetooltips_" 6-digit hexadecimal color value specifying the highlighted (top-left) part of the tip box border. ShadowColor Description Border shadow color Syntax HexColor Default 999999 Context Plug-in node or HTTP query prefixed with "largetooltips_" NeptuneLabs - FSI Viewer...
  • Page 427 Plug-in node or HTTP query prefixed with "largetooltips_" Default text color of text in the tip box. To use different colors in a tool tip you can use the HTML tag <font color="RRGGBB"/> in the tool tip text data. NeptuneLabs - FSI Viewer...
  • Page 428 HTML tag <font size="n"/> in the tool tip text data. CornerRadius Description Radius of box corners Syntax Pixel Default Context Plug-in node or HTTP query prefixed with "largetooltips_" Radius of the box corners. Use "0" for straight edges and positive values for rounded edges. NeptuneLabs - FSI Viewer...

  • Page 429: Magnifier

    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 Context Plug-in attribute Specifies the space in pixels left of the menu button of the plug-in. NeptuneLabs - FSI Viewer...
  • Page 430 Magnification Description Level of magnification Syntax Number Default Context Plug-in attribute Defines the level of magnification where 1 means no magnification, 2 means a magnification of 200% and so on. The maximum level of magnification is 8. NeptuneLabs - FSI Viewer...
  • Page 431 Show or hide magnifier handle Syntax Bool Default true Context Plug-in attribute Show (true) or hide the handle of the magnifier glass. HandleSize Description Size of the handle in percent Syntax Number Default Context Plug-in attribute Size of the magnifier handle. NeptuneLabs - FSI Viewer...

  • Page 432: Maxzoom

    Plug-in Parameters MenuOffset Description Indentation of the menu button Syntax Number Default Context Plug-in attribute Specifies the space in pixels left of the menu button of the plug-in. NeptuneLabs - FSI Viewer...

  • Page 433: Measure

    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: <plugin src="measure" ImageWidth="120.5" Suffix=" inches" /> NeptuneLabs - FSI Viewer...
  • Page 434 The corresponding plug-in tag is the following: <plugin src="measure" ImageWidth="2.65" Suffix=" mm" /> Please note: You might as well define all plug-in parameters via query or inside the <options> group by using the prefix "measure_". E.g.: ?cfg=engine&Measure_ImageWidth=2.65&Measure_Suffix=%20mm Accuracy NeptuneLabs - FSI Viewer...
  • Page 435 Specifies the space in pixels left of the menu button of the plug-in. ImageWidth Description Real width of the entire image Synta Floating Point Value Default 100.0 Context Plug-in attribute Defines the real width of the entire image (e.g. 120 inches). Please see the explanation in the previous section. NeptuneLabs - FSI Viewer...
  • Page 436 Context Plug-in attribute Defines the number of decimals of the length value. ShowText Description Display the current measurement string Syntax Boolean Default true Context Plug-in attribute Hides the text displaying the current measurement if set to "false". NeptuneLabs - FSI Viewer...
  • Page 437 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. NeptuneLabs - FSI Viewer...
  • Page 438 Plug-in attribute Text size for the textual output in pixels. 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. NeptuneLabs - FSI Viewer...
  • Page 439 Using the GlowRange parameter you can define the size of the "glowing" area. Use "0" to disable the glow range. GlowAlpha Description Opacity of the glow range Syntax Number Default Context Plug-in attribute Opacity of the glow range surrounding the measure tool. NeptuneLabs - FSI Viewer...
  • Page 440 Context Plug-in attribute Version 3.2.5 and above Specifies whether the plug-in sends plug-in event notivications. Plug- in events can be handled when using JSBridge plug-in or FSI Viewer Component. The following events apply to this plug-in: NeptuneLabs - FSI Viewer...
  • Page 441 The parameter provides the onMeasure String current distance and angle as displayed in the measure tool. The user stopped measuring. The parameter provides the onMeasureStop String current distance and angle as displayed in the measure tool. NeptuneLabs - FSI Viewer...

  • Page 442: Mousemodes

    Specifies the space in pixels left of the menu button(s) of the plug-in. Mode n Description Removes the button for mouse mode n from the menu bar Syntax Boolean Default — Context Plug-in Tag Provides the possibility to hide specific mouse mode buttons. NeptuneLabs - FSI Viewer...
  • Page 443 3.5.0 or higher You can alter the sequence of the buttons by providing the modes separated by commas (see the table above). Example: "1,0,2,3" alters the sequence of the buttons to "Pan, Zoom, Rotate 3D, Rotate 2D". NeptuneLabs - FSI Viewer...

  • Page 444: Mousemodeselect

    Specifies the space in pixel left of the menu button of the plug-in. Mode n Description Removes the button for mouse mode n from the menu Syntax Boolean Default — Context Plug-in attributes Provides the possibility to hide specific mouse mode buttons in the dropdown menu. NeptuneLabs - FSI Viewer...
  • Page 445 Remove Drag-Button <Plugin src="mousemodes" Model="false" /> The example above shows how to hide the button for mouse mode 1 (Drag). Mode n Mouse Mode Mode0 Zoom Mode1 360° Mode2 Rotate 3D (X/Y Axis) Mode3 Rotate 2D (Z Axis) NeptuneLabs - FSI Viewer...

  • Page 446: Music

    Specifies the space in pixels left of the menu button of the plug-in. AutoPlay Description Start playing the sound on startup Syntax Boolean or String Default false Context Plug-in attribute Set the value to Boolean "true" to make the sound play on startup. NeptuneLabs - FSI Viewer...
  • Page 447 Plug-in attribute Version: 4.0.7 By default pressing the plug-in button stops/plays the music. Setting this parameter to "true" makes the plug-in pause/resume when clicking the plug-in button so that the song does not restart from the beginning. NeptuneLabs - FSI Viewer...
  • Page 448 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 music off. NeptuneLabs - FSI Viewer...

  • Page 449: Navextension

    Default Context Plug-in attributes Specifies the space in pixels left of the menu button of the plug-in. Visible Description Initial display state Syntax Boolean Default false Context Plug-in attribute Defines the initial visibility state of the control. NeptuneLabs - FSI Viewer...
  • Page 450 Initial horizontal position of the control in pixels relative to the top-left corner of the viewer. Description Initial Y position in pixel Syntax Number Default Context Plug-in Tag Initial vertical position of the control in pixels relative to the top-left corner of the viewer. NeptuneLabs - FSI Viewer...

  • Page 451: Notepad

    You can either use the global FSI Viewer parameter "UniqueID" or use the Notepad plug- in parameter. Please refer to the "UniqueID" parameter description below for details. Persistent Data Storage NeptuneLabs - FSI Viewer...
  • Page 452 XML data file using the "LoadXML" parameter. This way the notepad on the client computer loads the notepad data from this file instead of using any data stored locally on the user‘s computer. Plug-in Parameters - Basic Required Parameter! NeptuneLabs - FSI Viewer...
  • Page 453 FSI Pages catalog. Plug-in Parameters – Layout and Appearance Visible Description Show or hide the notepad on startup Syntax Boolean Default false Context Plug-in attribute Show (true) or hide (false) the notepad on startup. NeptuneLabs - FSI Viewer...
  • Page 454 Obsolete from version 5.0.0 (defined by FSI Viewer Skin) Background color of the notepad window. You can specify a solid color or use multiple hexadecimal color values concatenated by, " to specify a color gradient, e.g. "FF0000,00FF00,FF0000". NeptuneLabs - FSI Viewer...
  • Page 455 Obsolete from version 5.0.0 (defined by FSI Viewer Skin) Width of the window border. FrameColor Description Color of the window frame Syntax HexColor Default 000000 Context Plug-in attribute Version Obsolete from version 5.0.0 (defined by FSI Viewer Skin) Color of the window border. NeptuneLabs - FSI Viewer...
  • Page 456 Plug-in attribute Color of the background behind the thumbnails. ItemButtonsBackgroundColor Description Color of the background behind the item buttons Syntax HexColor Default EEEEEE Context Plug-in attribute Color of the background behind the items buttons right of the bookmarks. NeptuneLabs - FSI Viewer...
  • Page 457 Use these parameters to enable or disable the buttons below the bookmark list. EnableAddFullBookmark: Enable bookmarking of entire images or pages EnableAddLinkBookmark: Enable bookmarking of links EnableAddCustomBookmark: Enable bookmarking of custom areas EnableSendBookmarks: Enable sending bookmark data NeptuneLabs - FSI Viewer...
  • Page 458 Add notepad button to menu bar Syntax Boolean Default true (FSI Pages: false) Context Plug-in attribute Add a button to the FSI Viewer menu bar to show or hide the notepad. FSI Pages skins provide a button independent of this parameter. NeptuneLabs - FSI Viewer...
  • Page 459 "LoadXML". You can use the "LoadXMLPrefix" parameter to prefix all "LoadXML" parameters, e.g. with the server URL. Sending the XML data to a web server: Make sure to enable the "EnableSendBookmarks" parameter to display the corresponding button below the bookmark list NeptuneLabs - FSI Viewer...
  • Page 460 URL or file name of an XML data file to load from a web server. If you add this parameter, the notepad loads the bookmarks from the file specified instead of loading bookmarks from the user‘s system. NeptuneLabs - FSI Viewer...
  • Page 461 Posting Data" on the preceding page for details. SendXMLUrlSuccess Description URL to open if sending XML data succeeded Syntax String Default Context Plug-in attribute Url to open if sending the XML data to the web server specified by "SendXMLStoreURL" parameter succeeded. NeptuneLabs - FSI Viewer...
  • Page 462 The following images can be defined: ImageHelpMain: image to display when the bookmark list is empty ImageHelpLinkBookmark: image to display while the user adds a link bookmark in FSI Pages ImageHelpLinkCustom: image to display while the user adds a custom bookmark NeptuneLabs - FSI Viewer...

  • Page 463: Pageslibrary

    = the path to the images for this publication. The first image will be used to display the thumbnail. label = optional description of the publication cfg = the configuration file to open if the user clicks the thumbnail See "Library XML data structure" below for details and an example. NeptuneLabs - FSI Viewer...
  • Page 464 Syntax Boolean Default false if FSI Pages is activated, otherwise true Context Plug-in tag Defines whether the plug-in icon is displayed in the FSI Viewer toolbar. Defaults to FALSE if FSI Pages is activated. NeptuneLabs - FSI Viewer...
  • Page 465 These values define the margin in pixels of the the content in the dialog window. ShowLabels Description defines whether the service labels should be displayed Syntax Boolean Default false Context Plug-in tag This value defines whether the service labels should be displayed. NeptuneLabs - FSI Viewer...
  • Page 466 = Image Path on Server label = Title of publication to be displayed cfg = Configuration file to be used XML Sample <?xml version="1.0" encoding="UTF-8" ?> <library> <item src="/demo/January/" label="Issue 01" cfg="cfg_01" /> <item src="/demo/February/" label="issue 02" cfg="cfg_02" /> </library> NeptuneLabs - FSI Viewer...

  • Page 467: Pagesmirror

    Defines the blur factor of the mirrored images. Offset Description Defines distance between the pages and the mrror effect Syntax Number (Pixels) Default Context PagesMirror Version 5.0.0 Defines the distance of the mirror effect and the pages. NeptuneLabs - FSI Viewer...
  • Page 468 Defines the mirror effects start opacity . EndAlpha Description Alphablending Syntax Number Default Context PagesMirror Version 5.0.0 Defines the mirror effects opacity on the near end. Please note: For technical reasons the PagesMirror plugin will not work when using page overlays NeptuneLabs - FSI Viewer...

  • Page 469: Pagesounds

    File Name Default pagesoundlib_coated.swf Context Plug-in tag File name of an SWF file (compiled Flash movie) containing the flip sounds. FSI Viewer ships with two different sound libraries: pagesoundlib_coated.swf (coated pages like catalogs) pagesoundlib_newspaper.swf (uncoated pages like newspapers) NeptuneLabs - FSI Viewer...

  • Page 470: Pagesthumbbar

    When disabled, the thumbnail is shown in the center below the catalog. Arrows Description Display scroll arrows Syntax Boolean Default true Context PagesThumbBar Version 5.0.4 If set to false, the arrows for scrolling the thumbnailbar are hidden and the user needs to drag the thumbs to scroll. NeptuneLabs - FSI Viewer...
  • Page 471 Default Context PagesThumbBar Version 5.0.0 Defines the opacity of the arrows in normal state. ArrowFillColor Description Arrow fill color Syntax HexColor Default FFFFFF Context PagesThumbBar Version 5.0.0 The fill color of the arrows inside in the thumbnailbar. NeptuneLabs - FSI Viewer...
  • Page 472 Enable/Disable the drop shadow effect of the thumbnails. Height Description Size of thumbnail images Syntax Number (Pixels) Default Context PagesThumbBar Version 5.0.0 Defines the height of the thumbnails in the thumbnail bar. The width is derived from the image size. NeptuneLabs - FSI Viewer...
  • Page 473 Defines the magnification level of the current thumbnail. Values greater than 100 will increase, smaller values will decrase the thumbnail size. MarginBottom Description Margin of the thumb bar Syntax Number (Pixels) Default Context PagesThumbBar Version 5.0.0 Defines the bottom margin of the thumbnail bar. NeptuneLabs - FSI Viewer...
  • Page 474 Offset of thumbnail bar Syntax Number (Pixels) Default Context PagesThumbBar Version 5.0.0 Defines the offset of the thumbnail bar. OffsetRight Description Offset of thumbnail bar Syntax Number (Pixels) Default Context PagesThumbBar Version 5.0.0 Defines the offset of the thumbnail bar. NeptuneLabs - FSI Viewer...
  • Page 475 Default Context PagesThumbBar Version 5.0.4 Width of the border around the active thumbnail. SelectionColor Description Color of the active thumbnail Syntax HexColor Context PagesThumbBar Version 5.0.4 Defines the backgroundcolor of the active pages in the thumbnail bar. NeptuneLabs - FSI Viewer...
  • Page 476 TextColor Description Color of page numbers Syntax HexColor Context PagesThumbBar Version 5.0.4 Defines the rounded corner effect for the active thumbnail. Straight corners if set to 0.Defines the color of the page numbers in the Thumbbar Plugin. NeptuneLabs - FSI Viewer...
  • Page 477 12 Plug-in Reference TextColorHighlight Description Round corner size of active thumbnail Syntax Number Context PagesThumbBar Version 5.0.4 Defines the textcolor of the active thumbnail. NeptuneLabs - FSI Viewer...

  • Page 478: Printsave

    Offset in pixel to previous menu elements Syntax Number (Pixels) Default Context PrintSave Version 5.0.0 Offset in pixel to previous menu elements. Print Description Enable/Disable printing Syntax Boolean Default Context PrintSave Version 5.0.0 If disabled, the menu button is hidden. NeptuneLabs - FSI Viewer...
  • Page 479 FSI Viewer (see parameter PrintTemplate). PrintTemplate Description Image template to be used Syntax String Default Context PrintSave Version 5.0.0 Defines the FSI Server profile used to load the print image. NeptuneLabs - FSI Viewer...
  • Page 480 Defines the maximum size of the image in pixels to download for printing. Please note that the actual size depends on the size of the image and (with FSI server) on the maximum size defined in the real time template used with FSI Viewer (see parameter PrintTemplate). NeptuneLabs - FSI Viewer...
  • Page 481 12 Plug-in Reference SaveTemplate Description Image template to be used Syntax String Default Context PrintSave Version 5.0.0 Defines the FSI Server profile used to download an image. NeptuneLabs - FSI Viewer...

  • Page 482: Resize

    FSI Viewer instance. 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. NeptuneLabs - FSI Viewer...
  • Page 483 Entering greater numbers forces the viewer to resize by the number of pixels specified. Using values > 1 increases the chance of imaging server cache hits and might thus reduce server load. NeptuneLabs - FSI Viewer...

  • Page 484: Selectframe

    "selectframe_ " with the parameter name, e.g. "selectframe_window". MenuOffset Description Indentation of the menu button Syntax Number Default Context Plug-in attribute Specifies the space in pixels left of the menu button of the plug-in. NeptuneLabs - FSI Viewer...
  • Page 485 Show or hide the output window of the plug-in. AnimatedRect Description Enable or Disable frame animation Syntax Boolean Default false Context Plug-in attribute If enabled the frameborders will be animated. Rotate Description Enable rotation of the selection Syntax Boolean Default true Context Plug-in attribute NeptuneLabs - FSI Viewer...
  • Page 486 Defines the opacity of the mask of the select box (0 = invisible). 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. NeptuneLabs - FSI Viewer...
  • Page 487 SceneSet, Scene, Left, Top, Right, Bottom, Rotation, Current View Example: JavaScript callback function function onSelect (set, scene, l, t, r, b, rot, strView) {   doSomething(); Additionally you can as use the template "$$selection$$" for the → CustomButton plug-in. NeptuneLabs - FSI Viewer...
  • Page 488 The user starts selecting. The user modifies the select frame. The parameter provides a string onSelectFrame String representing the current selection. The user stopped modifying the selection. onSelectFrameStop String The parameter provides a string representing the current selection. NeptuneLabs - FSI Viewer...

  • Page 489: Shoppinglist

    Show Page... Syntax: Print Send by email Delete All Close <Plugin src=“shoppinglist“/> Please note: This Plug-in requires the Template Sever. Plug-in Parameters Currency Description Defines the currency Default Context ShoppingList Version 5.0.0 Defines the currency inside the shoppinglist. NeptuneLabs - FSI Viewer...
  • Page 490 Context ShoppingList Version 5.0.0 Defines the default unit of items added to the shoppinglist. Email Description Enable/Disable sending list by email Default true Context ShoppingList Version 5.0.0 When enabled, the user can email a shoppinglist to others. NeptuneLabs - FSI Viewer...
  • Page 491 Store shopping list data on the user's computer Default true Context ShoppingList Version 5.0.0 Enable or disable the caching of list data. If disabled, the list info is lost when the user leaves the FSI pages instance. NeptuneLabs - FSI Viewer...
  • Page 492 Minimum Height of items in the list Default true Context ShoppingList Version 5.0.0 Enable/Disable printing. ShowListOnAddItem Description Show shoppinglist behaviour Syntax string Default once Context ShoppingList Version 5.0.0 Defines whether the shoppinglist is displayed after an item has been added. NeptuneLabs - FSI Viewer...
  • Page 493 5.0.0 Defines the HTML templates to be used for rendering the pages. DialogHeight Description Defines the height of the shoppinglist dialog window Syntax Number Default Context ShoppingList Version 5.0.0 Defines the height of the shoppinglist dialog window. NeptuneLabs - FSI Viewer...
  • Page 494 12 Plug-in Reference DialogWidth Description Defines the width of the shoppinglist dialog window Syntax Number Default Context ShoppingList Version 5.0.0 Defines the width of the shoppinglist dialog window. NeptuneLabs - FSI Viewer...

  • Page 495: Softwarecursor

    (Zoom, Drag, Rotate-2D, Rotate 3D). Plug-in Parameters Library Description File name of an SWF containing cursor graphics Syntax String Default — (built-in library) Context Plug-in attributes File name of a SWF (compiled Flash movie) file containing custom cursor graphics. NeptuneLabs - FSI Viewer...

  • Page 496: Stickynotes

    When enabled, the notes text will be mirrored when the page is turned, otherwise it will not be displayed. Alpha Description Opacity of the sticky notes Syntax Number Default Context StickyNotes Version 5.0.0 Defines the opacity of the sticky notes from invisible (0) to opaque (100). NeptuneLabs - FSI Viewer...
  • Page 497 Context StickyNotes Version 5.5.3 Color of the page numbers on sticky notes. ColorHighlight Description Color of lighter part Syntax Color Default FFFFEE Context StickyNotes Version 5.0.0 Defines the color of the lighter part of the sticky notes. NeptuneLabs - FSI Viewer...
  • Page 498 When this option is enabled, the sticky notes will be rotated slightly, to give a more natural look and feel. PageNumbers Description Enable/Disable Page numbers Default True Context StickyNotes Version 5.0.0 Display page numbers on the sticky notes. NeptuneLabs - FSI Viewer...
  • Page 499 Version 5.0.0 Defines after which period of time the cached note data expires. Position Description Position of the sticky notes Syntax String Default Context StickyNotes Version 5.0.0 Sticky notes position on the page (top, bottom or right). NeptuneLabs - FSI Viewer...
  • Page 500 Defines the distance between the sticky notes. CornerRadius Description Defines corner radius of the sticky notes Syntax Float Default Context StickyNotes Version 5.5.3 Defines the corner radius of the sticky notes. Use 0 for a squared shape. NeptuneLabs - FSI Viewer...

  • Page 501: Synchronize

    Syntax String Default Context Plug-in attribute All FSI Viewer instances using this plug-in with the same ID will be synchronized. Please note that this will even be the case if the viewers reside in different browser windows. NeptuneLabs - FSI Viewer...
  • Page 502 Enable/disable synchronizing the Measure plug-in. This parameter has no effect, if you do not use the Measure plug-in. You might want to disable this parameter if you want to enable users to measure distances in synchronized FSI Viewer instances independently. NeptuneLabs - FSI Viewer...

  • Page 503: Zoommeter

    The color has to be defined as a 6-digit hexadecimal number. (E.g. "FFFF00" 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 NeptuneLabs - FSI Viewer...
  • Page 504 12 Plug-in Reference Display the current magnification in percent of the viewer size (false) or relative to the size of the source image. NeptuneLabs - FSI Viewer...

  • Page 506: Appendix

    "LargeToolTips" plug-in, search results and alike. Whenever this documentation refers to "Basic HTML formatting tags", the following HTML tags can be used (variable values printed bold italic): <b></b> <i></i> <u></u> <br/> <font color="#FF0000" size="12" face="Arial"></font> <p align="left|center|right"></p> NeptuneLabs - FSI Viewer...

  • Page 507: C Example Of A _Default.xml File For Fsi Viewer Flash

    <ServerType value="fsi" /> <Base value= "http://fsi.neptunelabs.com/fsi/ server?source=/" /> </FPX> <Plugins> <Plugins src="mousemodes" /> <PLUGIN src="zoommeter" SrcRelative="1"/> </Plugins> <Options> <FSIBase value="config/" /> <ScenePreload value="true" /> <MenuAlign value="BR" /> </Options> </fsi_parameter> D Example of an image specific FSI configuration file NeptuneLabs - FSI Viewer...

  • Page 508: E Example Of A Fsi Viewer Js Skin Css File

    ASCII and then representing that value as a pair of hexadecimal digits. The digits, preceded by a percent sign ("%"), are then used in place of the reserved character. FSI Viewer transforms URL-encoded values back to the original value. How can I URL-encode a value? NeptuneLabs - FSI Viewer...

  • Page 509: G Html Tags Available In Fsi Viewer

    <p align="left|center|right"></p> Please note that you need to use XML syntax in order to avoid XML syntax errors in configuration files - this is e.g. using <br/> instead of <br>. H Example of a custom skin CSS file NeptuneLabs - FSI Viewer...
  • Page 510 /* defines the position of the loading animation */ .fsi-skin-example. fsi-viewer-loading-animation{ left:50%; top:50%; transform:translate(-50%, -50%); /* the base button class */ .fsi-skin-example .fsi-ui-button background: rgba(255,255,255,0.2); border:1px solid solid rgba(255,255,255,0.2); border-radius: 6px; /* styles for hovered buttons */ .fsi-skin-example .fsi-ui-button-hover background-color:#FFF; NeptuneLabs - FSI Viewer...
  • Page 511 /* PSEUDO CLASS, only these 3 values will be read */ .fsi-skin-example .fsi-ui-progressbar{ color:#33b1aa; background-color:rgba(255,255,255,0.5); border-color:#999; /* PSEUDO CLASS, only the color values will be read */ .fsi-skin-example .fsi-ui-progressbar-text{ color:#555; /* tool tips */ .fsi-skin-example .fsi-ui-tool-tip { color:#4d4d4d; background-color:rgba(255,255,255,0.8); border:1px solid #4d4d4d; NeptuneLabs - FSI Viewer...
  • Page 512 168, 255, 0.85); box-shadow: 2px 2px 2px rgba(0,0,0,0.3); .fsi-skin-example .fsi-ui-hotspot-hover { background-color: rgba(88, 168, 255, 1.0); .fsi-skin-example .fsi-ui-hotspot-active { background-color: rgba(88, 168, 255, 1.0); .fsi-skin-example .fsi-ui-hotspot-line-color { color: #336699; .fsi-skin-example .fsi-ui-hotspot-line-background-color { color: #113399; /* dialogs */ NeptuneLabs - FSI Viewer...
  • Page 513 .fsi-skin-example .fsi-dialog input[type="button"]{ font-size: 14px; color: #666; border:1px solid #eee; background-color: transparent; .fsi-skin-example .fsi-dialog input[type="button"]:hover{ color: #206662; background-color: #EEE; /* FSI Pages */ .fsi-skin-example .fsi-ui-button.PageInput{ background-color: white; border:1px solid #CCC; color: #333; .fsi-skin-example .fsi-ui-button.PageInput input:focus{ border-color:#999; color: #000; NeptuneLabs - FSI Viewer...

  • Page 515: Index

    140 , 271 duplicateImagesIfNeeded Hyperlinks effects Layout and Skins elementSpacing Link Parameters and Hierarchy of elementWidth Link Parameters enableScrollBar Modifying Link Values at Runtime 269 enableZoom Page Overlays endlessScrolling Page Reading Order headers Parameters defining Layout and 287 NeptuneLabs - FSI Viewer...
  • Page 516 Callbacks getPageLayoutData onAfterRegisterExternalButton 177 getPageNumberString onAutoPageLayoutChange 179 getParameters onBookmarkAdded getPluginParameter onBookmarkRemoved getSkinClassName onBookmarksLoaded getTargetPage onBookmarksSaved getVersion onChangeConfig goToPage onDestroy gotoPageNumeric onFullScreen hideMenuToolTip OnMenuButtonEnabled 177 init onMenuButtononMenuButtonClicked 177 lastPage OnMenuButtonPressed 177 makeBoolean onMenuButtonReleased 177 nextPage onMenuButtonSetPressed 177 NeptuneLabs - FSI Viewer...
  • Page 517 DefaultLinkTip Chapters DefaultLinkURL FullScreen DefaultLinkURLPrefix, PagesThumbBar DefaultLinkURLSuffix Autohide DemoURL Height DemoURLTarget indexDataFile PageNumbers doublePageMode Width effects StickyNotes emptyImages 1 , 154 Print 1 , 147 FirstPageNumber 157 , 1 1 , 147-148 PrintResolution FollowLinks RememberLastViewedPage 158 ForceJavascriptTarget NeptuneLabs - FSI Viewer...
  • Page 518 ImageAlign BendEffectIntensity Index BlankBackCover InitialPage BlankFrontCover KeepIndex ButtonsFirstLastPage LinkFillAlpha ClickPageToZoom LinkRGBAActive CustomPageNumbers LinkRGBAHover CustomPageNumbersFile LinkRGBANormal DefaultJavascriptTarget LinkTemplateData DefaultLinkTarget LinkTemplates DefaultLinkTip ListTemplate DefaultLinkURL MarginBottom DefaultLinkUrlPrefix MarginLeft DefaultLinkUrlSuffix MarginRight DemoURL MarginTop DemoURLTarget Menu MovePages DoublePageAllowInteractivity PageBackgroundImage DoublePageZoom PageBackgroundImageEffects DoublePageZoomDragPan NeptuneLabs - FSI Viewer...
  • Page 519 Ratio ViewerMarginBottom RememberLastViewedPage ViewerMarginLeft Remem- ViewerMarginRight ViewerMarginTop berLastViewedPageExpireAfter XMLBase RemovePages XMLBaseUseImageFileName ReversePageOrder Zoom RomanPageNumbersOffset ZoomAreaAnimationSpeedIn Rotation ZoomAreaAnimationSpeedOut Save ZoomAreaAnimationType SaveAllowSavingImages ZoomAreaTargetScale SaveDocumentFile FSI QuickZoom SaveEffects How it works SaveOptions Initializing FSI QuickZoom manu- SaveResolution SaveTemplate ally SaveURLPrefix NeptuneLabs - FSI Viewer...
  • Page 520 MarginBottom zoomImageOffset MarginLeft FSI Showcase MarginRight Parameter MarginTop Align MinimizeOnSelect Background OffsetBottom BackgroundAlpha OffsetLeft BaseColor OffsetRight BaseScale OffsetTop CropThumbnails PaddingBottom DragBar PaddingLeft DragBarHighlight PaddingRight DragBarRoundBevel PaddingTop DragBarShadow PreloadThumbs DragBarWidth ScrollArrow DragMenu ScrollBaseColor DragMenuWidth ScrollTrack EdgeRadius ShowControls NeptuneLabs - FSI Viewer...
  • Page 521 38 , 235 lockUpdates ScenePreload printAPI SceneSets removeImages TilePaddingX resetImage TilePaddingY scanForNewImages TilesX setZoomPrecision TilesY triggerRefresh Index structure of FSI Viewer 15 , 186 updateImagePositions Licensing FSI Viewer Parameters Integration into HTML Pages debug Required HTML-Source Code 187 NeptuneLabs - FSI Viewer...
  • Page 522 Deactivating Plug-ins IgnoreQueryParameters Defining Plug-in Parameters 243 ImagePanButtons Defining Plug-in Parameters InfoTemplate Initial MouseMode dynamically InitialAction Virtual 360° Presentations InitialActionDelay Parameters for Virtual 360° InitialActionPersistent Presentations InitialView FSI Viewer JS InitialViewPersistent Additional Buttons intro camera Section language NeptuneLabs - FSI Viewer...
  • Page 523 84 showMenuToolTip onReset spinToDegree onResize spinToTarget onSkinChanged start onStartDragging updateSize onStopDragging Mouse Modes onViewChanged Parameters onZoomChanged actionParameter Methods activeClass addListener adaptiveUISize changeConfig armAngleMeasureSetup changeImage NeptuneLabs - FSI Viewer...
  • Page 524 43-44 perimeterZoom focusAngleX,focusAngleY plugins focusOnClick Plugins focusRadius position frameOffset preventImageTransparency headers progressBarHAlign 24-25 heightCamera progressBarHeight heightCorrectionFactor progressBarWidth heightTable 45-46 reverseSceneSets hideUI NeptuneLabs - FSI Viewer...
  • Page 525 Sort Update zoomOnFocus ValidateData Using the navigator window Width video Section ClockProgress virtualSpace Section Parameter Interface Alpha Methods Color1 register- Color2 ExternalMenuButtonsFromContainer LineColor unregisterExternalMenuButton 78 posX unre- posY gister- Size ExternalMenuButtonsFromContainer TextColor Introduction ColorAdjust Parameter Parameter AutoHideDialog NeptuneLabs - FSI Viewer...
  • Page 526 Alpha TextFont BaseURL TextSize Width Color Magnifier Coords Parameter DefaultColor Handle DefaultFill HandleSize DefaultFillAlpha Magnification DefaultFillColor MenuOffset DefaultMove Reflections DefaultSkew Size DefaultTarget Visible Events MaxZoom Fill Parameter Move MenuOffset SelectImage Measure Skew Parameter Spot BGAlpha Target BGColor NeptuneLabs - FSI Viewer...
  • Page 527 PagesLibrary MenuOffset Parameter PauseOnStop AddButton Song DataFile Volume DialogHeight NavExtension DialogWidth Parameter ImageHeight MenuOffset ImageWidth Visible MarginX MarginY MenuOffset Notepad ShowLabels Parameter PagesMirror AddButton Parameter BackgroundColor Blur BackgroundGradientAngle 455 EndAlpha EdgeRadius Offset EnableAddCustomBookmark 457 StartAlpha EnableAddFullBookmark 457 NeptuneLabs - FSI Viewer...
  • Page 528 Parameter Template MenuOffset SoftwareCursor Print Parameter PrintEffects Library PrintResolution StickyNotes PrintTemplate Parameter Save AllowMirroredNotes SaveEffects Alpha SaveResolution Color SaveTemplate ColorHighlight Resize ColorShadow Parameter CornerRadius EnlargeBy NaturalRotation MaxHeight PageNumbers MaxWidth PersistentStorage MinHeight PersistentStorageExpiresAfter 499 MinWidth Position Scale Spacing NeptuneLabs - FSI Viewer...
  • Page 529 Index TextColor Synchronize Parameter SyncMeasure SyncSoftwareCursor ZoomMeter Parameter Color SrcRelative useTiledImages NeptuneLabs - FSI Viewer...
  • Page 530 NeptuneLabs. NeptuneLabs assumes no responsibility or liability for any errors or inaccuracies in this manual, including the software described in it.
  • Page 531 NeptuneLabs GmbH Lagesche Str. 32 32657 Lemgo Germany fon: + 49 5261 - 28732- 0 fax: + 49 5261 - 28732- 29 info@neptunelabs.com www.neptunelabs.com...

This manual is also suitable for:

Fsi showcase jsFsi touchzoomFsi pages jsFsi quickzoomFsi imageflow

Table of Contents