Skip to main content

Parameters

Parameters are added to the <fsi-imagegrid> tag.

Example:
<body>
  <fsi-imagegrid dir="images/" cellWidth="300" cellHeight="250"
    useTouchZoom="true" useQuickZoom="false" autoCrop="cc">
  </fsi-imagegrid>
</body>

debug​

boolean

Display debug and status information in the browser console
since 19.03
false
Default

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

format​

string

Defines the format used for the viewer
since 19.11
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.

dir​

string

defines the directory path
since 19.03

Defines the directory path which contains the images used for the grid.

width​

integer

defines the width of the grid
since 19.03

Defines the width of the FSI Image Grid instance in % or px.

height​

integer

defines the height of the grid
since 19.03

Defines the height of the FSI Image Grid instance in % or px.

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

observing changes
since 23.08
false
Default

If set to true, a mutation observer live observes all changes which are made to the metadata divs

cellWidth​

integer

defines the width of each image cell in px
since 19.03

Defines the width of each image cell in px.

cellHeight​

integer

defines the height of each image cell in px
since 19.03

Defines the height of each image cell in px.

garbageCollectionSize​

integer

Specifies how many images will be kept in memory although they ar not visible anymore
since 19.03
-1
Default

Specifies how many images will be kept in memory although they ar not visible anymore.

Use -1 for auto sizing the garbage collection size.

Use 0 to disable garbage collections (all images will be kept in memory, not recommended for huge collections)

Any other positive number: At least the specified number of images will be kept in memory. Can be more images if required by instance size and preloadCount parameter.

metaDataTemplate​

string

specifies server side template for meta data
since 19.03
details.json
Default

Defines the server side template file to load meta data with.

preloadCount​

integer

number of images to pre-load
since 19.03
40
Default

The number of images to pre-load although they are currently not visible.

Disabling preload (set value to 0) will only load images visible on stage.

cfg​

string

relative path to an XML configuration file in FSI Viewer format
since 19.03

When using a relative path the location specified by the FSI Viewer FSIBase parameter will be used, which is viewer/config/ by default.

autoCrop​

string

Crop images to fill entire image area
since 19.03
false
Default

Crop images to fill entire image area. Default is false. Use any combination of t,c,b and l,c,r where tl is top-left.

useQuickZoom​

boolean

uses FSI QuickZoom for the grid images
since 19.03
false
Default

Defines if FSI QuickZoom is used for the grid images. If activated, the images will be magnified if you hover over them.

useTouchZoom​

boolean

uses FSI TouchZoom for the grid images (touchscreen only)
since 19.03
false
Default

Defines if FSI TouchZoom is used for the grid images. If activated, the images will be magnified if you pinch-zoom into the website with a touchscreen device.

viewerSelector​

string

alias for viewerID
since 19.03

Defines a selector (e.g. #myViewer or fsi-viewer or .myClass) of an FSI Viewer instance to be used to display the selected image. You may use auto to use the first <fsi-viewer> tag in the document (if there is only one).

imageListLimit​

string

Name
since 18.06
info
Default

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​

string

sorts the image list
since 19.02
filename
Default

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

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

imageListSortOrder​

string

defines the order of the image list sorting
since 19.02
asc | desc
Values

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

ListFilterPositive​

string

filters the image list using RegEx, includes matching images
since 18.06

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. all other parameters only apply to the already filtered list.

Example: ListFilterPositive="/\/09\d*.tif/i"

ListFilterNegative​

string

filters the image list using RegEx, includes matching images
since 18.06

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 from 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. all other parameters only apply to the already filtered list.

Example: ListFilterNegative="/\/09\d*.tif/i"