General Parameters

false
Default

The debug mode can be enabled or disabled by passing the debug parameter either in the code snip or in an XML configuration file. Please use debug=1 or debug=true to enable the debug mode and debug=0 (or omit the debug parameter) to disable the debug mode. To disable the debug mode permanently, you can safely delete the /debug directory of your FSI setup directory.

cors
Default

The default value cors ensures cors compatibility for cross-origin scenarios.

Defines the relative path to an XML configuration file in FSI Viewer format. When using a relative path the location specified by the FSI Viewer FSIBase parameter will be used, which is viewer/config/ by default.

auto
Default

Default is auto which automatically chooses the best format depending on the browser; alternatively you can choose WEBP, JPEG, PNG or GIF. Auto delivers the images adaptively as WEBP in supporting browsers, and switches to PNG or JPEG on browsers not supporting the format. If you would like to use WEBP, the best way would be to set auto as the format.

true
Default

Prevents automatic initialisation when the instance has been attached to the DOM. Helpful e.g. when working with React.

120
Default

Defines the width of the navigation frame displayed in the right corner on the bottom.

120
Default

Defines the height of the navigation frame displayed in the right corner on the bottom.

/skins/resources/loading.svg
Default

Custom animations can be placed here: /skins/resources/. Setting the parameter to false discards the display.

Per default, it is activated whenever the viewer loads images. Setting the parameter to asyncResize omits the loading animation when asynchronous loading takes place, e.g. when the viewer is switched to FullScreen and the higher resolution images need to be loaded. tile omits the presence of the loading animation when tiles are loaded, e.g. when the user zooms into the picture. It is also possible to combine both as tile,asyncResize - in this case the loading animation is only shown in the initial loading sequence.

black
Default

FSI Viewer comes with three default skins, black, white and silver.

Skins are defined via CSS and can be found here: /fsi/viewer/skins.

It is also possible to alter existing skins or to define custom skins in this location.

In order to use a custom skin, the easiest way would be to duplicate one of the default skin CSS files and adapt them to your liking. Make sure to use a custom class in front af ALL classes defined in the custom CSS, otherwise you will break other skins on the same HTML document.

To see an example file, please go to the Example File in the Appendix.

General appearance CSS rules, which are valid on an overall level, (e.g. the logo container, height of the menubar, etc.) are defined in the corresponding core CSS files, which can be found in /fsi/viewer/skins/resources. (fsi-core.css, fsi-viewer-core.css)

info
Default

Defines the path to single images used for FSI Viewer.

The viewer will load the list of images from the given directory.

Example: dir1/1.jpeg, dir1/2.jpeg, dir2/1.jpeg,...

The language parameter can be used to adapt the tooltips which are shown while hovering over a button to a certain language. The available languages can be found in the \languages folder of your FSI Viewer installation. (See Using Custom Language Files for more info).

It is also possible to map the available language files to the language of the browser (the file mapping.json in the \languages folder of your FSI Viewer installation can be adapted to your liking for that). In order to use the mapping defined in the JSON file, the parameter language needs to be set to auto.

The effects parameter can be used to pass image manipulation parameters to the imaging server. 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.

In contrast to all other parameters, defining the parameter effect adds(!) the string to the existing effects parameter. E.g. if your configuration file contains: <effects value="blur(10)" /> and you add to your fsi-viewer tag effects="sepia()", the resulting effects parameter value is: blur(10),sepia().

If you want to overwrite existing effects values, you can start the effects parameter with ClearEffects().

In the example above, if you add effects="ClearEffects(),sepia()" to your fsi-viewer tag, the resulting effects parameter value is sepia() only.

1,1,0,0,1,1
Default

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.

The other parameters are optional and specify the image segment with Left, Top, Right, Bottom.

false
Default

If this parameter is activated, clicking the Reset button will display the image section defined by the InitialView parameter instead of the entire image. If this parameter is set to false, the initial view will be displayed on startup, but pressing the Reset button will reset the view to the entire image.

loose | medium | strict
Values

Determines how far the user is allowed to pan.

easeOutCubic | easeLinear | easeOutBounce | easeOutQuint
Values

Determines the easing function for zoom and pan. Possible settings are:

• easeOutCubic: end motion slowly
• easeLinear: no easing, linear motion
• easeOutBounce: end motion bouncing
• easeOutQuint: end motion faster

easeOutCubic | easeLinear | easeOutBounce | easeOutQuint
Values

Determines the easing function for object spins. Possible settings are:

• easeOutCubic: end motion slowly
• easeLinear: no easing, linear motion
• easeOutBounce: end motion bouncing
• easeOutQuint: end motion faster

true
Default

Use the device's pixel ratio to automatically display even sharper images.

false
Default

Draws a 3D cube wireframe representing the object space of the spin as defined by the virtualSpace parameters.

The drawCube option can be useful to validate the virtualSpace parameters.

false
Default

Draws a virtual rotating table plate.

false
Default

Defines the diameter of the virtual rotating table plate in mm.

false
Default

Draws a virtual ground plate.

auto | 0 | 1 | 2
Values

Specifies the selected mouse mode on startup.

Reset | ZoomOut | ZoomIn | MouseMode_0 | MouseMode_1 | MouseMode_2 | MaxZoom | HotSpots | ToggleAutoSpin | ToggleFullScreen
Values

Defines the button order of the menu bar buttons. The buttons need to be listed in a string with the corresponding button IDs.

true
Default

Automatically destroy instances created with the fsi-viewer tag upon removing the tag from the document DOM.

URL | no action | enter fullscreen
Values

The URL to the website that should be opened while clicking on the demo thumbnail.

• no action: the click will do nothing at all
• enter fullscreen: enter fullscreen and exit demo mode, returns into demo mode after leaving fullscreen mode

_self
Default

The target frame for DemoURL to open in. You can use default frame names like _self or _blank or use a custom frame of your HTML frame set.

true
Default

Hide UI elements (menu bar and alike) in demo mode.

Tool tip to show when in demo mode.

<DemoToolTip>
  <b>Demo Mode</b><br/>
  Click to view image in full screen mode
</DemoToolTip>

left
Default

Specifies the direction of the spin rotation.Specifies the direction of the spin rotation.

1 – n tiles
Default

Using this parameter you can define scene sets for 360° views. Scene sets define the order of scenes to be displayed.

The default is a single scene set containing all scenes (image tiles) from scene 1 to the last scene image. The default sequence is left to right, top to bottom in a tile image and the sequence of the image nodes for 360° views based on individual source images.

In the viewer scenes can be selected by moving the mouse horizontally and scene sets can be selected by moving the mouse vertically.

Syntax:

Individual sets have to be separated with ";" (semicolon).

Scenes within the sets are separated with "," (comma) and specify the 1-based index of the image from left to right, top to bottom up to the total number of scenes

(TilesX x TilesY or individual source images).

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 from the first number to the last scene image plus the first scene image up to the second number will be assumed.

SceneSets="1-12;13-24;25-36;37-48"

false
Default

Reverses the order of the Scene Sets.

false
Default

The first and the last scene set will be considered ending points. (E.g. for partial rotations < 360°).

false
Default

The first and last scene in each scene set will be considered ending points. (E.g. for partial rotations < 360°).

Limits the image list to a certain amount of images within the directory. The parameter is used like this: 0,10 - the first value defines the starting image, the second the amount of images displayed. In this case it would start at the first image and show the first ten images. 5,5 would start the list with the fifth image and shows the fifth image plus the four images that are listed behind it.

filename | width | height | lastmodified | resolution | importstatus
Values

Sorts the image list with any valid sort item name for FSI Server.

asc | desc
Values

Defines the order of the image list sorting. Possible values: asc (Ascending) or desc (Descending).

Filters the image list to a certain amount of images within the directory using RegEx. If images match the Regular Expression, they will be included in the image list. If both ListFilterPositive and ListFilterNegative are used, ListFilterPositive is always used first. The filter will be applied before any other parameter is applied, i.e. if SceneSets is set, it only applies to the already filtered list.

Example: ListFilterPositive="/8.TIF$/i"

Filters the image list to a certain amount of images within the directory using RegEx. If images match the Regular Expression, they will be excluded of the image list. If both ListFilterPositive and ListFilterNegative are used, ListFilterPositive is always used first. The filter will be applied before any other parameter is applied, i.e. if SceneSets is set, it only applies to the already filtered list.

Example: ListFilterNegative="/8.TIF$/i"