Skip to main content

General Parameters

FSI Layers has a few parameters which are directly set in the <fsi-layers> tag.

For properties which are added to the <fsi-layer> or <fsi-layer-group> tag, please see Properties.

Example:
<fsi-layers id="myLayers" debug="true" showInfo="true">

  <fsi-layer name="background" width="100%" height="100%"
    src="images/configurator/background.png">
  </fsi-layer>

</fsi-layers>

debug​

boolean

debug info
since 21.04
false
Default

Displays debug & status information in the javascript console.

showInfo​

boolean

show info of all layers and groups
since 21.04
false
Default

Shows the info (name, dimensions, clipping state) and direction arrows of all layers and groups.

useDevicePixelRatio​

boolean

Use the device's pixel ratio
since 21.04
true
Default

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

effects​

string

Image manipulation parameters for all images
since 21.04

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.

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

renderer​

string

parameter to use for image requests
since 21.04

The renderer parameter to use for image requests (e.g. jpeg)

autoInit​

boolean

Prevents automatic initialisation when the instance has been attached to the DOM
since 23.08
true
Default

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

observeInlineTemplateChanges​

boolean

observe changes
since 23.08
false
Default

If set to true, a mutation observer live observes all changes which are made to the underlying groups and layers.