Skip to main content
Version: v2023.18.0

Properties

about

propertyDescriptiontypedefault
about.dialog.enabledNo description yet providedbooleantrue
about.dialog.statistics.enableDisable/enable showing statistics in the about dialog boxbooleantrue
about.dialog.statistics.table.enableDisable/enable showing table statistics in the about dialog box (removes as well the graph values)booleantrue
about.dialog.statistics.charts.enableDisable/enable the charts in the statistics section pulls the library from google API (gwt charts)booleanfalse
about.dialog.show.current.versionDisplays the current version in the about dialog boxbooleantrue
about.dialog.show.current.userDisplays the current user in the about dialog boxbooleantrue

advanced

propertyDescriptiontypedefault
advanced.searchexplorer.enabledIf true, enables the advanced search explorerbooleantrue
advanced.searchexplorer.min.characterLengthSets up the minimum character length allowedinteger0
advanced.searchexplorer.max.characterLengthSets up the maximum character length allowedinteger255
advanced.searchexplorer.updates.enabledIf true, search is updated on annotation refresh when the the advanced search explorer is activebooleanfalse
advanced.searchexplorer.search.highlight.enabledIf true, the button for search and highlight is enabledbooleantrue

annotation

propertyDescriptiontypedefault
annotation.canHideObfuscateIf true, all redaction annotations can be hidden using the regular hide annotations buttonbooleanfalse
annotation.autosaveAllows annotations to be automatically save after editionbooleanfalse
annotation.autorefreshAuto refreshes the annotations after savebooleantrue
annotation.autosave.timerDelayAuto save annotation timer delay in millisecondsinteger1000
annotation.autosave.repeatMode.enabledIf auto save is enabled, saving may be triggered when using annotation creation repeatablebooleanfalse
annotation.loadingGIFWhen saving annotations, display the loading animationbooleantrue
annotation.loadExistingLoad the existing document annotations on displaybooleantrue
annotation.displaySaveWarningDisplay a warning to the end user when annotations are left unsavedbooleantrue
annotation.forceReadOnlyAll saved annotations will be set to read onlybooleanfalse
annotation.forceLockedAll saved annotations will be set to lockedbooleanfalse
annotation.comment.pictogram.enabledDisplay a pictogram near the commented annotationbooleantrue
annotation.stickyNote.opacityOpacity of the sticky note annotationfloat1.0
annotation.stickyNote.minimum.widthMinimum width in pixel of the sticky note annotationinteger250
annotation.stickyNote.minimum.heightMinimum height in pixel of the sticky note annotationinteger170
annotation.stickyNote.size.according.to.zoomMinimum sizes (width and height) according to zoombooleantrue
annotation.stickyNote.content.edition.height.ratioThe ratio of the content edition height according to the sticky note heightfloat0.7
annotation.stickyNote.default.colorColor of the sticky note annotationColor, in format #RRGGBB#FFDD00
annotation.stickyNote.hide.borderHide borders options of the sticky note annotationbooleantrue
annotation.stickyNote.hide.detailsHide details of the sticky note annotationbooleanfalse
annotation.stickyNote.default.fontFont of the sticky note annotationStringHelvetica
annotation.stickyNote.default.fontColorFont color of the sticky note annotationColor, in format #RRGGBB#000000
annotation.stickyNote.default.fontSizeFont size of the sticky note annotationinteger2
annotation.stickyNote.default.boldSet the font bold by default for the sticky note annotationbooleanfalse
annotation.stickyNote.default.underlineSet the font underlined by default for the sticky note annotationbooleanfalse
annotation.stickyNote.default.italicSet the font italic by default for the sticky note annotationbooleanfalse
annotation.stickyNote.dotLink.enabledEnables a link between the pin and the note for sticky notebooleantrue
annotation.stickyNote.pin.default.sizeDefault pin size in pixel for the sticky noteinteger20
annotation.stickyNote.can.hide.reply.buttonIf true, reply button will hide when stickyNote text is emptybooleanfalse
annotation.stickyNote.statusList.enabledActivates the status list drop downbooleantrue
annotation.stickyNote.action.buttonsAllow the display of the label or not. ALWAYS = the label always appears. HOVER = the label appears when the buttons are hovered. NEVER = the label is never displayedStringHOVER
annotation.stickyNote.show.dateAllow the display of the date or not. By default, the date is displayedbooleantrue
annotation.stickyNote.creator.name.initial.onlyDisplay only the initials of the creator name if true. Full name is displayed if falseStringtrue;
annotation.popup.autohide.delay.msAuto hide delay in milliseconds for the annotation popupsinteger300
annotation.popup.default.background.colorPopup fallback background color when the annotation background color is emptyColor, in format #RRGGBB#F6F6F6
annotation.rectangle.opacityOpacity for the rectangle annotationfloat0.7
annotation.rectangle.minimum.widthMinimum width in pixel for the rectangle annotationinteger30
annotation.rectangle.minimum.heightMinimum height in pixel for the rectangle annotationinteger10
annotation.rectangle.default.colorColor for the rectangle annotationColor, in format #RRGGBB#EAF39C
annotation.rectangle.default.border.colorBorder color for the rectangle annotationColor, in format #RRGGBB#EAF39C
annotation.rectangle.default.border.widthBorder width in pixel for the rectangle annotationinteger0
annotation.circle.opacityOpacity for the circle annotationfloat0.7
annotation.circle.minimum.widthMinimum width in pixel for the circle annotationinteger30
annotation.circle.minimum.heightMinimum height for the circle annotationinteger10
annotation.circle.default.colorColor for the circle annotationColor, in format #RRGGBB#EAF39C
annotation.circle.default.border.colorBorder color for the circle annotationColor, in format #RRGGBB#EAF39C
annotation.circle.default.border.widthBorder width in pixel for the circle annotationinteger0
annotation.highlighttext.opacityOpacity for the highlight annotationfloat0.7
annotation.highlighttext.default.colorColor for the highlight annotationColor, in format #RRGGBB#EAF39C
annotation.redaction.default.colorColor for the redaction annotationColor, in format #RRGGBB#273746
annotation.highlighttext.strike.width.ratioStrike width ratio for underline - strike through annotationsfloat0.1
annotation.freetext.opacityOpacity for the Freetext annotationfloat0.7
annotation.freetext.minimum.widthMinimum width in pixel for the Freetext annotationinteger30
annotation.freetext.minimum.heightMinimum height in pixel for the Freetext annotationinteger10
annotation.freetext.default.colorColor for the Freetext annotationColor, in format #RRGGBB#EEEEEE
annotation.freetext.default.border.colorBorder color for the Freetext annotationColor, in format #RRGGBB#FF0000
annotation.freetext.default.border.widthBorder width in pixel for the Freetext annotationinteger2
annotation.freetext.default.font.sizeFont size in pixelinteger16
annotation.freetext.default.font.colorFont colorColor, in format #RRGGBB#000000
annotation.freetext.default.fontFont family nameStringHelvetica
annotation.freetext.adapt.font.size.enabledAdapt font size according to the zoom ratiobooleanfalse
annotation.freetext.rotation.enabledIf true, freetext will rotate when rotating a pagebooleanfalse
annotation.arrow.backgroundColorArrow annotation colorColor, in format rgb(r,g,b)rgb(42, 72, 105)
annotation.arrow.computeDistanceAllow arrows to measure distancesbooleanfalse
annotation.arrow.minimal.head.sizeDefines a minimal head size in pixel for arrowsinteger-1
annotation.arrow.x.defaultDistanceDefines a base distance for the head of arrow in X in pixelinteger12
annotation.arrow.y.defaultDistanceDefines a base distance for the head of arrow in Y in pixelinteger12
annotation.arrow.opacityDefines arrow opacityfloat1.0
annotation.arrow.border.widthDefines arrow border widthfloat4.0
annotation.arrow.head.typeDefines arrow head type. Possible values are : NONE, SQUARE, CIRCLE, DIAMOND, OPEN_ARROW, CLOSED_ARROW, BUTT, R_OPEN_ARROW, R_CLOSED_ARROWStringOPEN_ARROW
annotation.arrow.tail.typeDefines arrow tail type. Possible values are : NONE, SQUARE, CIRCLE, DIAMOND, OPEN_ARROW, CLOSED_ARROW, BUTT, R_OPEN_ARROW, R_CLOSED_ARROWStringNONE
annotation.arrow.distance.degree.accuracyDefines a degree of accuracy for the arrow displayed measure. The value is a power of ten (Examples : 1, 0.1, 0.01, 0.001, etc..)float0.01
annotation.polygon.opacityOpacity for the polygon annotationfloat0.7
annotation.polygon.backgroundColorColor for the polygon annotationColor, in format rgb(r,g,b)rgb(42, 72, 105)
annotation.polygon.widthBorder width for the polygon annotationfloat2.0f
annotation.polygon.borderColorBorder color for the polygon annotationColor, in format rgb(r,g,b)rgb(42, 72, 105)
annotation.polyline.opacityOpacity for the polyline annotationinteger1
annotation.polyline.backgroundColorColor for the polyline annotationColor, in format rgb(r,g,b)rgb(42, 72, 105)
annotation.polyline.widthBorder width for the polyline annotationfloat2.0f
annotation.ink.opacityOpacity for the freehand annotationinteger1
annotation.ink.backgroundColorColor for the freehand annotationColor, in format rgb(r,g,b)rgb(42, 72, 105)
annotation.ink.widthBorder width for the freehand annotationfloat2.0f
annotation.hyperlink.opacityOpacity for the Hyperlink annotationfloat0.5f
annotation.hyperlink.default.colorColor for the Hyperlink annotationColor, in format #RRGGBB#EAF39C
annotation.hyperlink.externe.target.enabledAllow the hyperlink target to be an external documentbooleantrue
annotation.stamp.create.in.browser.orientationAllow stamps to be create in the current browser orientation (including document rotations)booleanfalse
annotation.stamp.create.relative.to.zoomIf true, create stamps relatively to the zoom. Otherwise stamps will always have the same size regardless of the current zoombooleantrue
annotation.stampCustom.enabledAllow custom stamp to be createdbooleantrue
annotation.stampCustom.maxFavoriteMaximum of custom stamp allowed to be added in favoriteinteger15
annotation.stampCustom.min.text.lengthSet minimum text length allowed for the custom stampinteger2
annotation.freetext.drag.widgets.on.editAuto activate the draggable widgets for the Freetext when in edition mode.booleantrue
annotation.rotation.windmillEffect.enabledStamp rotation effect in video mode (easter egg)booleanfalse
annotation.loadPerPageAnnotations are loaded per pagebooleanfalse
annotation.searchTextInAnnotationsWhen searching for text, also search within annotation contentbooleantrue
annotation.default.stroke.dasharrayDefault dash array style when the border style is set to DASHString5.0,2.0
annotation.info.popup.enabledActivate the info popup for annotationsbooleantrue
annotation.info.popup.evenIfEditableActivate the popup info for annotations who aren't editablebooleanfalse
annotation.info.popup.displayUpdateDisplay the last updated time for the annotationbooleanfalse
annotation.comment.explorer.enabledActivates the comment explorer for displaying annotation detailsbooleantrue
annotation.comment.explorer.eastSide.enabledSets up the comment explorer on the east side of ARenderbooleanfalse
annotation.comment.explorer.openOnEditOpens the comment explorer when an annotation is editedbooleanfalse
annotation.comment.explorer.animate.on.expandAnimate while expanding the comment explorerbooleantrue
annotation.comment.explorer.showAllAnnotatorsShows a simplified list of all authors on the comment explorer tabbooleantrue
annotation.comment.explorer.showTotalAnnotationsNumberShows a total number of annotations on the comment explorer tabbooleanfalse
annotation.comment.explorer.showAtStartupShows the comment explorer at startup of ARender as default panebooleanfalse
annotation.comment.explorer.inline.enabledEnable to display annotation in one line if neededbooleanfalse
annotation.comment.explorer.show.annotation.minimized.on.openBy default, annotation in comment explorer will be displayed in one line.booleanfalse
annotation.comment.explorer.filterPageAnnotationsIf true, enable to also filter annotations in the page viewbooleanfalse
annotation.comment.explorer.sortByIncrementDateIf true, set the sorting in increment otherwise in decrement datebooleantrue
annotation.comment.explorer.show.dateAllow the display of the date or not. By default, the date is displayedbooleantrue
annotation.comment.explorer.creator.name.initial.onlyDisplay only the initials of the creator name if true. Full name is displayed if falsebooleanfalse
annotation.date.display.humanizedDate.enabledDisplay humanized date on comments and sticky notesbooleanfalse
annotation.date.display.creationDateIf true, display creation date otherwise the last modified date on comments and sticky notesbooleantrue
annotation.richtext.edition.doubleClickIf true, double click on the field text is required to enter in editionbooleanfalse
annotation.blendModeEnables blend mode for annotations that support itbooleanfalse

arender

propertyDescriptiontypedefault
arender.web.socket.enabledEnables web socket and try to initiate the web socket if the browser web socket is availablebooleantrue
arender.pollLastVersionEnables ARender version checkbooleantrue
arender.white.labelingRemove any reference of ARender in the applicationbooleanfalse
arender.data.analytics.enabledEnables data analyticsbooleantrue

arenderjs

propertyDescriptiontypedefault
arenderjs.startupScriptARenderJS Configuration : customization startup script URLStringempty by default

bookmarkexplorer

propertyDescriptiontypedefault
bookmarkexplorer.enabledIf true, enables the bookmark explorerbooleantrue
bookmarkexplorer.showAtStartupIf true, show the bookmark explorer at the application startupbooleanfalse
bookmarkexplorer.draggableIf true, make the bookmarks draggablebooleanfalse
bookmarkexplorer.add.bookmark.enabledIf true, enables the bookmark creationbooleantrue
bookmarkexplorer.delete.bookmark.enabledIf true, enables the bookmark deletionbooleantrue
bookmarkexplorer.animation.enabledIf true, enables the bookmark animationbooleanfalse

bottomPanel

propertyDescriptiontypedefault
bottomPanel.toggle.document.navigator.enabledEnable the button to toggle the documentNavigatorbooleanfalse

comment

propertyDescriptiontypedefault
comment.showAnnotationImageShows in the comment explorer an icon of the annotationbooleantrue
comment.textArea.maxHeightComment text area max height corresponds to the maximum height when expanding the text with the button "Show more", in pixelsinteger0
comment.contextStatusMenu.enabledEnable contextual status menu will allow to right click on an comment annotation to add a statusbooleanfalse
comment.multiple.thread.level.enabledEnable multiple comment thread level displaybooleanfalse
comment.richtext.shortcut.enabledEnable richtext shortcut : [Enter] or [Esc] validate the annotation comment and [Shift]+[Enter] makes a new linebooleanfalse

contextualMenu

propertyDescriptiontypedefault
contextualMenu.enabledActivates ARender contextual right click menubooleantrue
contextualMenu.icons.enabledActivates ARender contextual icons modebooleantrue
contextualMenu.hasPrintEnables the print option for the contextual menubooleanfalse
contextualMenu.hasPrintAllEnables the print all documents option for the contextual menubooleanfalse
contextualMenu.hasStickyNoteEnables the create a sticky note option for the contextual menubooleantrue
contextualMenu.hasCropBoxImageEnables the create a cropbox image from the contextual menubooleanfalse
contextualMenu.hasHighlightTextEnables a textual highlight annotation creation option for the contextual menubooleantrue
contextualMenu.hasStrikeoutTextEnables a strike through annotation creation option for the contextual menubooleantrue
contextualMenu.hasUnderlineTextEnables an underline annotation creation option for the contextual menubooleantrue
contextualMenu.hasHighlightEnables an highlight annotation creation option for the contextual menubooleantrue
contextualMenu.hasCircleEnables a circle annotation creation option for the contextual menubooleantrue
contextualMenu.hasArrowEnables an arrow annotation creation option for the contextual menubooleantrue
contextualMenu.hasPolygonEnables a polygon annotation creation option for the contextual menubooleanfalse
contextualMenu.hasPolylineEnables a polyline annotation creation option for the contextual menubooleanfalse
contextualMenu.hasFreehandEnables a freehand annotation creation option for the contextual menubooleanfalse
contextualMenu.hasPageRotationEnables the rotate option for the contextual menubooleanfalse
contextualMenu.hasMultiViewEnables the open multiview option for the contextual menubooleanfalse
contextualMenu.hasShowGuideRulerEnables the "show guide here" option for the contextual menubooleanfalse
contextualMenu.hasHideGuideRulerEnables the "hide guide ruler" option for the contextual menubooleanfalse
contextualMenu.hasHyperlinkEnables a hyperlink creation option for the contextual menubooleantrue
contextualMenu.hasAnchorEnables an anchor creation option for the contextual menubooleantrue
contextualMenu.hasStampEnables a stamp annotation creation option for the contextual menubooleanfalse
contextualMenu.hasFreetextEnables a freetext annotation creation option for the contextual menubooleanfalse

date

propertyDescriptiontypedefault
date.formatSpecify the date format for the annotationsStringdd/MM/yyyy, HH:mm

document

propertyDescriptiontypedefault
document.vertical.slider.changeToPage.enabledEnabling the scroll by step instead of jumping to page on the scrollUp and scrollDown buttonbooleanfalse
document.vertical.slider.new.click.scrollbar.behaviorNo description yet providedbooleantrue
document.vertical.slider.use.legacy.scrollbarTrue to use the browser native scrollbarbooleanfalse
document.vertical.slider.use.legacy.scrollbar.limit.pagesSet the number of document pages to use the legacy scrollbar otherwise use the ARender native one. For example, set to 1 : document with 1 page (or less) will use the native browser scrollbarinteger2
document.progressiveLoadingActivates the progressive loading of ARender front end side (the layout is asked by parts from the front end)booleanfalse
document.loading.progress.updateUpdate and notify the end user to the progressive loading mechanismsbooleantrue

documentbuilder

propertyDescriptiontypedefault
documentbuilder.enabledEnables the document builder button (and feature)booleanfalse
documentbuilder.button.visibleSets the document builder button visiblebooleantrue
documentbuilder.activateOnStartupActivate the document builder at startup as soon as the documents are readybooleanfalse
documentbuilder.hideDocumentNavigatorHide the document navigator once the document builder is openedbooleantrue
documentbuilder.displaySaveWarningDisplay a save warning if a document with modifications is left when leaving ARenderbooleantrue
documentbuilder.thumbs.draggableMake the document builder thumbnails draggable in order to organize the pagesbooleantrue
documentbuilder.widthSets the document builder panel widthinteger280
documentbuilder.save.actionSets the document builder default save button actionStringsave
documentbuilder.save.behaviorSets the document builder save behavior (legacy) : UPDATE_NO_DOCUMENT, CREATE_NEW_FIRST_DOCUMENT, UPDATE_FIRST_DOCUMENT, UPDATE_ALL_DOCUMENTStringUPDATE_NO_DOCUMENT
documentbuilder.save.downloadActivates the local download builder buttonbooleantrue
documentbuilder.save.deleteActivates the delete current document from the builder buttonbooleanfalse
documentbuilder.save.freezeOnce documents are built, a frozen title will remain and need to be manually removed to confirm the operationbooleantrue
documentbuilder.addChild.enabledAllow the document builder to create child documents (folders)booleanfalse
documentbuilder.createDocument.enabledAllow the document builder to create new documents (not only compose)booleantrue
documentbuilder.deleteSelectedThumbs.enabledActivate the feature to delete on right click a list of selected thumbsbooleantrue
documentbuilder.createDocumentFromSelectedThumbs.enabledActivate the feature to create a new document from selected thumbsbooleantrue
documentbuilder.close.enabledActivate the contextual menu option to close the builderbooleantrue
documentbuilder.button.legacySave.enabledActivate the legacy save document builder buttonbooleanfalse
documentbuilder.button.download.enabledActivate the button : download the builder document locallybooleantrue
documentbuilder.button.custom.enabledActivate the button : run custom action on builder documentbooleanfalse
documentbuilder.button.download.annotations.enabledActivate the button : download the builder document with annotationbooleanfalse
documentbuilder.button.updateAll.enabledActivate the button : update all documentsbooleanfalse
documentbuilder.button.createFirst.enabledActivate the button : Create new first documentbooleanfalse
documentbuilder.button.updateFirst.enabledActivate the button : Update the documentbooleanfalse
documentbuilder.button.saveAll.active.when.emptyIf active, the saveAll button will be always visible if enabled, even if documents are emptybooleanfalse
documentbuilder.button.updateAll.active.when.emptyIf active, the updateAll button will be always visible if enabled, even if documents are emptybooleanfalse
documentbuilder.populatorPolicySets up the policy to populate the document builder : CopyCurrentDocument or EmptyDocumentStringCopyCurrentDocument
documentbuilder.populatorPolicy.CopyCurrentDocument.flattenNodeHierarchySets up the policy CopyCurrentDocument from the builder, does it need to flatten the documents indentation or notbooleantrue
documentbuilder.button.hideUntilLoadedHides the document builder button until all documents have been loadedbooleantrue
documentbuilder.afterDownloadThumb navigator view behavior after processing a download in documentbuilder : hide, disable, nochangeStringhide
documentbuilder.button.refresh.enabledActivate the button : Refresh the document to its original statebooleantrue
documentbuilder.contextual.menu.download.enabledActivate local download action in the contextual menubooleanfalse
documentbuilder.contextual.menu.download.annotations.enabledActivate download document with annotations action in the contextual menubooleanfalse
documentbuilder.contextual.menu.createFirst.enabledActivate the create first document action in the contextual menubooleanfalse
documentbuilder.contextual.menu.updateFirst.enabledActivate the update document action in the contextual menubooleanfalse
documentbuilder.contextual.menu.delete.enabledActivate the delete document action in the contextual menubooleanfalse

documentnavigator

propertyDescriptiontypedefault
documentnavigator.widthSets up the width (in pixel) of the document navigator (left tabs of ARender)integer320
documentnavigator.search.widthSets up the width (in pixel) of the advanced search in the document navigator (left tabs of ARender)integer400
documentnavigator.annotation.widthSets up the width (in pixel) of the annotation in the document navigator (left tabs of ARender)integer400
documentnavigator.ears.hideTimerDelaySets up the time (in ms) to auto hide the arrow for maximizing or reducing the document navigatorinteger100
documentnavigator.initialWidthSets up the default position of the document navigator tabs: Default, Reduced or ExpandedStringDefault
documentnavigator.expand.reduce.ratioDefault value set up to 70. The document navigator will take 70 percent of the screen.integer70

error

propertyDescriptiontypedefault
error.warninDelayDelay (in s) before showing the warning menu that the document might take time to processinteger10
error.hasDownloadButtonAllow the error menu to display a download link for the documentbooleantrue
error.hideErrorStackDisable the error menu to display error stack traces (useful for debug/integration testing, not suitable for production)booleantrue

filter

propertyDescriptiontypedefault
filter.comment.showSwitchFilterShows the switch filter for solved/unresolved requestsbooleanfalse
filter.comment.currentUser.enabledActivates the button to filter annotations created by the current userbooleanfalse

html

propertyDescriptiontypedefault
html.plugin.enabledEnables the html plugin, which allows to view html content directly in ARender, instead of the rendition of the html contentbooleanfalse

hyperlinkexplorer

propertyDescriptiontypedefault
hyperlinkexplorer.enabledIf true, enables the hyperlink explorerbooleantrue
propertyDescriptiontypedefault
hyperlinks.loadInARenderOpen hyperlinks into ARender instead of new windowbooleanfalse
hyperlinks.loadFromPDFLoad hyperlinks coming from the PDF filebooleantrue
hyperlinks.displayFrameDisplay frame/blue box around hyperlinks if neededbooleantrue
hyperlinks.load.internalHyperlinks contained from the PDF document will be loadedbooleantrue
hyperlinks.load.externalHyperlinks contained from the annotations will be loadedbooleantrue

image

propertyDescriptiontypedefault
image.cropbox.target.dpiConfigures the target DPI for the pictures generated from the cropbox (base dpi is 72, default target is 150)integer150
image.cropbox.window.position.left.pxSetup the position in pixel of the Left of the popup windowinteger0
image.cropbox.window.position.top.pxSetup the position in pixel of the Top of the popup windowinteger0
image.cropbox.window.position.width.pxIf superior to -1, will set the width of the popup window. If -1, will set to a "screen ratio" of the screen available spaceinteger-1
image.cropbox.window.position.height.pxIf superior to -1, will set the height of the popup window. If -1, will set to a "screen ratio" of the screen available spaceinteger-1
image.cropbox.window.screen.ratioSets the screen ratio to use of available space for the width and height when they are set to -1integer3
image.cropbox.can.expandIf true, resizing the window will allow the expand of images (over their natural sizes)booleantrue
image.cropbox.include.annotationsIf true, annotations will be on the cropboxbooleantrue

mousewheel

propertyDescriptiontypedefault
mousewheel.speed.factorMousewheel velocity ratio factor, the higher the fasterfloat1.0

notifications

propertyDescriptiontypedefault
notifications.durationSets up the time, in milliseconds of ARender legacy notificationsinteger500

plume

propertyDescriptiontypedefault
plume.enabledEnables Plume integration with ARenderbooleanfalse
plume.urlPlume urlString/plume

preference

propertyDescriptiontypedefault
preference.color.modeChange the toppanel colors. Will NOT work on Internet Explorer. Authorized value : DARK, LIGHT, CUSTOMStringDARK

print

propertyDescriptiontypedefault
print.renditionWidthWidth in pixels for the images used by the print as images featureinteger1200
print.imageStyleSets up the CSS print width size once renderedStringwidth:800px;
print.includeAnnotationsByDefaultAlways check by default the "print with annotations" optionbooleanfalse
print.forcePrintAnnotationsForce the print of annotations (cannot be unchecked)booleanfalse
print.waterMarkActiveActivate the watermarking feature from the print menubooleanfalse
print.usePDFPrintPrint using a PDF instead of a set of images, lowers total download sizebooleantrue
print.allDocumentsByDefaultPrint by default all documentsbooleanfalse
print.includeRotationsAdd print option with page rotationbooleanfalse

redactexplorer

propertyDescriptiontypedefault
redactexplorer.enabledIf true, enables the redact explorerbooleanfalse
redactexplorer.redactActivate the redaction annotation buttonbooleantrue
redactexplorer.redactZoneActivate the redaction annotation zone buttonbooleantrue

rotation

propertyDescriptiontypedefault
rotation.ignoreForceReadOnlyRotation annotations shall ignore force read onlybooleanfalse
rotation.ignoreForceLockedRotation annotations shall ignore force lockedbooleanfalse

shortCut

note

To disable any shortcut, leave its .key property empty.

propertyDescriptiontypedefault
shortCut.copy.enabledEnable Copy (Ctrl-c & Ctrl-x)booleantrue
shortcut.print.keyPrintStringp
shortcut.print.ctrlbooleantrue
shortcut.print.shiftbooleanfalse
shortcut.print.altbooleanfalse
shortcut.zoomin.keyZoom InStringk
shortcut.zoomin.ctrlbooleantrue
shortcut.zoomin.shiftbooleanfalse
shortcut.zoomin.altbooleanfalse
shortcut.zoomout.keyZoom OutStringi
shortcut.zoomout.ctrlbooleantrue
shortcut.zoomout.shiftbooleanfalse
shortcut.zoomout.altbooleanfalse
shortcut.fullscreen.keyFullscreenStringq
shortcut.fullscreen.ctrlbooleantrue
shortcut.fullscreen.shiftbooleanfalse
shortcut.fullscreen.altbooleanfalse
shortcut.search.keySearchStringf
shortcut.search.ctrlbooleantrue
shortcut.search.shiftbooleanfalse
shortcut.search.altbooleanfalse
shortcut.save.keySaveStrings
shortcut.save.ctrlbooleantrue
shortcut.save.shiftbooleanfalse
shortcut.save.altbooleanfalse
shortcut.duplicate.keyDuplicate AnnotationStringd
shortcut.duplicate.ctrlbooleantrue
shortcut.duplicate.shiftbooleanfalse
shortcut.duplicate.altbooleanfalse
shortcut.about.keyAbout DialogString,
shortcut.about.ctrlbooleantrue
shortcut.about.shiftbooleanfalse
shortcut.about.altbooleanfalse
shortcut.delthumb.keyDelete ThumbnailStringDelete
shortcut.delthumb.ctrlbooleanfalse
shortcut.delthumb.shiftbooleantrue
shortcut.delthumb.altbooleanfalse
shortcut.nextPage.keyNext PageStringArrowRight
shortcut.nextPage.ctrlbooleanfalse
shortcut.nextPage.shiftbooleanfalse
shortcut.nextPage.altbooleanfalse
shortcut.previousPage.keyPrevious PageStringArrowLeft
shortcut.previousPage.ctrlbooleanfalse
shortcut.previousPage.shiftbooleanfalse
shortcut.previousPage.altbooleanfalse
shortcut.movePageDown.keyMove Page DownStringArrowDown
shortcut.movePageDown.ctrlbooleanfalse
shortcut.movePageDown.shiftbooleanfalse
shortcut.movePageDown.altbooleanfalse
shortcut.movePageUp.keyMove Page UpStringArrowUp
shortcut.movePageUp.ctrlbooleanfalse
shortcut.movePageUp.shiftbooleanfalse
shortcut.movePageUp.altbooleanfalse
shortcut.pageDown.keyScroll Page DownStringPageDown
shortcut.pageDown.ctrlbooleanfalse
shortcut.pageDown.shiftbooleanfalse
shortcut.pageDown.altbooleanfalse
shortcut.pageUp.keyScroll Page UpStringPageUp
shortcut.pageUp.ctrlbooleanfalse
shortcut.pageUp.shiftbooleanfalse
shortcut.pageUp.altbooleanfalse

shortcut

propertyDescriptiontypedefault
shortcut.annotation.stickynote.keyConfigures a key shortcut for stickynote creationinteger1
shortcut.annotation.stickynote.enabledEnables the shortcut for stickynote creation with CTRL + keybooleantrue
shortcut.annotation.freetext.keyConfigures a key shortcut for freetext creationinteger2
shortcut.annotation.freetext.enabledEnables the shortcut for freetext creation with CTRL + keybooleantrue
shortcut.annotation.rectangle.keyConfigures a key shortcut for highlight rectangle creationinteger3
shortcut.annotation.rectangle.enabledEnables the shortcut for highlight rectangle creation with CTRL + keybooleantrue
shortcut.annotation.circle.keyConfigures a key shortcut for circle creationinteger4
shortcut.annotation.circle.enabledEnables the shortcut for circle creation with CTRL + keybooleantrue
shortcut.annotation.polygon.keyConfigures a key shortcut for polygon creationinteger5
shortcut.annotation.polygon.enabledEnables the shortcut for polygon creation with CTRL + keybooleantrue
shortcut.annotation.polyline.keyConfigures a key shortcut for polyline creationinteger6
shortcut.annotation.polyline.enabledEnables the shortcut for polyline creation with CTRL + keybooleantrue
shortcut.annotation.freehand.keyConfigures a key shortcut for freehand creationinteger7
shortcut.annotation.freehand.enabledEnables the shortcut for freehand creation with CTRL + keybooleantrue
shortcut.annotation.arrow.keyConfigures a key shortcut for arrow creationinteger8
shortcut.annotation.arrow.enabledEnables the shortcut for arrow creation with CTRL + keybooleantrue
shortcut.annotation.measure.keyConfigures a key shortcut for arrow distance creationinteger9
shortcut.annotation.measure.enabledEnables the shortcut for arrow distance creation with CTRL + keybooleantrue
shortcut.annotation.stamp.keyConfigures a key shortcut for stamp creationinteger0
shortcut.annotation.stamp.enabledEnables the shortcut for stamp creation with CTRL + keybooleantrue
toolbar.link.hasOpacityEnables opacity support for link annotationsbooleantrue
toolbar.link.hasColorEnables color support for link annotationsbooleantrue
toolbar.link.hasStyleEnables style support for link annotationsbooleantrue

startup

propertyDescriptiontypedefault
startup.loading.labelDisplay the label when document starts to openStringARender

style

propertyDescriptiontypedefault
style.sheetChange the default ARender CSSStringcss/arender-style.css

text

propertyDescriptiontypedefault
text.selection.use.legacyNew text selection will select word by word when a word is partially/completely selectedbooleantrue
text.selection.hyperlink.use.enterUse enter to confirm the selected text during hyperlinks creationbooleantrue

thumbexplorer

propertyDescriptiontypedefault
thumbexplorer.enabledActivates the thumbExplorer : the view to browse the document by thumbnailsbooleantrue
thumbexplorer.indentationSets up the indentation of Thumbs, in pixels when they need to indent (child documents)integer20
thumbexplorer.maxLevelToLoadSets up the maximum level of indentationinteger10
thumbexplorer.thumb.marginSets up the thumbs margin in pixelsinteger5
thumbexplorer.thumb.widthSets up the thumbs width in pixelsinteger100
thumbexplorer.thumb.grow.minSets up the minimum amount of pixels needed for the pictree to grow in sizeinteger300
thumbexplorer.thumb.grow.incrementSets up the growth increment once the thumbnail can growinteger10
thumbexplorer.thumb.grow.ratioSets up the growth ratio corresponding to the growth of the panelinteger1
thumbexplorer.title.allowHTMLIf true, allows thumbnails titles to have HTML contentbooleanfalse
thumbexplorer.metadataIf true, thumbnails will display a popup information with document metadatabooleantrue
thumbexplorer.layout.loading.delaySets up the delay in milliseconds to load the layout for the thumbnailsinteger5
thumbexplorer.contextualMenu.createPageAnchorAllows to create an URL anchor to a page from the thumbnailsbooleantrue

timeline

propertyDescriptiontypedefault
timeline.panel.annotationBar.showResizeCircleButtonDisplay the resize button for the annotation timeline panel for videosbooleantrue
timeline.panel.annotationBar.changeVideoCurrentTimeOnDrag.enabledOn drag of the annotations, update the video timer accordinglybooleantrue
timeline.panel.openIfAnnotatedOpens the timeline panel if annotations are existing on the videobooleantrue
timeline.panel.openOnEditOpens the timeline panel if an annotation is being edited on videobooleantrue

toaster

propertyDescriptiontypedefault
toaster.log.severe.autoHideAllows SEVERE toaster notifications to autohidebooleanfalse
toaster.log.warning.autoHideAllows WARNING toaster notifications to autohidebooleantrue
toaster.log.info.autoHideAllows INFO toaster notifications to autohidebooleantrue
toaster.log.config.autoHideAllows CONFIG toaster notifications to autohidebooleantrue
toaster.log.fine.autoHideAllows FINE toaster notifications to autohidebooleantrue
toaster.log.finer.autoHideAllows FINER toaster notifications to autohidebooleantrue
toaster.log.finest.autoHideAllows FINEST toaster notifications to autohidebooleantrue
toaster.log.severe.enabledAllows SEVERE toaster notifications to be displayedbooleantrue
toaster.log.warning.enabledAllows WARNING toaster notifications to be displayedbooleantrue
toaster.log.info.enabledAllows INFO toaster notifications to be displayedbooleantrue
toaster.log.config.enabledAllows CONFIG toaster notifications to be displayedbooleanfalse
toaster.log.fine.enabledAllows FINE toaster notifications to be displayedbooleanfalse
toaster.log.finer.enabledAllows FINER toaster notifications to be displayedbooleanfalse
toaster.log.finest.enabledAllows FINEST toaster notifications to be displayedbooleanfalse
toaster.toast.timeoutSets up the timeout for toaster notifications to be hiddeninteger2000
toaster.toast.newestOnTopIf true, displays the newest toaster logs on top, if false, on the bottombooleantrue

toolbar

propertyDescriptiontypedefault
toolbar.activateBordersAllows from the toolbar to alter the borders of annotationsbooleantrue
toolbar.distance.physical.unitsBase physical units. List of handled units : pt, px, in, mm, cm, dm, m, km, ml, yd, ft (NB: both physical and display units need to be the same)Stringin,cm,px
toolbar.distance.display.unitsDisplay distance units. List of handled units : pt, px, in, mm, cm, dm, m, km, ml, yd, ft (NB: both physical and display units need to be the same)Stringin,cm,px
toolbar.distance.physical.value.enabledAllow physical distance ratio value to be changedbooleanfalse
toolbar.distance.physical.display.units.syncAllow physical and display distance units to be synchronized, changing physical unit will change the display unitbooleantrue
toolbar.distance.display.units.alter.display.ratio.factor.enabledAllow display units change to alter the display ratio value with its corresponding conversion factorbooleantrue
toolbar.lockedObfuscateIf true, all redaction annotations will become locked once saved, and can no longer be editedbooleanfalse
toolbar.opacity.slider.enabledEnables opacity slider for annotations that support itbooleantrue
toolbar.richtext.hasSubscriptEnables subscript support in rich textbooleanfalse
toolbar.richtext.hasSuperscriptEnables superscript support in rich textbooleanfalse
toolbar.richtext.hasStrikeThroughEnables strike through support in rich textbooleanfalse
toolbar.richtext.hasRemoveFormatEnables the format removal of the selected in rich textbooleanfalse
toolbar.richtext.hasFontsEnables fonts name support in rich textbooleantrue
toolbar.richtext.hasFontSizeEnables font size support in rich textbooleantrue
toolbar.richtext.hasFontColorEnables font color support in rich textbooleantrue
toolbar.richtext.hasUnderlineEnables underline support in rich textbooleantrue
toolbar.richtext.hasBoldEnables bold support in rich textbooleantrue
toolbar.richtext.hasItalicEnables italic support in rich textbooleantrue
toolbar.securityList.checkOwnerIf true, the security list is only shown when the annotation belongs to the current userbooleantrue

topPanel

propertyDescriptiontypedefault
topPanel.logoShow the top panel logobooleantrue
topPanel.logo.urlDefine the top panel logo URLStringarender-icones-svg/arender-logo-white.svg
topPanel.logo.widthThe top panel logo width (in pixel)integer26
topPanel.logo.heightThe top panel logo height (in pixel)integer26
topPanel.logo.margin.leftThe top panel logo margin left (in pixel)integer10
topPanel.widgets.beanNamesThe list of widgets to define (XML bean names) for the top panelStringfileAndAnnotationSection,modificationSection,navigationButtons,zoomButtons,multiViewTools,annotationToolbar,pluginSection
topPanel.upload.buttons.beanNamesThe list of widgets to define (XML bean names) for the upload/print file dropdownStringuploadButton,uploadURLButton,uploadXFDFButton,printSeparatorHorizontal,printButton,printAllButton
topPanel.download.buttons.beanNamesThe list of widgets to define (XML bean names) for the download file dropdownStringdownloadButton,downloadRootButton,downloadAllSourcesButton,downloadPdfButton,\
topPanel.section.file.buttons.beanNamesThe list of widgets to define (XML bean names) for the file sectionStringimportMenu, downloadMenu,saveDirtyAnnotations
topPanel.section.file.annotation.buttons.beanNamesThe list of widgets to define (XML bean names) for the file/annotation sectionStringfileSection,annotationMenu
topPanel.section.modification.buttons.beanNamesThe list of widgets to define (XML bean names) for the modification sectionStringbrightnessContainer,contrastContainer,invertContainer,rotationSeparatorVertical,rotateAllLeft,rotateLeft,rotateRight,rotateAllRight,rotateReset
topPanel.ellipsis.buttons.beanNamesThe list of widgets to define (XML bean names) for the static content of ellipsis (More button/hamburger button)StringlabelAbout, aboutButton
topPanel.section.plugin.buttons.beanNamesThe list of widgets to define (XML bean names) for the pluginsStringplumeMenu,htmlPluginMenu
topPanel.search.buttons.beanNamesThe list of widgets to define (XML bean names) for the searchboxStringsearchBox
topPanel.navigation.buttons.beanNamesThe list of widgets to define (XML bean names) for the navigation sectionStringfirstPageButton,previousPageButton,pageNavigation,nextPageButton,lastPageButton
topPanel.zoom.buttons.beanNamesThe list of widgets to define (XML bean names) for the zoom sectionStringzoomBox,zoomInZone,zoomInZoneGlass,cropBoxButton,zoomFullWidth,zoomFullHeight,zoomFullPage
topPanel.rotation.buttons.beanNamesThe list of widgets to define (XML bean names) for the rotation sectionStringrotateAllLeft,rotateLeft,rotateRight,rotateAllRight,rotateReset
topPanel.annotation.buttons.beanNamesThe list of widgets to define (XML bean names) for the annotation sub-menuStringaddStickyNoteAnnotationButton,addFreeTextAnnotationButton,addHighlightRectangleAnnotationButton,addHighlightCircleAnnotationButton,addPolygonAnnotationButton,addPolylineAnnotationButton,addFreehandAnnotationButton,addHighlightTextAnnotationButton,addUnderlineTextAnnotationButton,addStrikethroughTextAnnotationButton,addArrowAnnotationButton,addArrowDistanceAnnotationButton,addStampAnnotationButton,annotationSeparatorVertical,addHyperlinkButton,showAllAnnotationsButton,showAllAnnotationsAndRotationsButton,refreshAnnotation
topPanel.imageProcessing.buttons.vertical.beanNamesThe list of widgets to define (XML bean names) for the image processing file sub-menu in verticalStringcontrastSlider,brightnessSlider,invertSlider
topPanel.section.right.buttons.beanNamesThe list of widgets to define (XML bean names) for right section of the toppanelStringselectAllTextDocument,documentBuilderButton,fullscreenButton,searchSection,moreButton
topPanel.imageProcessing.buttons.beanNamesDEPRECATED, button integrated in the property topPanel.section.modification.buttons.beanNames .The list of widgets to define (XML bean names) for the brightness and contrast buttonStringbrightnessContainer,contrastContainer,invertContainer
topPanel.documentMenuActivate the document sub-menubooleantrue
topPanel.cropbox.enabledActivate the button for cropbox in the toppanelbooleanfalse
topPanel.lineHeadTailMenuChange to false to remove line head options menu.booleantrue
topPanel.documentMenu.uploadActivate the upload file buttonbooleantrue
topPanel.documentMenu.urlActivate the open url buttonbooleantrue
topPanel.documentMenu.url.open.using.enterAllow to use enter to validate the input URL from the URL buttonbooleantrue
topPanel.documentMenu.xfdfUploadActivate the top panel XFDF upload buttonbooleanfalse
topPanel.documentMenu.downloadActivate the top panel download document buttonbooleantrue
topPanel.documentMenu.download.rootActivate the top panel download composite document buttonbooleantrue
topPanel.documentMenu.download.behaviorThe default behavior for download. Valid values : DOWNLOAD_SOURCE or DOWNLOAD_NON_PDFStringDOWNLOAD_NON_PDF
topPanel.documentMenu.downloadPDFActivate the top panel button : download document as PDFbooleantrue
topPanel.documentMenu.downloadAllSourcesActivate the top panel button : download all current documents as original format in a ZIPbooleantrue
topPanel.documentMenu.downloadAllActivate the top panel button : download all current documents as a single PDFbooleantrue
topPanel.documentMenu.downloadAnnotationActivate the top panel button : download the current document with annotations as PDFbooleantrue
topPanel.documentMenu.downloadCSVAnnotationsActivate the top panel button : download the current document annotations as CSVbooleanfalse
topPanel.documentMenu.downloadWithFDFAnnotationActivate the top panel button : download the current document with annotations as FDFbooleanfalse
topPanel.documentMenu.downloadXFDFAnnotationsActivate the top panel button : download the current document annotations as XFDFbooleanfalse
topPanel.documentMenu.downloadFDFAnnotationsActivate the top panel button : download the current document annotations as FDFbooleanfalse
topPanel.documentMenu.download.with.compareActivate the top panel button : download the compared documents side by side with compare result on itbooleantrue
topPanel.imageProcessMenu.brightness.enabledActivate the brightness sliderbooleantrue
topPanel.imageProcessMenu.contrast.enabledActivate the contrast sliderbooleantrue
topPanel.imageProcessMenu.invert.enabledActivate the invert colors sliderbooleanfalse
topPanel.imageProcessMenu.process.modeSet how image processing is applied : CURRENT_PAGE, ALL_PAGES, ALL_DOCUMENTSStringALL_DOCUMENTS
topPanel.imageProcessMenu.processBrightnessREMOVED since version 4.5.0 Sets up slider to handle brightnessStringBRIGHTNESS
topPanel.imageProcessMenu.processContrastREMOVED since version 4.5.0 Sets up slider to handle contrastStringCONTRAST
topPanel.imageProcessMenu.maxBrightnessREMOVED since version 4.7.0 Sets up the max value of the brightness sliderinteger200
topPanel.imageProcessMenu.maxContrastREMOVED since version 4.7.0 Sets up the max value of the contrast sliderinteger200
topPanel.imageProcessMenu.defaultBrightnessREMOVED since version 4.7.0 Sets up the default value of the brightness sliderinteger100
topPanel.imageProcessMenu.defaultContrastREMOVED since version 4.7.0 Sets up the default value of the contrast sliderinteger100
topPanel.imageProcessMenuREMOVED since version 4.7.0, use topPanel.imageProcessMenu.brightness.enabled and topPanel.imageProcessMenu.contrast.enabled instead. Activate the top panel imageProcessing buttonbooleantrue
topPanel.subMenu.button.timeOutREMOVED since version 4.7.0 Sets up the time in Milliseconds before the sub-menu buttons disappearinteger100
topPanel.subMenu.subPanel.timeOutREMOVED since version 4.7.0 Sets up the time in Milliseconds before the sub-menu panel disappearsinteger500
topPanel.printActivate the print button in the topPanelbooleantrue
topPanel.annotationMenuActivate the annotation sub-menubooleantrue
topPanel.annotationMenu.stickyNoteActivate the sticky note annotation buttonbooleantrue
topPanel.annotationMenu.freetextActivate the freetext annotation buttonbooleantrue
topPanel.annotationMenu.stickyNote.editableAllow the sticky note to be editedbooleantrue
topPanel.annotationMenu.highlightActivate the highlight annotation buttonbooleantrue
topPanel.annotationMenu.highlight.repeatActivate the highlight annotation button, in repeat mode (does not cancel unless pressed again)booleanfalse
topPanel.annotationMenu.arrowActivate the arrow annotation buttonbooleantrue
topPanel.annotationMenu.arrow.repeatActivate the arrow annotation button, in repeat mode (does not cancel unless pressed again)booleanfalse
topPanel.annotationMenu.arrow.measureActivate the arrow measure annotation buttonbooleantrue
topPanel.annotationMenu.arrow.measure.repeatActivate the arrow measure annotation button, in repeat mode (does not cancel unless pressed again)booleanfalse
topPanel.annotationMenu.polygonActivate the polygon annotation buttonbooleantrue
topPanel.annotationMenu.polygon.repeatActivate the polygon annotation button, in repeat mode (does not cancel unless pressed again)booleanfalse
topPanel.annotationMenu.polylineActivate the polyline annotation buttonbooleantrue
topPanel.annotationMenu.polyline.repeatActivate the polyline annotation button, in repeat mode (does not cancel unless pressed again)booleanfalse
topPanel.annotationMenu.freehandActivate the freehand annotation buttonbooleantrue
topPanel.annotationMenu.freehand.repeatActivate the freehand annotation button, in repeat mode (does not cancel unless pressed again)booleanfalse
topPanel.annotationMenu.highlightTextActivate the text highlight annotation buttonbooleanfalse
topPanel.annotationMenu.highlightText.repeatActivate the text highlight annotation button, in repeat mode (does not cancel unless pressed again)booleanfalse
topPanel.annotationMenu.underlineTextActivate the text underline annotation buttonbooleanfalse
topPanel.annotationMenu.underlineText.repeatActivate the text underline annotation button, in repeat mode (does not cancel unless pressed again)booleanfalse
topPanel.annotationMenu.strikethroughTextActivate the strikethrough text annotation buttonbooleanfalse
topPanel.annotationMenu.strikethroughText.repeatActivate the strikethrough text annotation button, in repeat mode (does not cancel unless pressed again)booleanfalse
topPanel.annotationMenu.circleActivate the circle annotation buttonbooleantrue
topPanel.annotationMenu.circle.repeatActivate the circle annotation button, in repeat mode (does not cancel unless pressed again)booleanfalse
topPanel.annotationMenu.hyperlinkActivate the hyperlink annotation buttonbooleanfalse
topPanel.annotationMenu.hyperlink.repeatActivate the hyperlink annotation button, in repeat mode (does not cancel unless pressed again)booleantrue
topPanel.annotationMenu.stampActivate the stamp annotation buttonbooleantrue
topPanel.annotationMenu.hideActivate the hide annotations buttonbooleantrue
topPanel.annotationMenu.hideAllActivate the hide all annotations button (includes redaction)booleanfalse
topPanel.annotationMenu.soundActivate the sound annotation buttonbooleanfalse
topPanel.refreshActivate the refresh annotations buttonbooleantrue
topPanel.zoomBoxActivate the boxed zoom buttonbooleantrue
topPanel.copy.document.textActivate the copy all text of the document buttonbooleanfalse
topPanel.pageNavigation.firstActivates the go to first page navigation buttonbooleantrue
topPanel.pageNavigation.previousActivates the go to previous page navigation buttonbooleantrue
topPanel.pageNavigation.nextActivates the go to next page navigation buttonbooleantrue
topPanel.pageNavigation.lastActivates the go to last page navigation buttonbooleantrue
topPanel.zoom.fullWidthActivates the zoom (full width of document) buttonbooleantrue
topPanel.zoom.fullHeightActivates the zoom (full height of document) buttonbooleantrue
topPanel.zoom.fullPageActivates the zoom (full page of document) buttonbooleantrue
topPanel.zoom.inActivates the zoom in buttonbooleantrue
topPanel.zoom.outActivates the zoom out buttonbooleantrue
topPanel.zoom.zoneActivates the zoom by zone buttonbooleantrue
topPanel.zoom.zoneGlassActivates the zoom (magnifying glass) buttonbooleanfalse
topPanel.zoom.zoneGlass.valueSets the default zoom ratio for the magnifying glassinteger2
topPanel.rotation.leftActivates the rotate left buttonbooleantrue
topPanel.rotation.rightActivates the rotate right buttonbooleantrue
topPanel.rotation.allActivates the rotate all pages buttonsbooleanfalse
topPanel.rotation.resetActivates the rotate left buttonbooleanfalse
topPanel.rotation.degreeSets up the amount of rotation applied when pressing the rotation buttonsinteger90
topPanel.rotation.addActivates rotations sub-menubooleantrue
topPanel.searchActivates the search in the top panelbooleantrue
topPanel.search.defaultIf true, default search behavior. Otherwise, open in the advanced search panelbooleanfalse
topPanel.search.displayResultsInExplorerIf true and topPanel.search.default is true, display search text results in the AdvancedSearchExplorer.booleanfalse
topPanel.search.searchByVisiblePageIf true, the "next result" search button will jump to the next result on the current visible page instead of resuming where you left the searchbooleantrue
topPanel.fullscreenActivates the full screen button in the top panelbooleantrue
topPanel.fullscreen.hideTopPanelIf true, full screen will hide the top panel totallybooleanfalse
topPanel.fullscreen.alwaysShowTopPanelIf true, the toppanel will always be visible in fullscreen and won't hidebooleanfalse

upload

propertyDescriptiontypedefault
upload.file.openInNewWindowUploaded files should open in a new window of ARenderbooleanfalse

visualization

propertyDescriptiontypedefault
visualization.modeVisualization mode : Single, BookModeStringSingle
visualization.reload.lower.qualityReload lower quality images once the higher quality has been fetched (always load the perfect size, or save bandwidth)booleanfalse
visualization.reload.minimum.width.changeDifference between the old image width and the new image width. Reload the image if difference is greater than this value.float0.1
visualization.reload.minimum.width.change.mobileDifference between the old image width and the new image width. Reload the image if difference is greater than this value.float200.0
visualization.video.autoplayAutoplay videosbooleantrue
visualization.pagechange.mouseMousewheel can change a document pagebooleanfalse
visualization.pagechange.animationDo animation on page changes (with navigation buttons)booleanfalse
visualization.pagecorner.enabledDisplay a corner on the pages border, allowing to change pagesbooleanfalse
visualization.pagecorner.animationAnimates the page cornerbooleanfalse
visualization.fullscreenActivates the full screen visualisation in ARenderbooleanfalse
visualization.zoom.typeSets up the default zoom type : Default, FullWidth, FullHeight, In, Out, Custom, FullPageStringFullWidth
visualization.zoom.valueDefault Zoom value, in percent in case of custom zoominteger100
visualization.zoom.animationAnimate on zoombooleanfalse
visualization.zoom.by.biggest.pageZoom according to the biggest page (width or height). Otherwise to the first pagebooleantrue
visualization.zoom.stepCustom zoom step valuefloat0.1
visualization.rotation.save.enabledAllows rotations to be saved as annotationbooleanfalse
visualization.guideruler.enabledActivate the ruler guide for ARenderbooleanfalse
visualization.guideruler.heightDefines the height in pixel of the ruler guideinteger10
visualization.guideruler.incrementDefines the movement in height in pixel for the ruler guideinteger10
visualization.multiView.enabledAllows documents to be viewed in multi documentsbooleantrue
visualization.multiView.directionDefines the direction in which the multi view will open documents : horizontal or verticalStringvertical
visualization.multiView.doComparisonAllows to compare documents on start of ARender, when two documents or more are openedbooleanfalse
visualization.multiView.showOnStartShow the multivew mode on startbooleanfalse
visualization.multiView.synchronizedSynchronize the scrolling of the views when in multiviewbooleantrue
visualization.multiView.focusOnClickForce the user to click on the documents instead of mouse hovering to change on which document can be annotatedbooleanfalse
visualization.multiView.header.timeoutMsTimeout in milliseconds to auto hide the timerinteger5000
visualization.images.sharpenPlace a css on document images to undo some of the "optimisations" browser do to display imagesbooleanfalse
visualization.images.toleranceAdapts the images width tolerance in pixel (received versus drawn on screen).integer10
visualization.images.svg.previewEnables or disables the SVG previews imagesbooleantrue
visualization.pages.prefetchAmount of pages to preload before they become visibleinteger2
visualization.image.comparison.default.highlight.colorSetup the default image comparison highlight color. Highlight for the pixels differenceColor, in format #RRGGBB#FF0000
visualization.image.comparison.default.lowlight.colorSetup the default image comparison lowlight color. Lowlight for the common pixelsStringnone
visualization.image.comparison.default.fuzzSetup the default image comparison tolerance value. Value between 0 and 100. Value in percentage.integer3
visualization.image.comparison.enabledEnable the images comparisonbooleantrue
visualization.image.scheduled.timeoutMsTimeout (in ms) before updating the image while resizing the imageinteger500
visualization.maximumConcurrentImageFetchingMaximum number of document images to fetch simultaneouslyinteger8
visualization.nonVisiblePageTimeoutCleanup images which where non-visible for a long time (ms)integer120000
visualization.imageCleanupPeriodPeriod at which images are cleaned (ms)integer1500
visualization.maxImageCacheSizeMaximum number of images to store in the cleanup cache before LRU eviction occursinteger20

window

propertyDescriptiontypedefault
window.maximizeMaximizes the ARender windowbooleanfalse