| annotationEditorMode | Number | 0 (-1) | Controls the annotation editor mode.- DISABLE: -1
- NONE: 0
- FREETEXT: 3
- HIGHLIGHT: 9
- STAMP: 13
- INK: 15
- SIGNATURE: 101
|
| annotationMode | Number | 1 | Controls which annotations are rendered.- DISABLE: 0 (disables all annotations)
- ENABLE: 1 (includes all possible annotations)
- ENABLE_FORMS: 2 (excludes annotations that contain interactive form elements, those will be rendered in the display layer)
- ENABLE_STORAGE: 3 (includes all possible annotations - as above - but where interactive form elements are updated with data from the AnnotationStorage}-instance; useful e.g. for printing
|
| cursorToolOnLoad | Number | 0 | The cursor tool that will be enabled on load. |
| defaultZoomValue | String | empty (page-width) | Default zoom level of the viewer.- auto
- page-actual
- page-width
- page-height
- page-fit
- a zoom level in percent
|
| disableAutoFetch | Boolean | false | If activated, pages are not loaded in advance. Only pages that are currently required are loaded. This may reduce data consumption for large PDFs or slow connections. If the user scrolls quickly through the document, delays may occur.The server which delivered the pdf files must support range requests. Most common web servers supports this. |
| disableHistory | Boolean | false | Disable browsing history. The browsing history is only enabled when the viewer is standalone, i.e. not when it is embedded in a web page. See: historyUpdateUrl |
| disablePageLabels | Boolean | false (true) | If activated, user-defined page labels are not used in a PDF document. Some PDFs define custom page labels, such as: Roman numerals (I, II, III, ...) |
| disablePreferences | Boolean | false (true) | Disable console warning on manual override AppOptions |
| disableRange | Boolean | false | Disable range requests (not recommended). If disabled, the PDF is displayed only after the file is fully loaded. |
| disableStream | Boolean | false | Disable streaming for requests (not recommended). |
| enableAutoLinking | Boolean | true (false) | Enable creation of hyperlinks from text that look like URLs. |
| enableComment | Boolean | false | Enable comments on annotations. Since v1.5.4 |
| enableHighlightFloatingButton | Boolean | false | Floating Highlight-Button direct on text select |
| enableMerge | Boolean | true (false) | Enables the merge feature. Allow inserting (merging) a external PDF file after the current page. v1.7.0 The option enableSplitMerge must enabled too. |
| enableOptimizedPartialRendering | Boolean | false | Enable tracking of PDF operations to optimize partial rendering. |
| enablePermissions | Boolean | false | Enables PDF document permissions, when they exist |
| enablePrintAutoRotate | Boolean | true | When enabled, landscape pages are rotated when printed. |
| enableScripting | Boolean | false | Whether to allow execution of active content (JavaScript) by PDF files. |
| enableSelectionRendering | Boolean | true (false) | Enable to make text selection in HCM mode more visible. (Experimental) v1.7.0 |
| enableSignatureEditor | Boolean | true | If enabled, the signature annotation editor is active |
| enableSplitMerge | Boolean | true (false) | Enabled the PDF edit feature and the possibility to drag & drop some thumbnails in the pages view. v1.7.0 |
| enableUpdatedAddImage | Boolean | false | Enabled new "add image" dialog |
| externalLinkRel | String | noopener noreferrer nofollow | Set rel attribute for external links.- 0: default
- 1: replaces current window
- 2: new window
- 3: parent
- 4: in top window
|
| externalLinkTarget | Number | 0 (2) | Controls how external links will be opened. |
| forcePageColors | Boolean | false | If enabled, the pdf rendering will use the high contrast mode colors |
| highlightEditorColors | String | yellow=#FFFF98, green=#53FFBC, blue=#80EBFF, pink=#FFCBE6, red=#FF4F5F, yellow_HCM=#FFFFCC, green_HCM=#53FFBC, blue_HCM=#80EBFF, pink_HCM=#F6B8FF, red_HCM=#C50043 | Available colors in highlight editor. Color names ending with ‘_HCM’ are used in high contrast mode. |
| historyUpdateUrl | Boolean | false | Enable historyUpdateUrl. If activated, the URL hash is updated e.g. in the page navigation like #page=2 |
| ignoreDestinationZoom | Boolean | false | If enabled, the current zoom level is used or specified via the defaultZoomValue option instead of being taken from the PDF document. |
| imageResourcesPath | String | ./images/ | Path for image resources, mainly for icons. Include trailing slash |
| imagesRightClickMinSize | String | -1 (99999) | All images whose width and height are at least this value (in pixels) will be lazily inserted in the dom to allow right-clicking and saving them. Use -1 to disable this. v1.7.0 The option allowContextMenu must enabled too. |
| localeProperties | Object | { lang: sap.ui.getCore()
.getConfiguration()
.getLanguage()
} | Localization to use. |
| pageColorsBackground | String | Canvas | The Background color of the page as CSS color string. To improve readability in high-contrast mode. |
| pageColorsForeground | String | Canvas | The Foreground color of the page as CSS color string. To improve readability in high-contrast mode. |
| printResolution | String | 150 | Specify print resolution in dpi. |
| scrollModeOnLoad | Number | -1 (0) | Controls the viewer's scroll mode upon load.- -1: the last position if available / enabled
- 0: vertical scrolling
- 1: horizontal scrolling
- 2: wrapped scrolling
- 3: page scrolling
|
| sidebarViewOnLoad | Number | -1 (0) | Controls the state of the sidebar upon load.- -1: page mode if available, otherwise the last position if available / enabled
- 0: do not show sidebar
- 1: show thumbnails in sidebar
- 2: show document outline in sidebar
- 3: show attachments in sidebar
- 4: show layers in sidebar v1.6.0
|
| spreadModeOnLoad | Number | -1 (0) | Whether the viewer should join pages into spreads upon load.- -1: the last position if available / enabled
- 0: no spreads
- 1: odd spreads
- 2: even spreads.
|
| supportsCaretBrowsingMode | Boolean | false | Enable support for caret browsing |
| supportsIntegratedFind | Boolean | false | Set to true to enable browser search and disable PDF.js search |
| supportsMouseWheelZoomCtrlKey | Boolean | true | If enabled, zoom can be controlled with mouse wheel + ctrl key |
| supportsMouseWheelZoomMetaKey | Boolean | true | If enabled, zoom can be controlled with mouse wheel + meta key |
| supportsPinchToZoom | Boolean | true | Enable zooming on pinch gesture |
| textLayerMode | Number | 1 | Controls if the text layer is enabled, and the selection mode that is used.- 0: DISABLE
- 1: ENABLE
- 2: ENABLE_PERMISSIONS
Set this to 0 to prevent copying text from pdf content. |
| toolbarDensity | Number | 0 | Set the toolbar density. value.- 0: normal
- 1: compact
- 2:touch
Set this to 2 depending on device type such phone for better useability. |
| viewOnLoad | Number | 0 (1) | The position in the document upon load.- -1: uses OpenAction if available, otherwise equal to
viewOnLoad = 0 - 0: the last viewed page / position
- 1: the initial page/position.
|