Basic Parameters



General

debug

Descriptiondisplay debug and status information in the JavaScript console
SyntaxBoolean
Defaultfalse
ContextFSI Viewer

Display debug and status information in the browser's JavaScript console.


headers

Description"&headers=" parameter to use for image requests
SyntaxString
Default"cors"
ContextFSI Viewer

The "&headers=" parameter to use for image requests.

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


cfg

Descriptionrelative path to an XML configuration file in FSI Viewer format
SyntaxString
Default""
ContextFSI Viewer

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.


navWidth

Descriptiondefines the width of the navigation frame
SyntaxString
Default"120"
ContextFSI Viewer

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



navHeight

Descriptiondefines the height of the navigation frame
SyntaxString
Default"120"
ContextFSI Viewer

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



urlLoadingAnimation

Descriptiondefines the loading animation shown
Syntaxstring
Default"/skins/resources/loading.svg"
ContextFSI Viewer

Defines the loading animation shown. Custom animations can be placed here: /skins/resources/. Setting the parameter to "false" discards the display.


InvisibleLoadingPurposes

Descriptiondefines if the loading animation should be excluded under certain circumstances
Syntaxstring
Default-
ContextFSI Viewer

Defines if the loading animation should be excluded under certain circumstances. Per default it is activated whenever the viewer loads images. Setting the parameter to "asyncResize" omits the loading animation when asynchronic 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.



skin

Descriptiondefines the skin to display
Syntaxstring
Default"black"
ContextFSI Viewer

Defines the skin which will be displayed. FSI Viewer comes with three default skins, "black", "white" and "silver".

Skins are defined via CSS and can be found here: /fsi/web/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.

Too see an example file, please go to 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/web/viewer/skins/resources. (fsi-core.css, fsi-viewer-core.css)



IMPORTANT:

Never change the classes of the core CSS in the core files directly. If you would like to adapt the CSS rules listed there, please overwrite them in a custom skin file or in the HTML document instead.

 You can find detailed tutorials for changing the appearance of the skin in the support section of our website:

For a detailed example of a basic custom skin, please go to "Example of a custom skin CSS file" .



dir

Descriptionpath to the source images for the object spin on FSI Server
SyntaxString
Default""
ContextFSI Viewer

The path to the source images for the object spin on FSI Server.

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



src

Descriptionpath to the single images used for FSI Viewer
SyntaxString
Default""
ContextFSI Viewer

Defines the path to single images used for FSI Viewer.



imagesources

Descriptionpaths to single images used for FSI Viewer
SyntaxString
Default""
ContextFSI Viewer

Defines the paths to single images used for FSI Viewer. Example: "dir1/1.jpeg, dir1/2.jpeg, dir2/1.jpeg,..."



imageListLimit

Descriptionlimits the image list to a certain amount of images
SyntaxString
Default""
ContextFSI Viewer 360

FSI Viewer 360° only. Does not apply to a single image FSI Viewer instance. 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.


imageListSort

Descriptionsorts the image list
SyntaxString
Default"filename"
ContextFSI Viewer 360

FSI Viewer 360° only. Does not apply to a single image FSI Viewer instance. Sorts the image list with any valid sort item name for FSI Server. Available sort names:

  • "filename" (default)
  • "width"
  • "height"
  • "lastmodified"
  • "resolution"
  • "importstatus"


imageListSortOrder

Descriptiondefines the order of the image list sorting
SyntaxString
Default"asc"
ContextFSI Viewer 360

FSI Viewer 360° only. Does not apply to a single image FSI Viewer instance. Defines the order of the image list sorting. Possible values: "asc" (Ascending) or "desc" (Descending).


ListFilterPositive

Descriptionfilters the image list using RegEx, includes matching images
SyntaxString
Default-
ContextFSI Viewer 360

FSI Viewer 360° only. Does not apply to a single image FSI Viewer instance. 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"


ListFilterNegative

Descriptionfilters the image list using RegEx, excludes matching images
SyntaxString
Default-
ContextFSI Viewer 360

FSI Viewer 360° only. Does not apply to a single image FSI Viewer instance. 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"



language

Description:Defines the language of the tooltips
Syntax:String
Default:
Context:FSI Viewer

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".



effects

Description:Image manipulation parameters for all images
Syntax:String
Default:
Context:FSI Viewer

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 overwite 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.


Please note:

ClearEffects() must be written exactly like this and must be at the start of the "effects" parameter value.


Please refer to your FSI Server documentation for a list of available effect parameters.


initialView

Descriptiondefines the initial image segment
SyntaxString
Default"1,1,0,0,1,1"
ContextFSI Viewer

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.



initialViewPersistent

DescriptionKeep the InitialView as default view
Syntaxboolean
Defaultfalse
ContextFSI Viewer

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.



panLimits

Descriptiondeterrmines how far the user is allowed to pan
SyntaxString
Default"strict"
ContextFSI Viewer

Determines how far the user is allowed to pan. Possible settings are: "loose", "medium", "strict"



easingZoom

Descriptiondeterrmines the easing function for zoom and pan.
SyntaxString
Default"easeOutCubic"
ContextFSI Viewer

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



easingSpin

Descriptiondeterrmines the easing function for object spins.
SyntaxString
Default"easeOutCubic"
ContextFSI Viewer

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



preventImageTransparency

Descriptionprevents the image transparency
SyntaxBoolean
Defaultfalse
ContextFSI Viewer

Prevents using the image transparency if a transparency channel exists.



useDevicePixelRatio

DescriptionUse the device's pixel ratio to display even sharper images.
SyntaxBoolean
Defaulttrue
ContextFSI Viewer

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



drawCube

Descriptiondraws a 3D cube wireframe representing the spin object space
Syntaxboolean
Defaultfalse
ContextFSI Viewer

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.

This option only works on desktop computers using the HTML canvas element.



drawTable

Descriptiondraws a virtual rotating table plate
Syntaxboolean
Defaultfalse
ContextFSI Viewer

Draws a virtual rotating table plate. 

This option only works on desktop computers using the HTML canvas element.



tableDiameter

Descriptiondefines diameter of virtual rotating table plate
SyntaxFloat
Default950
ContextFSI Viewer

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

This option only works on desktop computers using the HTML canvas element.


drawGroundPlate

Descriptiondraws a virtual ground plate
Syntaxboolean
Defaultfalse
ContextFSI Viewer

Draws a virtual ground plate.


This option only works on desktop computers using the HTML canvas element.

  

  

initialMouseMode

DescriptionMouse mode on startup
SyntaxString
Default"auto"
ContextFSI Viewer

Specifies the selected mouse mode on startup.


Possible values:
0:(Zoom)
1:(Pan)
2:(Spin 360°)




menuButtonOrder

Descriptiondefines the button order of the menu bar buttons
SyntaxString
Default-
ContextFSI Viewer

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

The following button IDs currently exist:

Reset, ZoomOut, ZoomIn, MouseMode_0, MouseMode_1, MouseMode_2, MaxZoom, HotSpots, ToggleAutoSpin, ToggleFullScreen




autoDestroy

Descriptionautomatically destroy instances
Syntaxboolean
Defaulttrue
ContextFSI Viewer

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




DemoURL 

DescriptionURL to the website that should be opened on click (or alternatively, go to FullScreen)
Syntaxstring
Default
ContextFSI Viewer

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

Alternatively:

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



DemoURLTarget

Description target frame for DemoURL to open in
Syntaxstring
Default"_self"
ContextFSI Viewer

The target frame for DemoURL to open in.



HideUIInDemoMode

DescriptionHide UI elements in demo mode
Syntaxboolean
Defaulttrue
ContextFSI Viewer

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




DemoToolTip

DescriptionTool tip to show when in demo mode.
Syntaxstring
Default
ContextFSI Viewer

Tool tip to show when in demo mode.


Example for custom HTML:
 <DemoToolTip>
      <b>Demo Mode</b><br/>
      Click to view image in full screen mode
  </DemoToolTip>    



spinDirectionImage

Descriptiondefines direction of rotation
SyntaxString
Default"left"
ContextFSI Viewer

Specifies the direction of the spin rotation.




SceneSets

DescriptionScene sequence definition
SyntaxString
Default1 – n tiles
ContextFSI Viewer

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.


Example:

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




reverseSceneSets

Descriptionreverses the Scene Sets
Syntaxboolean
Defaultfalse
ContextFSI Viewer

Reverses the order of the Scene Sets.




NoSetLoop

DescriptionNo 360° rotation around the y-axis
SyntaxBoolean
Defaultfalse
ContextFSI Viewer

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.




NoSceneLoop

DescriptionNo 360° rotation around the x-axis
SyntaxBoolean
Defaultfalse
ContextFSI Viewer

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

Please note: The blur animation is turned off if NoSceneLoop is activated.



ScenePreload

DescriptionLoad scenes in high resolution
SyntaxBoolean
Defaultfalse
ContextFSI Viewer

If this parameter is activated (default) all scenes will be loaded at high resolution on startup. Otherwise preview images will be loaded with at a lower resolution. 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.


Display Options

hideUI

Descriptionhides the user interface
Syntaxstring
Defaultfalse
ContextFSI Viewer

Hides or displays the user interface.


Possible values:
true
false
onMobileDevices:UI is hidden on mobile devices
ifNoInPlaceZoom:UI is hidden if in place zoom is deactivated



noNav

Descriptionhides the navigation window
Syntaxboolean
Defaultfalse
ContextFSI Viewer

Hides or displays the navigation window.




autoHideNav

Descriptionautomatically hides the navigation window
Syntaxboolean
Defaultfalse
ContextFSI Viewer

Hides or displays the navigation window automatically if the magnification is at minimum.



autoSpinSpeed

DescriptionTime in seconds for a full rotation
Syntaxfloat
Default-
ContextFSI Viewer

Time in seconds for a full rotation. Negative values reverse spin direction.



autoSpinInterval

Descriptiondefines pause between every step in ms
Syntaxfloat
Default-
ContextFSI Viewer

Can be used instead of autoSpinSpeed to define the duration of the AutoSpin. autoSpinInterval defines the pause between every step of the rotation in ms. Negative values reverse spin direction. The hierarchy of the parameters is as follows:

  • autoSpin_interval (Plugin Parameter)
  • autoSpinInterval (Config Parameter)
  • autoSpin_speed (Plugin Parameter)
  • autoSpinSpeed (Config Parameter)



enableZoom

Descriptionenable the user to zoom in and out
SyntaxBoolean
Defaulttrue
ContextFSI Viewer

Enable the user to zoom in and out.

On touch enabled devices the 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. Alternatively, the menu bar can be used for zooming.



desktopClickZoomScale

Descriptionthe magnification level to use when clicking the object
SyntaxFloat
Default3
ContextFSI Viewer

For desktop browsers only. The magnification level to use when clicking the object.



backgroundColor

Descriptionthe background color to use
Syntax6-digit hex-color
Default#FFFFF
ContextFSI Viewer

The background color to use. The color should match the video's or image's background color (usually white or black).



mouseSensitivity

Descriptionsensitivity of the mouse movement when rotating the object
Syntaxfloat
Default1.0
ContextFSI Viewer

Sensitivity of the mouse (finger) movement when rotating the object.



pellets

Descriptionviewer draws optionally small dots on the video
Syntaxboolean
Defaulttrue
ContextFSI Viewer

When using a spin video you can optionally have the viewer draw small dots on the

video. This improves the visual impression of the video in higher resolutions.



pelletsOpacity

Descriptiondefines opacity of the dots ("pellets") drawn on the video
Syntaxfloat
Default0.09
ContextFSI Viewer

Opacity of the dots ("pellets") drawn on the video, if the pellets parameter is enabled.



adaptiveUISize

Descriptiondetermines if interface scales according to the zoom level .
SyntaxBoolean
Defaulttrue
ContextFSI Viewer

When set to true, the interface scales according to the zoom level.



inPlaceZoom

Descriptionactivates zooming in the FSI Viewer instance
Syntaxstring
Default"true"
ContextFSI Viewer

The parameter defines if in-place-zoom (zooming directly in the FSI Viewer instance)is activated.



Possible values:
true
false
auto:in-place-zoom is activated, but not on mobile devices



documentZoom

Descriptionallows pinch-zoom on FSI Viewer instance
Syntaxstring
Default"auto"
ContextFSI Viewer

Activates pinch document zoom on FSI Viewer instance.



Possible values:
true
false
auto:pinch document zoom is activated on all touch-enabled devices



autoDisablePointerActions

Descriptiondisables events if viewer is larger than viewport
SyntaxBoolean
Defaulttrue
ContextFSI Viewer

Disables mouse and touch events if viewer's height OR width is larger than the viewport width or height.



loadExactPreviewImagesAfterResize

DescriptionReload images in the new required resolution after a resize event
SyntaxBoolean
Default"true"
ContextFSI Viewer

Reload images in the new required resolution after a resize event.



maxZoom

Descriptiondefines the maximum magnification level
SyntaxFloat
Default100
ContextFSI Viewer

Defines the maximum magnification level.



minInstanceSize

Descriptiondefines the minimum instance size
SyntaxInteger
Default60
ContextFSI Viewer

Defines the minimum instance size of the viewer. 



Preview Options

showPreviewWhileLoading

Descriptionshows/hides preview images for spins while loading
Syntaxboolean
Defaulttrue
ContextFSI Viewer

If this parameter is set to false, the preview images which are shown while the spin is loaded are hidden.



spinPreviewWhileLoading

Descriptionshows/hides preview images for spins while loading
Syntaxboolean
Defaulttrue
ContextFSI Viewer

If this parameter is set to false, a static image will be shown instead of the spin while loading. If initialView is defined, the image defined there will be shown.



showProgressbar

Descriptionshows/hides progess bar while loading
Syntaxboolean
Defaulttrue
ContextFSI Viewer

If this parameter is set to false, the progress bar which is shown while the spin is loaded is hidden.



progressBarWidth

Descriptiondefines the width of the progress bar
Syntaxfloat
Default35
ContextFSI Viewer

Defines the width of the progress bar in percent of the viewport width.



progressBarHeight

Descriptiondefines the height of the progress bar
Syntaxfloat
Default14
ContextFSI Viewer

Defines the height of the progress bar in pixel.

  

progressBarHAlign

Descriptiondefines the horizontal position of the progress bar
Syntaxstring
Default"center"
ContextFSI Viewer

Defines the horizontal position of the progress bar, possible values: left, center, right. 



progressBarVAlign

Descriptiondefines the vertical position of the progress bar
Syntaxstring
Default"bottom"
ContextFSI Viewer

Defines the horizontal position of the progress bar, possible values: top, middle (or center), bottom.


Search


Basic Parameter Quick Reference