Skip to main content
Version: v2023.18.0

Document navigator

General

By default, the document navigator is opened on the thumb explorer. The user can browse between panels by clicking on the corresponding icon. He can close the panel by clicking on the icon corresponding to the opened panel.

DescriptionParameter KeyDefault valueType
Width of document navigator (in pixels)documentnavigator.width320Integer
Width of search navigator (in pixels)documentnavigator.search.width400Integer
Width of annotations navigator (in pixels)documentnavigator.annotation.width400Integer
Time before splitter ears disappear (Deprecated in v.4.7.0, in ms)documentnavigator.ears.hideTimerDelay100Integer
Position of the splitter on opening (Default, Reduced, Expanded)documentnavigator.initialWidthDefaultString
Sets up the ratio to be applied to the document navigatordocumentnavigator.expand.reduce.ratio70Integer

Thumb explorer

The table below lists the general configuration of the explorer allowing to browse into documents through thumbs.

DescriptionParameter KeyDefault valueType
Enable/disable the explorerthumbexplorer.enabledtrueBoolean
Indentation between a master document and its children (in pixels)thumbexplorer.indentation20Integer
Depth level of documents to loadthumbexplorer.maxLevelToLoad10Integer
Enable/disable metadata displaythumbexplorer.metadatatrueBoolean
Allows thumbnails titles to have HTML contentthumbexplorer.title.allowHTMLfalseBoolean
Thumbnails will display a popup information with document metadata (in ms)thumbexplorer.layout.loading.delay5Integer
Allows to create an URL anchor to a page from the thumbnailsthumbexplorer.contextualMenu.createPageAnchortrueBoolean

The table below enumerates specific configuration related to thumbs.

DescriptionParameter KeyDefault valueType
Default width of the thumbs (in pixels)thumbexplorer.thumb.width100Integer
Margin between each thumb (in pixels)thumbexplorer.thumb.margin5Integer
Explorer width from which thumbs are expanded (in pixels)thumbexplorer.thumb.grow.min300Integer
Increment of thumb expanding (in pixels)thumbexplorer.thumb.grow.increment10Integer
Sets up the growth ratio corresponding to the growth of the panelthumbexplorer.thumb.grow.ratio1Integer

Comment explorer

DescriptionProperty keyDefault valueType
Enable/Disable this explorerannotation.comment.explorer.enabledtrueBoolean
Possibility to display annotations in minimized formatannotation.comment.explorer.inline.enabledfalseBoolean
Display annotations in minimized format when annotation explorer is openedannotation.comment.explorer.show.annotation.minimized.on.openfalseBoolean
Sets up the comment explorer on the east side of ARenderannotation.comment.explorer.eastSide.enabledfalseBoolean
Opens the comment explorer when an annotation is editedannotation.comment.explorer.openOnEditfalseBoolean
Animate while expanding the comment explorerannotation.comment.explorer.animate.on.expandtrueBoolean
Shows a simplified list of all authors on the comment explorer tabannotation.comment.explorer.showAllAnnotatorstrueBoolean
Shows a total number of annotations on the comment explorer tabannotation.comment.explorer.showTotalAnnotationsNumberfalseBoolean
Shows the comment explorer at startup of ARender as default panelannotation.comment.explorer.showAtStartupfalseBoolean
Enable/Disable to also filter annotations in the page viewannotation.comment.explorer.filterPageAnnotationsfalseBoolean
Set the sorting in increment otherwise in decrement dateannotation.comment.explorer.sortByIncrementDatetrueBoolean
Allow the display of the date or notannotation.comment.explorer.show.datetrueBoolean
Display only the initials of the creator nameannotation.comment.explorer.creator.name.initial.onlyfalseBoolean
Enable to display only one annotation per pageannotation.comment.explorer.show.one.annotation.onlyfalseBoolean
Display target icon when annotation is other than numbered sticky note, otherwise the annotation type iconannotation.comment.display.target.enabledfalseBoolean
Enable to enter in edition mode when clicking on a comment zonecomment.edit.annotation.onselection.enabledtrueBoolean
Enables the annotation types filter by list on startupannotation.comment.explorer.filter.types.enabledfalseBoolean
List of annotation types selected on startup (comma-separated). Possible values are: Circle, Freetext, Highlight, ImageStamp, Polygon, Polyline, Sound, Square, Stamp, Strikeout, Text, Underlineannotation.comment.explorer.filter.typesString

Bookmark explorer

DescriptionParameter KeyDefault valueType
Enable/Disable this explorerbookmarkexplorer.enabledtrueBoolean
Show the bookmark explorer at the application startupbookmarkexplorer.showAtStartupfalseBoolean
Make the bookmarks draggablebookmarkexplorer.draggabletrueBoolean
Enable/Disable the bookmark creationbookmarkexplorer.add.bookmark.enabledtrueBoolean
Enable/Disable the bookmark deletionbookmarkexplorer.delete.bookmark.enabledtrueBoolean
Enable/Disable the bookmark animationbookmarkexplorer.animation.enabledtrueBoolean

Advanced search explorer

DescriptionParameter KeyDefault valueType
Enable/Disable this exploreradvanced.searchexplorer.enabledtrueBoolean
Sets up the minimum character length allowedadvanced.searchexplorer.min.characterLength0Integer
Sets up the maximum character length allowedadvanced.searchexplorer.max.characterLength255Integer
Search is updated on annotation refresh when the advanced search explorer is activeadvanced.searchexplorer.updates.enabledfalseBoolean
The button for search and highlight is enabledadvanced.searchexplorer.search.highlight.enabledtrueBoolean
DescriptionParameter KeyDefault valueType
Enable/Disable this explorerhyperlinkexplorer.enabledtrueBoolean

Redact explorer

DescriptionParameter KeyDefault valueType
Enable/Disable this explorerredactexplorer.enabledfalseBoolean
Activate the redact annotation buttonredactexplorer.redacttrueBoolean
Activate the redact annotation zone buttonredactexplorer.redactZonetrueBoolean