Viewer Parameters Reference

Use these startup parameters to configure FlowPaper viewer behavior.

Parameters

Parameter	Type	Description
PDFFile	String	The PDF file FlowPaper should open.
ZoomTransition	String	Zoom transition used when zooming in FlowPaper. Uses Tweener modes. Default is easeOut. Examples: easenone, easeout, linear, easeoutquad.
ZoomTime	Number	Time for zoom to reach the new zoom factor. Should be 0 or greater.
ZoomInterval	Number	Zoom slider step size between each zoom factor. Default is 0.1. Should be a positive number.
FitPageOnLoad	Bool	Fits the page on initial load (same as fit-page toolbar action).
FitWidthOnLoad	Bool	Fits width on initial load (same as fit-width toolbar action).
localeChain	String	Locale (language) to use. See the language codes below.
FullScreenAsMaxWindow	Bool	If true, fullscreen opens a new maximized browser window instead of true fullscreen.
ProgressiveLoading	Bool	If true, progressively loads and displays the document instead of waiting for full download.
MaxZoomSize	Number	Maximum allowed zoom level.
MinZoomSize	Number	Minimum allowed zoom level.
SearchMatchAll	Bool	If true, highlights all matches when searching in a document.
InitViewMode	String	Startup view mode, for example Portrait or TwoPage.
PrintPaperAsBitmap	Bool	If true, prints as bitmap instead of vector output.
StartAtPage	Number	Starts the viewer at a specific page.
ViewModeToolsVisible	Bool	Shows or hides view mode tools in the toolbar.
ZoomToolsVisible	Bool	Shows or hides zoom tools in the toolbar.
NavToolsVisible	Bool	Shows or hides navigation tools in the toolbar.
CursorToolsVisible	Bool	Shows or hides cursor tools in the toolbar.
SearchToolsVisible	Bool	Shows or hides search tools in the toolbar.
jsDirectory	String	Sets JavaScript directory location. Applies only when AdaptiveUI is enabled.
cssDirectory	String	Sets CSS directory location. Applies only when AdaptiveUI is enabled.
localeDirectory	String	Sets locale directory location. Applies only when AdaptiveUI is enabled.

Supported localeChain values

• en_US (English)
• fr_FR (French)
• zh_CN (Chinese, Simplified)
• es_ES (Spanish)
• pt_BR (Brazilian Portuguese)
• ru_RU (Russian)
• fi_FN (Finnish)
• de_DE (German)
• nl_NL (Netherlands)
• tr_TR (Turkish)
• se_SE (Swedish)
• pt_PT (Portuguese)
• el_EL (Greek)
• dn_DN (Danish)
• cz_CS (Czech)
• it_IT (Italian)
• pl_PL (Polish)
• pv_FN (Finnish)
• hu_HU (Hungarian)

Example configuration

$('#documentViewer').FlowPaperViewer({
  config: {
    PDFFile: "Paper.pdf",
    Scale: 0.6,
    ZoomTransition: "easeOut",
    ZoomTime: 0.5,
    ZoomInterval: 0.1,
    FitPageOnLoad: false,
    FitWidthOnLoad: false,
    FullScreenAsMaxWindow: true,
    ProgressiveLoading: true,
    MinZoomSize: 0.2,
    MaxZoomSize: 5,
    SearchMatchAll: false,
    InitViewMode: 'Flipbook',
    ViewModeToolsVisible: true,
    ZoomToolsVisible: true,
    NavToolsVisible: true,
    CursorToolsVisible: true,
    SearchToolsVisible: true,
    localeChain: "en_US"
  }
});