3.2. Complete arender front end configuration properties list

3.2.1. date.format

Type :

String

Description :

Specify the date format for the annotations

Default :

dd-MM-yyyy HH:mm:ss

3.2.2. style.sheet

Type :

String

Description :

Change the default ARender CSS

Default :

ARender-mat.min.css

3.2.3. arenderjs.startupScript

Type :

String

Description :

ARenderJS Configuration : customization startup script URL

Default :

empty by default

3.2.4. about.dialog.statistics.enable

Type :

boolean

Description :

Disable/enable showing statistics in the about dialog box

Default :

true

3.2.5. about.dialog.statistics.table.enable

Type :

boolean

Description :

Disable/enable showing table statistics in the about dialog box (removes as well the graph values)

Default :

true

3.2.6. about.dialog.statistics.charts.enable

Type :

boolean

Description :

Disable/enable the charts in the statistics section pulls the library from google API (gwt charts)

Default :

false

3.2.7. about.dialog.show.current.version

Type :

boolean

Description :

Displays the current version in the about dialog box

Default :

true

3.2.8. about.dialog.show.current.user

Type :

boolean

Description :

Displays the current user in the about dialog box

Default :

true

3.2.10. topPanel.logo.url

Type :

String

Description :

Define the top panel logo URL

Default :

arender-icones-svg/arender-logo-white.svg

3.2.11. topPanel.logo.width

Type :

integer

Description :

The top panel logo width (in pixel)

Default :

26

3.2.12. topPanel.logo.height

Type :

integer

Description :

The top panel logo height (in pixel)

Default :

26

3.2.13. topPanel.logo.margin.left

Type :

integer

Description :

The top panel logo margin left (in pixel)

Default :

10

3.2.14. topPanel.widgets.beanNames

Type :

String

Description :

The list of widgets to define (XML bean names) for the top panel

Default :

logo,documentMenu,printButton,annotationMenu,cropBoxButton,saveDirtyAnnotations,refreshAnnotation,addObfuscateAnnotationButton,navigationButtons,zoomButtons,rotationButtons,multiViewTools,annotationToolbar,searchBox,fullscreenButton,documentBuilderButton,plumeMenu

3.2.15. topPanel.navigation.buttons.beanNames

Type :

String

Description :

The list of widgets to define (XML bean names) for the navigation section

Default :

firstPageButton,previousPageButton,pageNavigation,nextPageButton,lastPageButton

3.2.16. topPanel.zoom.buttons.beanNames

Type :

String

Description :

The list of widgets to define (XML bean names) for the zoom section

Default :

zoomOut,zoomBox,zoomIn,zoomInZone,zoomInZoneGlass,zoomFullWidth,zoomFullHeight,zoomFullPage

3.2.17. topPanel.rotation.buttons.beanNames

Type :

String

Description :

The list of widgets to define (XML bean names) for the rotation section

Default :

rotateAllLeft,rotateLeft,rotateRight,rotateAllRight

3.2.18. topPanel.annotation.buttons.beanNames

Type :

String

Description :

The list of widgets to define (XML bean names) for the annotation sub-menu

Default :

addStickyNoteAnnotationButton,addFreeTextAnnotationButton,addHighlightRectangleAnnotationButton,addHighlightCircleAnnotationButton,addHighlightRectangleAnnotationRepeatButton,addHighlightCircleAnnotationRepeatButton,addPolygonAnnotationButton,addPolylineAnnotationButton,addFreehandAnnotationButton,addHighlightTextAnnotationButton,addUnderlineTextAnnotationButton,addStrikethroughTextAnnotationButton,addArrowAnnotationButton,addArrowAnnotationRepeatButton,addStampAnnotationButton,addPolygonAnnotationRepeatButton,addPolylineAnnotationRepeatButton,addFreehandAnnotationRepeatButton,addHighlightTextAnnotationRepeatButton,addUnderlineTextAnnotationRepeatButton,addStrikethroughTextAnnotationRepeatButton,showAllAnnotationsButton,showAllAnnotationsAndRotationsButton

3.2.19. topPanel.download.buttons.beanNames

Type :

String

Description :

The list of widgets to define (XML bean names) for the download/upload file sub-menu

Default :

downloadButton,downloadRootButton,downloadPdfButton,downloadAllButton,downloadAnnotationsButton,downloadAnnotationsCSVButton,downloadXFDFAnnotationsButton,downloadFDFAnnotationsButton,downloadWithFDFAnnotationsButton,uploadButton,uploadURLButton,uploadXFDFButton

3.2.20. topPanel.documentMenu

Type :

boolean

Description :

Activate the document sub-menu

Default :

true

3.2.21. topPanel.cropbox.enabled

Type :

boolean

Description :

Activate the button for cropbox in the toppanel

Default :

false

3.2.22. topPanel.lineHeadTailMenu

Type :

boolean

Description :

Change to false to remove line head options menu.

Default :

true

3.2.23. topPanel.documentMenu.upload

Type :

boolean

Description :

Activate the upload file button

Default :

true

3.2.24. topPanel.documentMenu.url

Type :

boolean

Description :

Activate the open url button

Default :

true

3.2.25. topPanel.documentMenu.url.open.using.enter

Type :

boolean

Description :

Allow to use enter to validate the input URL from the URL button

Default :

false

3.2.26. topPanel.documentMenu.xfdfUpload

Type :

boolean

Description :

Activate the top panel XFDF upload button

Default :

false

3.2.27. topPanel.documentMenu.download

Type :

boolean

Description :

Activate the top panel download document button

Default :

true

3.2.28. topPanel.documentMenu.download.root

Type :

boolean

Description :

Activate the top panel download composite document button

Default :

true

3.2.29. topPanel.documentMenu.download.behavior

Type :

String

Description :

The default behavior for download. Valid values : DOWNLOAD_SOURCE or DOWNLOAD_NON_PDF

Default :

DOWNLOAD_NON_PDF

3.2.30. topPanel.documentMenu.downloadPDF

Type :

boolean

Description :

Activate the top panel button : download document as PDF

Default :

true

3.2.31. topPanel.documentMenu.downloadAll

Type :

boolean

Description :

Activate the top panel button : download all current documents as a single PDF

Default :

true

3.2.32. topPanel.documentMenu.downloadAnnotation

Type :

boolean

Description :

Activate the top panel button : download the current document with annotations as PDF

Default :

true

3.2.33. topPanel.documentMenu.downloadCSVAnnotations

Type :

boolean

Description :

Activate the top panel button : download the current document annotations as CSV

Default :

false

3.2.34. topPanel.documentMenu.downloadWithFDFAnnotation

Type :

boolean

Description :

Activate the top panel button : download the current document with annotations as FDF

Default :

false

3.2.35. topPanel.documentMenu.downloadXFDFAnnotations

Type :

boolean

Description :

Activate the top panel button : download the current document annotations as XFDF

Default :

false

3.2.36. topPanel.documentMenu.downloadFDFAnnotations

Type :

boolean

Description :

Activate the top panel button : download the current document annotations as FDF

Default :

false

3.2.37. topPanel.subMenu.button.timeOut

Type :

integer

Description :

Sets up the time in Milliseconds before the sub-menu buttons disappear

Default :

100

3.2.38. topPanel.subMenu.subPanel.timeOut

Type :

integer

Description :

Sets up the time in Milliseconds before the sub-menu panel disappears

Default :

500

3.2.39. topPanel.print

Type :

boolean

Description :

Activate the print button in the topPanel

Default :

true

3.2.40. topPanel.annotationMenu

Type :

boolean

Description :

Activate the annotation sub-menu

Default :

true

3.2.41. topPanel.annotationMenu.stickyNote

Type :

boolean

Description :

Activate the sticky note annotation button

Default :

true

3.2.42. topPanel.annotationMenu.freetext

Type :

boolean

Description :

Activate the freetext annotation button

Default :

true

3.2.43. topPanel.annotationMenu.stickyNote.editable

Type :

boolean

Description :

Allow the sticky note to be edited

Default :

true

3.2.44. topPanel.annotationMenu.highlight

Type :

boolean

Description :

Activate the highlight annotation button

Default :

true

3.2.45. topPanel.annotationMenu.highlight.repeat

Type :

boolean

Description :

Activate the highlight annotation button, in repeat mode (does not cancel unless pressed again)

Default :

false

3.2.46. topPanel.annotationMenu.arrow

Type :

boolean

Description :

Activate the arrow annotation button

Default :

true

3.2.47. topPanel.annotationMenu.arrow.repeat

Type :

boolean

Description :

Activate the arrow annotation button, in repeat mode (does not cancel unless pressed again)

Default :

false

3.2.48. topPanel.annotationMenu.polygon

Type :

boolean

Description :

Activate the polygon annotation button

Default :

true

3.2.49. topPanel.annotationMenu.polygon.repeat

Type :

boolean

Description :

Activate the polygon annotation button, in repeat mode (does not cancel unless pressed again)

Default :

false

3.2.50. topPanel.annotationMenu.polyline

Type :

boolean

Description :

Activate the polyline annotation button

Default :

true

3.2.51. topPanel.annotationMenu.polyline.repeat

Type :

boolean

Description :

Activate the polyline annotation button, in repeat mode (does not cancel unless pressed again)

Default :

false

3.2.52. topPanel.annotationMenu.freehand

Type :

boolean

Description :

Activate the freehand annotation button

Default :

true

3.2.53. topPanel.annotationMenu.freehand.repeat

Type :

boolean

Description :

Activate the freehand annotation button, in repeat mode (does not cancel unless pressed again)

Default :

false

3.2.54. topPanel.annotationMenu.highlightText

Type :

boolean

Description :

Activate the text highlight annotation button

Default :

false

3.2.55. topPanel.annotationMenu.highlightText.repeat

Type :

boolean

Description :

Activate the text highlight annotation button, in repeat mode (does not cancel unless pressed again)

Default :

false

3.2.56. topPanel.annotationMenu.underlineText

Type :

boolean

Description :

Activate the text underline annotation button

Default :

false

3.2.57. topPanel.annotationMenu.underlineText.repeat

Type :

boolean

Description :

Activate the text underline annotation button, in repeat mode (does not cancel unless pressed again)

Default :

false

3.2.58. topPanel.annotationMenu.strikethroughText

Type :

boolean

Description :

Activate the strikethrough text annotation button

Default :

false

3.2.59. topPanel.annotationMenu.strikethroughText.repeat

Type :

boolean

Description :

Activate the strikethrough text annotation button, in repeat mode (does not cancel unless pressed again)

Default :

false

3.2.60. topPanel.annotationMenu.circle

Type :

boolean

Description :

Activate the circle annotation button

Default :

true

3.2.61. topPanel.annotationMenu.circle.repeat

Type :

boolean

Description :

Activate the circle annotation button, in repeat mode (does not cancel unless pressed again)

Default :

false

3.2.62. topPanel.annotationMenu.stamp

Type :

boolean

Description :

Activate the stamp annotation button

Default :

true

3.2.63. topPanel.annotationMenu.hide

Type :

boolean

Description :

Activate the hide annotations button

Default :

true

3.2.64. topPanel.annotationMenu.hideAll

Type :

boolean

Description :

Activate the hide all annotations button (includes redaction)

Default :

false

3.2.65. topPanel.obfuscate

Type :

boolean

Description :

Activate the redaction annotation button

Default :

true

3.2.66. topPanel.refresh

Type :

boolean

Description :

Activate the refresh annotations button

Default :

true

3.2.67. topPanel.zoomBox

Type :

boolean

Description :

Activate the boxed zoom button

Default :

true

3.2.68. toaster.log.severe.autoHide

Type :

boolean

Description :

Allows SEVERE toaster notifications to autohide

Default :

false

3.2.69. toaster.log.warning.autoHide

Type :

boolean

Description :

Allows WARNING toaster notifications to autohide

Default :

true

3.2.70. toaster.log.info.autoHide

Type :

boolean

Description :

Allows INFO toaster notifications to autohide

Default :

true

3.2.71. toaster.log.config.autoHide

Type :

boolean

Description :

Allows CONFIG toaster notifications to autohide

Default :

true

3.2.72. toaster.log.fine.autoHide

Type :

boolean

Description :

Allows FINE toaster notifications to autohide

Default :

true

3.2.73. toaster.log.finer.autoHide

Type :

boolean

Description :

Allows FINER toaster notifications to autohide

Default :

true

3.2.74. toaster.log.finest.autoHide

Type :

boolean

Description :

Allows FINEST toaster notifications to autohide

Default :

true

3.2.75. toaster.log.severe.enabled

Type :

boolean

Description :

Allows SEVERE toaster notifications to be displayed

Default :

true

3.2.76. toaster.log.warning.enabled

Type :

boolean

Description :

Allows WARNING toaster notifications to be displayed

Default :

true

3.2.77. toaster.log.info.enabled

Type :

boolean

Description :

Allows INFO toaster notifications to be displayed

Default :

true

3.2.78. toaster.log.config.enabled

Type :

boolean

Description :

Allows CONFIG toaster notifications to be displayed

Default :

false

3.2.79. toaster.log.fine.enabled

Type :

boolean

Description :

Allows FINE toaster notifications to be displayed

Default :

false

3.2.80. toaster.log.finer.enabled

Type :

boolean

Description :

Allows FINER toaster notifications to be displayed

Default :

false

3.2.81. toaster.log.finest.enabled

Type :

boolean

Description :

Allows FINEST toaster notifications to be displayed

Default :

false

3.2.82. toaster.toast.timeout

Type :

integer

Description :

Sets up the timeout for toaster notifications to be hidden

Default :

2000

3.2.83. toaster.toast.newestOnTop

Type :

boolean

Description :

If true, displays the newest toaster logs on top, if false, on the bottom

Default :

true

3.2.84. topPanel.pageNavigation.first

Type :

boolean

Description :

Activates the go to first page navigation button

Default :

true

3.2.85. topPanel.pageNavigation.previous

Type :

boolean

Description :

Activates the go to previous page navigation button

Default :

true

3.2.86. topPanel.pageNavigation.next

Type :

boolean

Description :

Activates the go to next page navigation button

Default :

true

3.2.87. topPanel.pageNavigation.last

Type :

boolean

Description :

Activates the go to last page navigation button

Default :

true

3.2.88. topPanel.zoom.fullWidth

Type :

boolean

Description :

Activates the zoom (full width of document) button

Default :

true

3.2.89. topPanel.zoom.fullHeight

Type :

boolean

Description :

Activates the zoom (full height of document) button

Default :

true

3.2.90. topPanel.zoom.fullPage

Type :

boolean

Description :

Activates the zoom (full page of document) button

Default :

true

3.2.91. topPanel.zoom.in

Type :

boolean

Description :

Activates the zoom in button

Default :

true

3.2.92. topPanel.zoom.out

Type :

boolean

Description :

Activates the zoom out button

Default :

true

3.2.93. topPanel.zoom.zone

Type :

boolean

Description :

Activates the zoom by zone button

Default :

true

3.2.94. topPanel.zoom.zoneGlass

Type :

boolean

Description :

Activates the zoom (magnifying glass) button

Default :

false

3.2.95. topPanel.zoom.zoneGlass.value

Type :

integer

Description :

Sets the default zoom ratio for the magnifying glass

Default :

2

3.2.96. topPanel.rotation.left

Type :

boolean

Description :

Activates the rotate left button

Default :

true

3.2.97. topPanel.rotation.right

Type :

boolean

Description :

Activates the rotate right button

Default :

true

3.2.98. topPanel.rotation.all

Type :

boolean

Description :

Activates the rotate all pages buttons

Default :

false

3.2.99. topPanel.rotation.degree

Type :

integer

Description :

Sets up the amount of rotation applied when pressing the rotation buttons

Default :

90

3.2.100. topPanel.rotation.add

Type :

boolean

Description :

Activates rotations sub-menu

Default :

true

3.2.102. topPanel.search.default

Type :

boolean

Description :

If true, default search behavior. Otherwise, open in the advanced search panel

Default :

false

3.2.103. topPanel.search.displayResultsInExplorer

Type :

boolean

Description :

If true and topPanel.search.default is true, display search text results in the AdvancedSearchExplorer.

Default :

false

3.2.104. topPanel.search.searchByVisiblePage

Type :

boolean

Description :

If true, the “next result” search button will jump to the next result on the current visible page instead of resuming where you left the search

Default :

true

3.2.105. topPanel.fullscreen

Type :

boolean

Description :

Activates the full screen button in the top panel

Default :

true

3.2.106. topPanel.fullscreen.hideTopPanel

Type :

boolean

Description :

If true, full screen will hide the top panel totally

Default :

false

3.2.107. topPanel.fullscreen.alwaysShowTopPanel

Type :

boolean

Description :

If true, the toppanel will always be visible in fullscreen and won’t hide

Default :

false

3.2.108. toolbar.activateBorders

Type :

boolean

Description :

Allows from the toolbar to alter the borders of annotations

Default :

true

3.2.109. toolbar.lockedObfuscate

Type :

boolean

Description :

If true, all redaction annotations will become locked once saved, and can no longer be edited

Default :

false

3.2.110. annotation.canHideObfuscate

Type :

boolean

Description :

If true, all redaction annotations can be hidden using the regular hide annotations button

Default :

false

3.2.111. documentnavigator.width

Type :

integer

Description :

Sets up the width (in pixel) of the document navigator (left tabs of ARender)

Default :

255

3.2.112. documentnavigator.ears.hideTimerDelay

Type :

integer

Description :

Sets up the time (in ms) to auto hide the arrow for maximizing or reducing the document navigator

Default :

500

3.2.113. documentnavigator.initialWidth

Type :

String

Description :

Sets up the default position of the document navigator tabs: Default, Reduced or Expanded

Default :

Default

3.2.114. thumbexplorer.enabled

Type :

boolean

Description :

Activates the thumbExplorer : the view to browse the document by thumbnails

Default :

true

3.2.115. thumbexplorer.indentation

Type :

integer

Description :

Sets up the indentation of Thumbs, in pixels when they need to indent (child documents)

Default :

20

3.2.116. thumbexplorer.maxLevelToLoad

Type :

integer

Description :

Sets up the maximum level of indentation

Default :

10

3.2.117. thumbexplorer.thumb.margin

Type :

integer

Description :

Sets up the thumbs margin in pixels

Default :

5

3.2.118. thumbexplorer.thumb.width

Type :

integer

Description :

Sets up the thumbs width in pixels

Default :

100

3.2.119. thumbexplorer.thumb.grow.min

Type :

integer

Description :

Sets up the minimum amount of pixels needed for the pictree to grow in size

Default :

300

3.2.120. thumbexplorer.thumb.grow.increment

Type :

integer

Description :

Sets up the growth increment once the thumbnail can grow

Default :

10

3.2.121. thumbexplorer.thumb.grow.ratio

Type :

integer

Description :

Sets up the growth ratio corresponding to the growth of the panel

Default :

1

3.2.122. thumbexplorer.title.allowHTML

Type :

boolean

Description :

If true, allows thumbnails titles to have HTML content

Default :

false

3.2.123. thumbexplorer.metadata

Type :

boolean

Description :

If true, thumbnails will display a popup information with document metadata

Default :

true

3.2.124. thumbexplorer.layout.loading.delay

Type :

integer

Description :

Sets up the delay in milliseconds to load the layout for the thumbnails

Default :

5

3.2.125. thumbexplorer.contextualMenu.createPageAnchor

Type :

boolean

Description :

Allows to create an URL anchor to a page from the thumbnails

Default :

true

3.2.126. annotationexplorer.enabled

Type :

boolean

Description :

If true, enables the legacy annotation explorer

Default :

false

3.2.127. bookmarkexplorer.enabled

Type :

boolean

Description :

If true, enables the bookmark explorer

Default :

true

3.2.128. bookmarkexplorer.showAtStartup

Type :

boolean

Description :

If true, show the bookmark explorer at the application startup

Default :

false

3.2.129. bookmarkexplorer.draggable

Type :

boolean

Description :

If true, make the bookmarks draggable

Default :

false

3.2.130. bookmarkexplorer.forceLocked

Type :

boolean

Description :

If true, make the bookmarks being marked as locked once saved

Default :

true

3.2.131. bookmarkexplorer.forceReadOnly

Type :

boolean

Description :

If true, make the bookmarks read only once saved

Default :

false

3.2.132. advanced.searchexplorer.enabled

Type :

boolean

Description :

If true, enables the advanced search explorer

Default :

true

3.2.133. advanced.searchexplorer.min.characterLength

Type :

integer

Description :

Sets up the minimum character length allowed

Default :

0

3.2.134. advanced.searchexplorer.max.characterLength

Type :

integer

Description :

Sets up the maximum character length allowed

Default :

255

3.2.135. advanced.searchexplorer.tooltipOnHover.enabled

Type :

boolean

Description :

If true, enables tooltip on hover

Default :

true

3.2.136. advanced.searchexplorer.caseSensitive.tooltip.enabled

Type :

boolean

Description :

If true, enables case sensitive tooltip

Default :

false

3.2.137. advanced.searchexplorer.accentSensitive.tooltip.enabled

Type :

boolean

Description :

If true, enables accent sensitive tooltip

Default :

false

3.2.138. advanced.searchexplorer.regex.tooltip.enabled

Type :

boolean

Description :

If true, enables regex tooltip

Default :

true

3.2.139. documentbuilder.enabled

Type :

boolean

Description :

Enables the document builder button (and feature)

Default :

false

3.2.140. documentbuilder.button.visible

Type :

boolean

Description :

Sets the document builder button visible

Default :

true

3.2.141. documentbuilder.activateOnStartup

Type :

boolean

Description :

Activate the document builder at startup as soon as the documents are ready

Default :

false

3.2.142. documentbuilder.hideDocumentNavigator

Type :

boolean

Description :

Hide the document navigator once the document builder is opened

Default :

true

3.2.143. documentbuilder.displaySaveWarning

Type :

boolean

Description :

Display a save warning if a document with modifications is left when leaving ARender

Default :

true

3.2.144. documentbuilder.thumbs.draggable

Type :

boolean

Description :

Make the document builder thumbnails draggable in order to organize the pages

Default :

true

3.2.145. documentbuilder.width

Type :

integer

Description :

Sets the document builder panel width

Default :

280

3.2.146. documentbuilder.save.action

Type :

String

Description :

Sets the document builder default save button action

Default :

save

3.2.147. documentbuilder.save.behavior

Type :

String

Description :

Sets the document builder save behavior (legacy) : UPDATE_NO_DOCUMENT, CREATE_NEW_FIRST_DOCUMENT, UPDATE_FIRST_DOCUMENT, UPDATE_ALL_DOCUMENT

Default :

UPDATE_NO_DOCUMENT

3.2.148. documentbuilder.save.download

Type :

boolean

Description :

Activates the local download builder button

Default :

true

3.2.149. documentbuilder.save.delete

Type :

boolean

Description :

Activates the delete current document from the builder button

Default :

false

3.2.150. documentbuilder.save.freeze

Type :

boolean

Description :

Once documents are built, a frozen title will remain and need to be manually removed to confirm the operation

Default :

true

3.2.151. documentbuilder.addChild.enabled

Type :

boolean

Description :

Allow the document builder to create child documents (folders)

Default :

false

3.2.152. documentbuilder.createDocument.enabled

Type :

boolean

Description :

Allow the document builder to create new documents (not only compose)

Default :

true

3.2.153. documentbuilder.deleteSelectedThumbs.enabled

Type :

boolean

Description :

Activate the feature to delete on right click a list of selected thumbs

Default :

true

3.2.154. documentbuilder.createDocumentFromSelectedThumbs.enabled

Type :

boolean

Description :

Activate the feature to create a new document from selected thumbs

Default :

true

3.2.155. documentbuilder.button.legacySave.enabled

Type :

boolean

Description :

Activate the legacy save document builder button

Default :

false

3.2.156. documentbuilder.button.download.enabled

Type :

boolean

Description :

Activate the button : download the builder document locally

Default :

true

3.2.157. documentbuilder.button.custom.enabled

Type :

boolean

Description :

Activate the button : run custom action on builder document

Default :

false

3.2.158. documentbuilder.button.download.annotations.enabled

Type :

boolean

Description :

Activate the button : download the builder document with annotation

Default :

false

3.2.159. documentbuilder.button.updateAll.enabled

Type :

boolean

Description :

Activate the button : update all documents

Default :

false

3.2.160. documentbuilder.button.createFirst.enabled

Type :

boolean

Description :

Activate the button : Create new first document

Default :

false

3.2.161. documentbuilder.button.updateFirst.enabled

Type :

boolean

Description :

Activate the button : Update the document

Default :

false

3.2.162. documentbuilder.populatorPolicy

Type :

String

Description :

Sets up the policy to populate the document builder : CopyCurrentDocument or EmptyDocument

Default :

CopyCurrentDocument

3.2.163. documentbuilder.populatorPolicy.CopyCurrentDocument.flattenNodeHierarchy

Type :

boolean

Description :

Sets up the policy CopyCurrentDocument from the builder, does it need to flatten the documents indentation or not

Default :

true

3.2.164. documentbuilder.button.hideUntilLoaded

Type :

boolean

Description :

Hides the document builder button until all documents have been loaded

Default :

true

3.2.165. documentbuilder.afterDownload

Type :

String

Description :

Thumb navigator view behavior after processing a download in documentbuilder : hide, disable, nochange

Default :

hide

3.2.166. document.vertical.slider.changeToPage.enabled

Type :

boolean

Description :

Enabling the scroll by step instead of jumping to page on the scrollUp and scrollDown button

Default :

false

3.2.167. error.warninDelay

Type :

integer

Description :

Delay (in s) before showing the warning menu that the document might take time to process

Default :

10

3.2.168. error.hasDownloadButton

Type :

boolean

Description :

Allow the error menu to display a download link for the document

Default :

true

3.2.169. error.hideErrorStack

Type :

boolean

Description :

Disable the error menu to display error stack traces (useful for debug/integration testing, not suitable for production)

Default :

true

3.2.170. document.progressiveLoading

Type :

boolean

Description :

Activates the progressive loading of ARender front end side (the layout is asked by parts from the front end)

Default :

false

3.2.171. document.loading.progress.update

Type :

boolean

Description :

Update and notify the end user to the progressive loading mechanisms

Default :

true

3.2.172. visualization.mode

Type :

String

Description :

Visualization mode : Single, BookMode

Default :

Single

3.2.173. visualization.reload.lower.quality

Type :

boolean

Description :

Reload lower quality images once the higher quality has been fetched (always load the perfect size, or save bandwidth)

Default :

false

3.2.174. visualization.video.autoplay

Type :

boolean

Description :

Autoplay videos

Default :

true

3.2.175. visualization.pagechange.mouse

Type :

boolean

Description :

Mousewheel can change a document page

Default :

false

3.2.176. visualization.pagechange.animation

Type :

boolean

Description :

Do animation on page changes (with navigation buttons)

Default :

false

3.2.177. visualization.pagecorner.enabled

Type :

boolean

Description :

Display a corner on the pages border, allowing to change pages

Default :

false

3.2.178. visualization.pagecorner.animation

Type :

boolean

Description :

Animates the page corner

Default :

false

3.2.179. visualization.fullscreen

Type :

boolean

Description :

Activates the full screen visualisation in ARender

Default :

false

3.2.180. visualization.zoom.type

Type :

String

Description :

Sets up the default zoom type : Default, FullWidth, FullHeight, In, Out, Custom, FullPage

Default :

FullWidth

3.2.181. visualization.zoom.value

Type :

integer

Description :

Default Zoom value, in percent in case of custom zoom

Default :

100

3.2.182. visualization.zoom.animation

Type :

boolean

Description :

Animate on zoom

Default :

false

3.2.183. visualization.rotation.save.enabled

Type :

boolean

Description :

Allows rotations to be saved as annotation

Default :

false

3.2.184. visualization.guideruler.enabled

Type :

boolean

Description :

Activate the ruler guide for ARender

Default :

false

3.2.185. visualization.guideruler.height

Type :

integer

Description :

Defines the height in pixel of the ruler guide

Default :

10

3.2.186. visualization.guideruler.increment

Type :

integer

Description :

Defines the movement in height in pixel for the ruler guide

Default :

10

3.2.187. visualization.multiView.enabled

Type :

boolean

Description :

Allows documents to be viewed in multi documents

Default :

true

3.2.188. visualization.multiView.direction

Type :

String

Description :

Defines the direction in which the multi view will open documents : horizontal or vertical

Default :

vertical

3.2.189. visualization.multiView.doComparison

Type :

boolean

Description :

Allows to compare documents on start of ARender, when two documents or more are opened

Default :

false

3.2.190. visualization.multiView.showOnStart

Type :

boolean

Description :

Show the multivew mode on start

Default :

false

3.2.191. visualization.multiView.synchronized

Type :

boolean

Description :

Synchronize the scrolling of the views when in multiview

Default :

true

3.2.192. visualization.multiView.focusOnClick

Type :

boolean

Description :

Force the user to click on the documents instead of mouse hovering to change on which document can be annotated

Default :

false

3.2.193. visualization.multiView.header.timeoutMs

Type :

integer

Description :

Timeout in milliseconds to auto hide the timer

Default :

5000

3.2.194. visualization.images.sharpen

Type :

boolean

Description :

Place a css on document images to undo some of the “optimisations” browser do to display images

Default :

false

3.2.195. visualization.images.tolerance

Type :

integer

Description :

Adapts the images width tolerance in pixel (received versus drawn on screen).

Default :

10

3.2.196. visualization.images.svg.preview

Type :

boolean

Description :

Enables or disables the SVG previews images

Default :

true

3.2.197. visualization.pages.prefetch

Type :

integer

Description :

Amount of pages to preload before they become visible

Default :

2

3.2.198. window.maximize

Type :

boolean

Description :

Maximizes the ARender window

Default :

false

3.2.199. upload.file.openInNewWindow

Type :

boolean

Description :

Uploaded files should open in a new window of ARender

Default :

false

3.2.200. visualization.maximumConcurrentImageFetching

Type :

integer

Description :

Maximum number of document images to fetch simultaneously

Default :

8

3.2.201. visualization.nonVisiblePageTimeout

Type :

integer

Description :

Cleanup images which where non-visible for a long time (ms)

Default :

120000

3.2.202. visualization.imageCleanupPeriod

Type :

integer

Description :

Period at which images are cleaned (ms)

Default :

1500

3.2.203. visualization.maxImageCacheSize

Type :

integer

Description :

Maximum number of images to store in the cleanup cache before LRU eviction occurs

Default :

20

3.2.211. annotation.autosave

Type :

boolean

Description :

Allows annotations to be automatically save after edition

Default :

false

3.2.212. annotation.autorefresh

Type :

boolean

Description :

Auto refreshes the annotations after save

Default :

true

3.2.213. annotation.autosave.timerDelay

Type :

integer

Description :

Auto save annotation timer delay in milliseconds

Default :

1000

3.2.214. annotation.loadingGIF

Type :

boolean

Description :

When saving annotations, display the loading animation

Default :

true

3.2.215. annotation.loadExisting

Type :

boolean

Description :

Load the existing document annotations on display

Default :

true

3.2.216. annotation.displaySaveWarning

Type :

boolean

Description :

Display a warning to the end user when annotations are left unsaved

Default :

true

3.2.217. annotation.forceReadOnly

Type :

boolean

Description :

All saved annotations will be set to read only

Default :

false

3.2.218. annotation.forceLocked

Type :

boolean

Description :

All saved annotations will be set to locked

Default :

false

3.2.219. annotation.comment.pictogram.enabled

Type :

boolean

Description :

Display a pictogram near the commented annotation

Default :

true

3.2.220. rotation.ignoreForceReadOnly

Type :

boolean

Description :

Rotation annotations shall ignore force read only

Default :

false

3.2.221. rotation.ignoreForceLocked

Type :

boolean

Description :

Rotation annotations shall ignore force locked

Default :

false

3.2.222. annotation.stickyNote.opacity

Type :

float

Description :

Opacity of the sticky note annotation

Default :

1.0

3.2.223. annotation.stickyNote.minimum.width

Type :

integer

Description :

Minimum width in pixel of the sticky note annotation

Default :

140

3.2.224. annotation.stickyNote.minimum.height

Type :

integer

Description :

Minimum height in pixel of the sticky note annotation

Default :

70

3.2.225. annotation.stickyNote.default.color

Type :

Color, in format #RRGGBB

Description :

Color of the sticky note annotation

Default :

#F3F001

3.2.226. annotation.stickyNote.hide.border

Type :

boolean

Description :

Hide borders options of the sticky note annotation

Default :

true

3.2.227. annotation.stickyNote.hide.details

Type :

boolean

Description :

Hide details of the sticky note annotation

Default :

false

3.2.228. annotation.stickyNote.default.font

Type :

String

Description :

Font of the sticky note annotation

Default :

Helvetica

3.2.229. annotation.stickyNote.default.fontColor

Type :

Color, in format #RRGGBB

Description :

Font color of the sticky note annotation

Default :

#000000

3.2.230. annotation.stickyNote.default.fontSize

Type :

integer

Description :

Font size of the sticky note annotation

Default :

2

3.2.231. annotation.stickyNote.default.bold

Type :

boolean

Description :

Set the font bold by default for the sticky note annotation

Default :

false

3.2.232. annotation.stickyNote.default.underline

Type :

boolean

Description :

Set the font underlined by default for the sticky note annotation

Default :

false

3.2.233. annotation.stickyNote.default.italic

Type :

boolean

Description :

Set the font italic by default for the sticky note annotation

Default :

false

3.2.235. annotation.stickyNote.pin.default.size

Type :

integer

Description :

Default pin size in pixel for the sticky note

Default :

20

3.2.236. annotation.popup.autohide.delay.ms

Type :

integer

Description :

Auto hide delay in milliseconds for the annotation popups

Default :

300

3.2.237. annotation.popup.default.background.color

Type :

Color, in format #RRGGBB

Description :

Popup fallback background color when the annotation background color is empty

Default :

#F6F6F6

3.2.238. annotation.rectangle.opacity

Type :

float

Description :

Opacity for the rectangle annotation

Default :

0.7

3.2.239. annotation.rectangle.minimum.width

Type :

integer

Description :

Minimum width in pixel for the rectangle annotation

Default :

30

3.2.240. annotation.rectangle.minimum.height

Type :

integer

Description :

Minimum height in pixel for the rectangle annotation

Default :

10

3.2.241. annotation.rectangle.default.color

Type :

Color, in format #RRGGBB

Description :

Color for the rectangle annotation

Default :

#EAF39C

3.2.242. annotation.rectangle.default.border.color

Type :

Color, in format #RRGGBB

Description :

Border color for the rectangle annotation

Default :

#EAF39C

3.2.243. annotation.rectangle.default.border.width

Type :

integer

Description :

Border width in pixel for the rectangle annotation

Default :

0

3.2.244. annotation.circle.opacity

Type :

float

Description :

Opacity for the circle annotation

Default :

0.7

3.2.245. annotation.circle.minimum.width

Type :

integer

Description :

Minimum width in pixel for the circle annotation

Default :

30

3.2.246. annotation.circle.minimum.height

Type :

integer

Description :

Minimum height for the circle annotation

Default :

10

3.2.247. annotation.circle.default.color

Type :

Color, in format #RRGGBB

Description :

Color for the circle annotation

Default :

#EAF39C

3.2.248. annotation.circle.default.border.color

Type :

Color, in format #RRGGBB

Description :

Border color for the circle annotation

Default :

#EAF39C

3.2.249. annotation.circle.default.border.width

Type :

integer

Description :

Border width in pixel for the circle annotation

Default :

0

3.2.250. annotation.highlighttext.opacity

Type :

float

Description :

Opacity for the highlight annotation

Default :

0.7

3.2.251. annotation.highlighttext.default.color

Type :

Color, in format #RRGGBB

Description :

Color for the highlight annotation

Default :

#EAF39C

3.2.252. annotation.redaction.default.color

Type :

Color, in format #RRGGBB

Description :

Color for the redaction annotation

Default :

#EAF39C

3.2.253. annotation.highlighttext.strike.width.ratio

Type :

float

Description :

Strike width ratio for underline - strike through annotations

Default :

0.1

3.2.254. annotation.freetext.opacity

Type :

float

Description :

Opacity for the Freetext annotation

Default :

0.7

3.2.255. annotation.freetext.minimum.width

Type :

integer

Description :

Minimum width in pixel for the Freetext annotation

Default :

30

3.2.256. annotation.freetext.minimum.height

Type :

integer

Description :

Minimum height in pixel for the Freetext annotation

Default :

10

3.2.257. annotation.freetext.default.color

Type :

Color, in format #RRGGBB

Description :

Color for the Freetext annotation

Default :

#EEEEEE

3.2.258. annotation.freetext.default.border.color

Type :

Color, in format #RRGGBB

Description :

Border color for the Freetext annotation

Default :

#FF0000

3.2.259. annotation.freetext.default.border.width

Type :

integer

Description :

Border width in pixel for the Freetext annotation

Default :

2

3.2.260. annotation.arrow.backgroundColor

Type :

Color, in format rgb(r,g,b)

Description :

Arrow annotation color

Default :

rgb(42, 72, 105)

3.2.261. annotation.arrow.computeDistance

Type :

boolean

Description :

Allow arrows to measure distances

Default :

false

3.2.262. annotation.arrow.minimal.head.size

Type :

integer

Description :

Defines a minimal head size in pixel for arrows

Default :

-1

3.2.263. annotation.arrow.x.defaultDistance

Type :

integer

Description :

Defines a base distance for the head of arrow in X in pixel

Default :

12

3.2.264. annotation.arrow.y.defaultDistance

Type :

integer

Description :

Defines a base distance for the head of arrow in Y in pixel

Default :

12

3.2.265. annotation.polygon.opacity

Type :

float

Description :

Opacity for the polygon annotation

Default :

0.7

3.2.266. annotation.polygon.backgroundColor

Type :

Color, in format rgb(r,g,b)

Description :

Color for the polygon annotation

Default :

rgb(42, 72, 105)

3.2.267. annotation.polygon.width

Type :

float

Description :

Border width for the polygon annotation

Default :

2.0f

3.2.268. annotation.polyline.opacity

Type :

integer

Description :

Opacity for the polyline annotation

Default :

1

3.2.269. annotation.polyline.backgroundColor

Type :

Color, in format rgb(r,g,b)

Description :

Color for the polyline annotation

Default :

rgb(42, 72, 105)

3.2.270. annotation.polyline.width

Type :

float

Description :

Border width for the polyline annotation

Default :

2.0f

3.2.271. annotation.ink.opacity

Type :

integer

Description :

Opacity for the freehand annotation

Default :

1

3.2.272. annotation.ink.backgroundColor

Type :

Color, in format rgb(r,g,b)

Description :

Color for the freehand annotation

Default :

rgb(42, 72, 105)

3.2.273. annotation.ink.width

Type :

float

Description :

Border width for the freehand annotation

Default :

2.0f

3.2.276. annotation.stamp.create.in.browser.orientation

Type :

boolean

Description :

Allow stamps to be create in the current browser orientation (including document rotations)

Default :

false

3.2.277. annotation.freetext.drag.widgets.on.edit

Type :

boolean

Description :

Auto activate the draggable widgets for the Freetext when in edition mode.

Default :

true

3.2.278. annotation.rotation.windmillEffect.enabled

Type :

boolean

Description :

Stamp rotation effect in video mode (easter egg)

Default :

false

3.2.279. annotation.loadPerPage

Type :

boolean

Description :

Annotations are loaded per page

Default :

false

3.2.280. annotation.searchTextInAnnotations

Type :

boolean

Description :

When searching for text, also search within annotation content

Default :

true

3.2.281. annotation.default.stroke.dasharray

Type :

String

Description :

Default dash array style when the border style is set to DASH

Default :

5.0,2.0

3.2.282. annotation.info.popup.enabled

Type :

boolean

Description :

Activate the info popup for annotations

Default :

true

3.2.283. annotation.info.popup.evenIfEditable

Type :

boolean

Description :

Activate the popup info for annotations who aren’t editable

Default :

false

3.2.284. annotation.info.popup.displayUpdate

Type :

boolean

Description :

Display the last updated time for the annotation

Default :

false

3.2.285. annotation.comment.explorer.enabled

Type :

boolean

Description :

Activates the comment explorer for displaying annotation details

Default :

true

3.2.286. annotation.comment.explorer.eastSide.enabled

Type :

boolean

Description :

Sets up the comment explorer on the east side of ARender

Default :

false

3.2.287. annotation.comment.explorer.openOnEdit

Type :

boolean

Description :

Opens the comment explorer when an annotation is edited

Default :

false

3.2.288. annotation.comment.explorer.showAllAnnotators

Type :

boolean

Description :

Shows a simplified list of all authors on the comment explorer tab

Default :

true

3.2.289. annotation.comment.explorer.showTotalAnnotationsNumber

Type :

boolean

Description :

Shows a total number of annotations on the comment explorer tab

Default :

false

3.2.290. annotation.comment.explorer.showAtStartup

Type :

boolean

Description :

Shows the comment explorer at startup of ARender as default pane

Default :

false

3.2.291. comment.showAnnotationImage

Type :

boolean

Description :

Shows in the comment explorer an icon of the annotation

Default :

true

3.2.292. comment.showAnnotationDescription

Type :

boolean

Description :

Shows in the comment explorer an small labeled description of the annotation

Default :

true

3.2.293. comment.textArea.maxHeight

Type :

integer

Description :

Comment text area max height corresponds to the maximum height when expanding the text with the button “Show more”, in pixels

Default :

0

3.2.294. comment.contextStatusMenu.enabled

Type :

boolean

Description :

Enable contextual status menu will allow to right click on an comment annotation to add a status

Default :

false

3.2.295. comment.multiple.thread.level.enabled

Type :

boolean

Description :

Enable multiple comment thread level display

Default :

false

3.2.296. comment.richtext.shortcut.enabled

Type :

boolean

Description :

Enable richtext shortcut : [Enter] validates the annotation comment and [Shift]+[Enter] makes a new line

Default :

false

3.2.297. filter.comment.showTabImage

Type :

boolean

Description :

Allows to filter the annotation in the comment explorer

Default :

true

3.2.298. filter.comment.showTabLabel

Type :

boolean

Description :

Shows a label instead of icons for filtering

Default :

false

3.2.299. filter.comment.showSwitchFilter

Type :

boolean

Description :

Shows the switch filter for solved/unresolved requests

Default :

true

3.2.300. timeline.panel.annotationBar.showResizeCircleButton

Type :

boolean

Description :

Display the resize button for the annotation timeline panel for videos

Default :

true

3.2.301. timeline.panel.annotationBar.changeVideoCurrentTimeOnDrag.enabled

Type :

boolean

Description :

On drag of the annotations, update the video timer accordingly

Default :

true

3.2.302. timeline.panel.openIfAnnotated

Type :

boolean

Description :

Opens the timeline panel if annotations are existing on the video

Default :

true

3.2.303. timeline.panel.openOnEdit

Type :

boolean

Description :

Opens the timeline panel if an annotation is being edited on video

Default :

true

3.2.304. contextualMenu.enabled

Type :

boolean

Description :

Activates ARender contextual right click menu

Default :

true

3.2.305. contextualMenu.icons.enabled

Type :

boolean

Description :

Activates ARender contextual icons mode

Default :

false

3.2.306. contextualMenu.hasPrint

Type :

boolean

Description :

Enables the print option for the contextual menu

Default :

false

3.2.307. contextualMenu.hasPrintAll

Type :

boolean

Description :

Enables the print all documents option for the contextual menu

Default :

false

3.2.308. contextualMenu.hasStickyNote

Type :

boolean

Description :

Enables the create a sticky note option for the contextual menu

Default :

true

3.2.309. contextualMenu.hasCropBoxImage

Type :

boolean

Description :

Enables the create a cropbox image from the contextual menu

Default :

false

3.2.310. image.cropbox.target.dpi

Type :

integer

Description :

Configures the target DPI for the pictures generated from the cropbox (base dpi is 72, default target is 150)

Default :

150

3.2.311. image.cropbox.window.position.left.px

Type :

integer

Description :

Setup the position in pixel of the Left of the popup window

Default :

0

3.2.312. image.cropbox.window.position.top.px

Type :

integer

Description :

Setup the position in pixel of the Top of the popup window

Default :

0

3.2.313. image.cropbox.window.position.width.px

Type :

integer

Description :

If superior to -1, will set the width of the popup window. If -1, will set to a “screen ratio” of the screen available space

Default :

-1

3.2.314. image.cropbox.window.position.height.px

Type :

integer

Description :

If superior to -1, will set the height of the popup window. If -1, will set to a “screen ratio” of the screen available space

Default :

-1

3.2.315. image.cropbox.window.screen.ratio

Type :

integer

Description :

Sets the screen ratio to use of available space for the width and height when they are set to -1

Default :

3

3.2.316. image.cropbox.can.expand

Type :

boolean

Description :

If true, resizing the window will allow the expand of images (over their natural sizes)

Default :

true

3.2.317. contextualMenu.hasHighlightText

Type :

boolean

Description :

Enables the create a textual highlight option for the contextual menu

Default :

true

3.2.318. contextualMenu.hasStrikeoutText

Type :

boolean

Description :

Enables the create a strike through annotation option for the contextual menu

Default :

true

3.2.319. contextualMenu.hasUnderlineText

Type :

boolean

Description :

Enables the create an underline option for the contextual menu

Default :

true

3.2.320. contextualMenu.hasHighlight

Type :

boolean

Description :

Enables the create an highlight option for the contextual menu

Default :

true

3.2.321. contextualMenu.hasCircle

Type :

boolean

Description :

Enables the create a circle option for the contextual menu

Default :

true

3.2.322. contextualMenu.hasArrow

Type :

boolean

Description :

Enables the create an arrow option for the contextual menu

Default :

true

3.2.323. contextualMenu.hasPolygon

Type :

boolean

Description :

Enables the create a polygon option for the contextual menu

Default :

false

3.2.324. contextualMenu.hasPolyline

Type :

boolean

Description :

Enables the create a polyline option for the contextual menu

Default :

false

3.2.325. contextualMenu.hasFreehand

Type :

boolean

Description :

Enables the create a freehand option for the contextual menu

Default :

false

3.2.326. contextualMenu.hasPageRotation

Type :

boolean

Description :

Enables the rotate option for the contextual menu

Default :

false

3.2.327. contextualMenu.hasMultiView

Type :

boolean

Description :

Enables the open multiview option for the contextual menu

Default :

false

3.2.328. contextualMenu.hasShowGuideRuler

Type :

boolean

Description :

Enables the “show guide here” option for the contextual menu

Default :

false

3.2.329. contextualMenu.hasHideGuideRuler

Type :

boolean

Description :

Enables the “hide guide ruler” option for the contextual menu

Default :

false

3.2.331. contextualMenu.hasAnchor

Type :

boolean

Description :

Enables the create anchor option for the contextual menu

Default :

true

3.2.332. notifications.duration

Type :

integer

Description :

Sets up the time, in milliseconds of ARender legacy notifications

Default :

500

3.2.333. annotationExplorer.showStickyNoteReplies

Type :

boolean

Description :

Legacy annotation explorer, show the sticky notes replies

Default :

false

3.2.334. annotationExplorer.showStickyNoteLabel

Type :

boolean

Description :

Legacy annotation explorer, show the sticky notes labels

Default :

true

3.2.335. annotationExplorer.adaptativeWidth.enabled

Type :

boolean

Description :

Legacy annotation explorer, adapts the width of the panel accordingly

Default :

true

3.2.341. shortCut.copy.enabled

Type :

boolean

Description :

Enables copy shortcut with CRTL+C

Default :

true

3.2.342. shortCut.cut.enabled

Type :

boolean

Description :

Enables copy shortcut with CRTL+X

Default :

true

3.2.343. shortCut.print.key

Type :

String

Description :

Configures a print key shortcut

Default :

p

3.2.344. shortCut.print.enabled

Type :

boolean

Description :

Enables a print key shortcut

Default :

true

3.2.345. shortCut.saveAndQuit

Type :

boolean

Description :

Enables a save and quit shortcut

Default :

false

3.2.346. arender.pollLastVersion

Type :

boolean

Description :

Enables ARender version check

Default :

true

3.2.347. plume.enabled

Type :

boolean

Description :

Enables Plume integration with ARender

Default :

false