Skip to main content

Plugin Parameters

plugins​

string

adds a Plug-in (e.g. Fullscreen) to FSI Pages
since 17.10

Adds a plug-in to the viewer. Multiple plug-ins can be listed seperated by comma.

tip

If you would like to add specific parameters to the plugins via the <fsi-pages tag>, you can do this by prefixing the parameter name with the name of the plug-in, e.g. pagesthumbbar_height="100"

FullScreen Plug-In​

Adding the parameter plugins:"FullScreen, Resize" enables a full screen view option in FSI Pages. The Resize parameter needs to be set in order to ensure proper adjusting to the full screen.

tip

If the FSI Pages is embedded in an iFrame, the attribute allowfullscreen="true" needs to be added to the iFrame. Otherwise, the FullScreen Plug-in will not work due to security restrictions of the browser.

PagesThumbBar​

Adding the parameter plugins:"PagesThumbBar" displays a row of thumbnails at the bottom of the pages.

The following parameters can be used to adapt the PagesThumbBar:

pageNumbers​

boolean

Page numbers being displayed below thumbnails
since 17.10
true
Default

Enables/ disables the display of page numbers being below the thumbnails.

autohide​

boolean

Auto hides thumbbar below 600px
since 17.10
true
Default

If set to true, the thumbnails will not be displayed if the FSI Pages Instance is smaller than 600px.

height​

integer

Defines height of the thumbnails
since 17.10
160
Default

Defines the height of the thumbnails displayed.

Bookmarks​

Adding the parameter plugins:"Bookmarks" adds a bookmark functionality to FSI Pages.

The following parameters can be used to adapt the bookmark functionality:

thumbSize​

float

Defines the thumbnail size in the bookmark list
since 17.10
200
Default

Defines the maximum thumbnail size in the bookmark list in pixel.

showIconsOnPages​

boolean

Shows icon on bookmarked pages
since 17.10
true
Default

Shows icon on bookmarked pages.

pageNumbers​

boolean

Shows page numbers in bookmark list
since 17.10
true
Default

Shows page numbers in bookmark list.

persistentStorage​

boolean

Defines if the bookmark data is being cached
since 17.10
true
Default

When disabled, the bookmarks will be deleted when the user leaves the FSI Pages instance. When enabled the data will be cached for the given time (defined by PersistentStorageExpiresAfter)

persistentStorageExpiresAfter​

integer

Keep note data for given time
since 17.10

Defines after which period of time the cached note data expires.

Chapters​

Adding the parameter plugins:"Chapters" adds a select box to the user interface of FSI Pages. The user can directly access sections of a catalog by selecting the corresponding item in the select box.

You can either integrate a <fsi-pages-chapters> node directly in the <fsi-pages> tag or add an external XML file with your chapters.

Integrating the Chapters structure directly in fsi-pages tag​

Example in HTML:
<fsi-pages
  dir="images/catalog"
  width="100%"
  height="100%"
>
  <fsi-pages-chapters style="display:none">
    <chapter page="1">Cover</chapter>
    <chapter page="4">Table of contents</chapter>
    <chapter page="10">
      Chapter 1
      <chapter page="10">Chapter 1.1</chapter>
      <chapter page="20">Chapter 1.2</chapter>
    </chapter>
    <chapter page="30">
      Chapter 2
      <chapter page="30">Chapter 2.1</chapter>
      <chapter page="40">Chapter 2.2</chapter>
    </chapter>
  </fsi-pages-chapters>
</fsi-pages>

Using an external XML file​

You can assign colors and different levels to each chapter using simple XML based data describing the document structures.

Example:
<Indexdata>
  <Index label="First Page" page="1" color="FFFF00" />
  <Index label="Chapter 1" page="10" color="00FF00">
    <Index label="Chapter 1.1" page="20" color="00FF00"/>
    <Index label="Chapter 1.2" page="30" color="00FF00"/>
    <Index label="Chapter 1.3" page="40" color="00FF00"/>
  </Index>
  <Index label="Chapter 2" page="50" color="0000FF"/>
  <Index label="Chapter 3" page="60" color="CCCCCC"/>
  <Index label="Chapter 4" page="70" color="FF0000"/>
</Indexdata>

The following parameters can be used to adapt the Chapters:

indexDataFile​

string

URL to an external XML file describing the document structure
since 17.10

You can use an external XML file to provide the XML document structure data required for this plug-in. The XML file must be located in the same domain as FSI Viewer to avoid cross-domain security restrictions.

width​

integer

Width of the select box
since 17.10

Usually the FSI Pages skin defines the width and position of the select box. Alternatively you can specify a fixed width in pixels using this parameter.