Skip to main content

Display Options Parameters

hideUI​

enum

Hides or displays the user interface.
since 17.10
true | false | onMobileDevices | ifNoInPlaceZoom
Values
Possible values:Result:
trueUI is hidden every time
falseUI is visible every time
onMobileDevicesUI is hidden on mobile devices
ifNoInPlaceZoomUI is hidden if in place zoom is deactivated

noNav​

boolean

hides the navigation window
since 17.10
false
Default

Hides or displays the navigation window.

autoHideNav​

boolean

automatically hides the navigation window
since 17.10
false
Default

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

autoSpinSpeed​

(*)

float

Time in seconds for a full rotation
(* Only available in FSI Viewer 360°)
since 17.10

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

autoSpinInterval​

(*)

float

defines pause between every step in ms
(* Only available in FSI Viewer 360°)
since 17.10

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​

boolean

enable the user to zoom in and out
since 17.10
true
Default

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​

float

the magnification level to use when clicking the object
since 17.10
3
Default

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

backgroundColor​

rgb hex

the background color to use
since 17.10
#FFFFFF
Default

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

mouseSensitivity​

float

sensitivity of the mouse movement when rotating the object
since 17.10
1.0"
Default

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

pellets​

(*)

boolean

viewer draws optionally small dots on the video
(* Only available in FSI Viewer 360°)
since 17.10
true
Default

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​

float

defines opacity of the dots (pellets) drawn on the video
since 17.10
0.09
Default

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

adaptiveUISize​

boolean

determines if interface scales according to the zoom level
since 17.10
true
Default

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

inPlaceZoom​

enum

determines
since 17.10
true | false | auto
Values

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

Possible Values:Result:
trueIn-place Zoom is activated
falseIn-place Zoom is deactivated
autoIn-place Zoom is activated, but not on mobile devices

documentZoom​

enum

determines
since 17.10
true | false | auto
Values

Activates pinch document zoom on FSI Viewer instance.

Possible Values:Result:
truepinch document zoom is activated
falsepinch document zoom is deactivated
autopinch document zoom is activated on all touch-enabled devices

autoDisablePointerActions​

boolean

disables events if viewer is larger than viewport
since 17.10
true
Default

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

loadExactPreviewImagesAfterResize​

boolean

Reload images in the new required resolution after a resize event
since 17.10
true
Default

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

maxZoom​

float

defines the maximum magnification level
since 17.10
100
Default

Defines the maximum magnification level.

minInstanceSize​

integer

defines the minimum instance size
since 17.10
60
Default

Defines the minimum instance size of the viewer.