# Classes

##

### Classes

Action
Dest
GoTo
GoToR
Hide
JavaScript
Named
ResetForm
SubmitForm
URI
AnnotationHistoryManager
AnnotationManager
Annotation
ArcAnnotation
Border
BoxControlHandle
BoxSelectionModel
ButtonWidgetAnnotation
CalloutControlHandle
CalloutSelectionModel
CanvasHelper
CaretAnnotation
CheckButtonWidgetAnnotation
ChoiceWidgetAnnotation
Color
ControlHandle
CustomAnnotation
DatePickerWidgetAnnotation
EllipseAnnotation
FileAttachmentAnnotation
Font
Forms
EmbeddedJS
Field
FieldManager
FreeHandAnnotation
FreeTextAnnotation
RichTextEditor
FreeTextSelectionModel
HTMLAnnotation
IPathAnnotation
LineAnnotation
LineControlHandle
LineSelectionModel
Link
ListWidgetAnnotation
MarkupAnnotation
Model3D
PathControlHandle
PathSelectionModel
PolygonAnnotation
PolygonControlHandle
PolygonSelectionModel
PolylineAnnotation
PopupAnnotation
RadioButtonWidgetAnnotation
RectangleAnnotation
RedactionAnnotation
RedactionSelectionModel
RotationControlHandle
RotationUtils
SelectionAlgorithm
SelectionModel
SignatureWidgetAnnotation
SoundAnnotation
StampAnnotation
StickyAnnotation
TextHighlightAnnotation
TextMarkupAnnotation
TextRedactAnnotation
TextSelectionModel
TextSquigglyAnnotation
TextStrikeoutAnnotation
TextUnderlineAnnotation
TextWidgetAnnotation
WidgetAnnotation
WidgetFlags
XFDFUtils
Bookmark
DisplayMode
DisplayModeManager
Document
DocumentViewer
EditBoxManager
EventHandler
Matrix
Point
Quad
Rect
TransformationBuilder
MeasurementManager
PartRetriever
Scale
AnnotationEditTool
AnnotationSelectTool
ArcCreateTool
ArcMeasurementCreateTool
AreaMeasurementCreateTool
ArrowCreateTool
CalloutCreateTool
ChangeViewCreateTool
CheckBoxFormFieldCreateTool
CloudyRectangularAreaMeasurementTool
ComboBoxFormFieldCreateTool
ContentEditTool
CountMeasurementCreateTool
DateFreeTextCreateTool
DistanceMeasurementCreateTool
EllipseCreateTool
EllipseMeasurementCreateTool
EraserTool
FileAttachmentCreateTool
FreeHandCreateTool
FreeHandHighlightCreateTool
FreeTextCreateTool
GenericAnnotationCreateTool
LineCreateTool
ListBoxFormFieldCreateTool
MarqueeZoomTool
PageCoordinate
PanTool
PerimeterMeasurementCreateTool
PolygonCloudCreateTool
PolygonCreateTool
PolylineCreateTool
RadioButtonFormFieldCreateTool
RectangleCreateTool
RectangularAreaMeasurementTool
RedactionCreateTool
RubberStampCreateTool
SignatureCreateTool
StampCreateTool
StickyCreateTool
TextAnnotationCreateTool
TextFormFieldCreateTool
TextHighlightCreateTool
TextSelectTool
TextSquigglyCreateTool
TextStrikeoutCreateTool
TextTool
TextUnderlineCreateTool
Tool
TextHighlightAnnotation
Header
MentionsManager
WebViewerInstance

### Mixins

Dispatcher

### Namespaces

Core
Actions
Annotations
ContentEdit
Math
PartRetrievers
Search
Tools
UI
Fonts
Hotkeys
NotesPanel
TabManager
ThumbnailsPanel
VerificationOptions

### Events

#### historyChanged

  Triggered when the annotation history stack changes. This could be used to check the canUndo or canRedo functions if their value has changed.

#### addReply

  Triggered when a reply has been added to an annotation

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added
  `parent` | Core.Annotations.Annotation | The annotation that is the direct parent of the first annotation
  `root` | Core.Annotations.Annotation | The annotation that is the root parent of the first annotation (may be the same as parent)

#### annotationChanged

  Triggered when an annotation or annotations have been changed (added, deleted, modified). Attach like annotManager.addEventListener('annotationChanged', callback)

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Array.<Core.Annotations.Annotation> | The annotations that were changed
  `action` | string | The action that occurred (add, delete, modify)
  `info` | Core.AnnotationManager.AnnotationChangedInfoObject | An object containing extra information about the annotationChanged event

#### annotationDeselected

  Triggered after annotations have been deselected.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotationList` | Array.<Core.Annotations.Annotation> | List of annotations that have been deselected.

#### annotationDoubleClicked

  Triggered after an annotation has been double clicked

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that has been double clicked

#### annotationHidden

  Triggered after annotations have been hidden/shown.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotationList` | Array.<Core.Annotations.Annotation> | List of annotations that were hidden or shown
  `hidden` | boolean | Whether the annotations have been hidden or shown

#### annotationsDrawn

  Triggered after annotations have been drawn for a page

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `pageNumber` | object | The page number of all the annotations that were just drawn

#### annotationSelected

  Triggered after annotation selection has been changed.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotationList` | Array.<Core.Annotations.Annotation> | List of annotations that have selected or deselected.
  `action` | string | Either 'selected' or 'deselected'

#### deleteReply

  Triggered when a reply has been deleted from an annotation

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was deleted
  `root` | Core.Annotations.Annotation | The annotation that is the root parent of the first annotation

#### fieldChanged

  Triggered when a field's value has been changed. Attach like annotManager.addEventListener('fieldChanged', callback)

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `field` | object | The field that was changed
  `value` | string | The field's new value

#### fileAttachmentDataAvailable

  Triggered after the file attachment data is available after double clicking on the annotation

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `fileInfo` | object | Information of the file attachment ###### Properties
  Name | Type | Description
  --- | --- | ---
  `fileData` | Blob | The blob data of the file attachment
  `filename` | string | The name of the file attachment
  `mimeType` | string | The mimetype attribute of the file attachment

#### setNoteText

  Triggered when the text should be set on a note

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that needs to have its note text updated
  `root` | Core.Annotations.Annotation | The annotation that is the root parent of the first annotation

#### updateAnnotationPermission

  Triggered when permissions for annotations should be updated. This might be when the user changes or readonly is switched to. If no annotation is specified then every annotation should be updated.

  ##### Parameters:

  Name | Type | Argument | Description
  --- | --- | --- | ---
  `annotation` | Core.Annotations.Annotation | <optional> | The annotation that needs to have its permissions updated

#### calculate

  A signal that the field should fire its own calculation events.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `source` | Core.Annotations.Forms.Field | The field that caused the calculation event.

  ##### Listeners of This Event:

  - Core.Annotations.Forms.Field

#### change

  An event that represents a field's value having changed.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `field` | Core.Annotations.Forms.Field | The field that has changed.

#### commit

  The field's value has been changed by the user. Sets a new value.

  ##### Parameters:

  Name | Type | Argument | Description
  --- | --- | --- | ---
  `value` | string | number | <nullable> | The new field value.

  ##### Listeners of This Event:

  - Core.Annotations.Forms.Field

#### editBoxesAvailable

  Triggered any time edit boxes are drawn on the page.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `boxes` | object | An array of Content Edit boxes.

#### textContentUpdated

  Triggered when text content of the page is updated.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `originalText` | string | The original text of the selected bounding box.
  `updatedText` | string | The updated text of the selected bounding box.
  `boundingBoxCoordinates` | object | The coordinates (top, left, bottom, right) of the bounding box.

#### colorSeparationAdded

  Triggered when a color separation is loaded and available on the document.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `colorData` | object | An object with properties of the color separation ###### Properties
  Name | Type | Description
  --- | --- | ---
  `name` | string | The name of the color separation
  `rgb` | Array.<any> | An array containing the R, G and B values for the separation

#### layersUpdated

  Triggered when a document's layers/OCG structures change visibility.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `layerContext` | Array.<Core.Document.LayerContext> | array of page layers

#### activeSearchResultChanged

  Triggered when the active search result has changed

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `result` | object | The new active search result, Core.DocumentViewer.SearchResult.

#### annotationsLoaded

  Triggered when all the annotations embedded in the document have been loaded

#### beforeDocumentLoaded

  Triggered just before the document has been loaded into the viewer

#### beginRendering

  Triggered when DocumentViewer starts rendering pages

#### click

  Triggered for the click event in the DocumentViewer's viewing area

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `nativeEvt` | object | Event object of the native JavaScript event

#### dblClick

  Triggered for the dblClick event in the DocumentViewer's viewing area

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `nativeEvt` | object | Event object of the native JavaScript event

#### displayModeUpdated

  Triggered when the display mode is updated

#### displayPageLocation

  Triggered when a page location should be displayed

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `pageNum` | number | The 1-indexed page number
  `verticalOffset` | number | The offset from the top of the page
  `horizontalOffset` | number | The offset from the left of the page

#### documentLoaded

  Triggered when a new document has been loaded

#### documentUnloaded

  Triggered when the current document has been closed and unloaded

#### embeddedThumbnailComplete

  Triggered when an embedded thumbnail of a viewer-optimized pdf is completely loaded.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `pageNum` | number | The 1-indexed page number

#### finishedRendering

  Triggered when DocumentViewer finishes rendering pages

#### fitModeUpdated

  Triggered when the fit mode has changed

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `fitMode` | object | The fit mode that has been changed to e.g. docViewer.FitMode.FitWidth

#### keyDown

  Triggered for the keyDown event in the DocumentViewer's viewing area

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `nativeEvt` | object | Event object of the native JavaScript event

#### keyUp

  Triggered for the keyUp event in the DocumentViewer's viewing area

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `nativeEvt` | object | Event object of the native JavaScript event

#### mouseEnter

  Triggered for the mouseEnter event in the DocumentViewer's viewing area

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `nativeEvt` | object | Event object of the native JavaScript event

#### mouseLeave

  Triggered for the mouseLeave event in the DocumentViewer's viewing area

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `nativeEvt` | object | Event object of the native JavaScript event

#### mouseLeftDown

  Triggered for the mouseLeftButtonDown event in the DocumentViewer's viewing area Attach like docViewer.addEventListener('mouseLeftDown', callback)

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `nativeEvt` | object | Event object of the native JavaScript event

#### mouseLeftUp

  Triggered for the mouseLeftButtonUp event in the DocumentViewer's viewing area

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `nativeEvt` | object | Event object of the native JavaScript event

#### mouseMove

  Triggered for the mouseMove event in the DocumentViewer's viewing area

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `nativeEvt` | object | Event object of the native JavaScript event

#### mouseRightDown

  Triggered for the mouseRightButtonDown event in the DocumentViewer's viewing area

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `nativeEvt` | object | Event object of the native JavaScript event

#### mouseRightUp

  Triggered for the mouseRightButtonUp event in the DocumentViewer's viewing area

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `nativeEvt` | object | Event object of the native JavaScript event

#### notify

  Triggered when there is a notification relating to searching or annotation permissions.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `type` | string | The type of notification that has occurred

#### pageComplete

  Triggered when a page has been completely rendered.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `pageNum` | number | The 1-indexed page number
  `canvas` | HTMLCanvasElement | The canvas for the page

#### pageNumberUpdated

  Triggered when the page number is updated

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `pageNumber` | number | The new page number (1-indexed)

#### pagesUpdated

  Triggered when the layout has changed because pages have permanently been added, removed, moved or changed in some other way.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `changes` | object | An object with keys added, removed, moved and contentChanged, indicating which pages have changed

#### rotationUpdated

  Triggered when the page rotation has changed

  ##### Parameters:

  Name | Type | Argument | Description
  --- | --- | --- | ---
  `rotation` | Core.PageRotation |  | The new viewing rotation.
  `pageNumber` | number | <optional> | Optionally the specific page number that had its rotation changed

#### searchInProgress

  Triggered when a search starts or ends. When Core.DocumentViewer#clearSearchResults is executed searchInProgress event is triggered with both inProgress and isFullSearch arguments to be undefined. This can be used to differentiate the search that hasn’t been started versus the search that was done.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `inProgress` | boolean | Whether a search is in progress or not
  `isFullSearch` | boolean | Whether this is a full text search or not

#### searchResultsChanged

  Triggered when the search results list has changed

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `results` | Array.<object> | The new search results, Core.DocumentViewer.SearchResult.

#### tap

  Triggered when there is a tap in the DocumentViewer's viewing area. Taps are defined as a mouse down and up within a short time period and within a short distance.a

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `nativeEvt` | object | Event object of the native JavaScript event

#### textSelected

  Triggered when the selected text has changed

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `quads` | Array.<Core.Math.Quad> | An array of bounding box quads of the selected text
  `text` | string | The selected text
  `pageNumber` | number | The page number that the text was selected on

#### toolModeUpdated

  Triggered when the tool mode has changed

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `newToolObject` | object | The tool object that has been changed to.
  `oldToolObject` | object | The tool object that has been changed from.

#### toolUpdated

  Triggered when the tool styles or tool name have changed

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `toolModeClass` | object | The tool object that has been changed.

#### zoomUpdated

  Triggered when the zoom level has been updated

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `zoom` | number | The new zoom level of the viewer

#### editorBlur

  Triggered after an editor blurred

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `editor` | Core.Annotations.FreeTextAnnotation.RichTextEditor | an instance of Editor
  `annotation` | Core.Annotations.FreeTextAnnotation | a freetext annotation

#### editorFocus

  Triggered after an editor is focused

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `editor` | Core.Annotations.FreeTextAnnotation.RichTextEditor | an instance of Editor
  `annotation` | Core.Annotations.FreeTextAnnotation | a freetext annotation

#### editorSelectionChanged

  Triggered after selection in the editor changed

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `range` | Core.EditBoxManager.Range | current selected range
  `oldRange` | Core.EditBoxManager.Range | previous selected range

#### editorTextChanged

  Triggered after some text in the editor changed

#### scaleUpdated

  Triggered when the scale has been updated.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `result` | object | All the scales with related annotations

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded
  Overrides:
    - Core.Tools.PolylineCreateTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated
  Overrides:
    - Core.Tools.PolylineCreateTool#event:annotationCreated

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded
  Overrides:
    - Core.Tools.ArcCreateTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated
  Overrides:
    - Core.Tools.ArcCreateTool#event:annotationCreated

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded
  Overrides:
    - Core.Tools.PerimeterMeasurementCreateTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated
  Overrides:
    - Core.Tools.PerimeterMeasurementCreateTool#event:annotationCreated

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded
  Overrides:
    - Core.Tools.LineCreateTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated
  Overrides:
    - Core.Tools.LineCreateTool#event:annotationCreated

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded
  Overrides:
    - Core.Tools.PolylineCreateTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated
  Overrides:
    - Core.Tools.PolylineCreateTool#event:annotationCreated

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded
  Overrides:
    - Core.Tools.RectangleCreateTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated
  Overrides:
    - Core.Tools.RectangleCreateTool#event:annotationCreated

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded
  Overrides:
    - Core.Tools.RectangularAreaMeasurementTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated
  Overrides:
    - Core.Tools.RectangularAreaMeasurementTool#event:annotationCreated

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded
  Overrides:
    - Core.Tools.RectangleCreateTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated
  Overrides:
    - Core.Tools.RectangleCreateTool#event:annotationCreated

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.StickyCreateTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.StickyCreateTool#event:annotationCreated

#### cropApplied

  Fired when a crop is performed on the document

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `cropInfo` | Object | ###### Properties
  Name | Type | Description
  --- | --- | ---
  `pageNumber` | number | The page number the crop was applied on
  `left` | number | The number of points (pts) cut off the left edge
  `right` | number | The number of points (pts) cut off the right edge
  `bottom` | number | The number of points (pts) cut off the bottom edge
  `top` | number | The number of points (pts) cut off the top edge

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded
  Overrides:
    - Core.Tools.FreeTextCreateTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated
  Overrides:
    - Core.Tools.FreeTextCreateTool#event:annotationCreated

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded
  Overrides:
    - Core.Tools.LineCreateTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated
  Overrides:
    - Core.Tools.LineCreateTool#event:annotationCreated

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded
  Overrides:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated
  Overrides:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded
  Overrides:
    - Core.Tools.EllipseCreateTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated
  Overrides:
    - Core.Tools.EllipseCreateTool#event:annotationCreated

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded
  Overrides:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated
  Overrides:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated

#### erasingAnnotation

  Triggered when an annotation is about to be deleted from the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `args` | object | Event arguments with event related properties ###### Properties
  Name | Type | Description
  --- | --- | ---
  `annotation` |  | The annotation that will be deleted
  `skipAnnotation` | Core.Annotations.FreeHandAnnotation | A function you can call to skip deleting the annotation or points from a

  ##### Example

      const eraserTool = docViewer.getTool('AnnotationEraserTool');

          eraserTool.addEventListener('erasingAnnotation', function(args) {
            // Make eraser tool skip deleting rectangle annotations
            if (args.annotation instanceof Annotations.RectangleAnnotation) {
              args.skipAnnotation();
            }
          });

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded
  Overrides:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated
  Overrides:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded
  Overrides:
    - Core.Tools.FreeHandCreateTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated
  Overrides:
    - Core.Tools.FreeHandCreateTool#event:annotationCreated

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded
  Overrides:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated
  Overrides:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded
  Overrides:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated
  Overrides:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded
  Overrides:
    - Core.Tools.RectangleCreateTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated
  Overrides:
    - Core.Tools.RectangleCreateTool#event:annotationCreated

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded
  Overrides:
    - Core.Tools.PolylineCreateTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated
  Overrides:
    - Core.Tools.PolylineCreateTool#event:annotationCreated

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded
  Overrides:
    - Core.Tools.PolygonCreateTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated
  Overrides:
    - Core.Tools.PolygonCreateTool#event:annotationCreated

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded
  Overrides:
    - Core.Tools.PolylineCreateTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated
  Overrides:
    - Core.Tools.PolylineCreateTool#event:annotationCreated

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded
  Overrides:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated
  Overrides:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded
  Overrides:
    - Core.Tools.EllipseCreateTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated
  Overrides:
    - Core.Tools.EllipseCreateTool#event:annotationCreated

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded
  Overrides:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated
  Overrides:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded
  Overrides:
    - Core.Tools.AreaMeasurementCreateTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated
  Overrides:
    - Core.Tools.AreaMeasurementCreateTool#event:annotationCreated

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.TextAnnotationCreateTool#event:annotationAdded
  Overrides:
    - Core.Tools.TextAnnotationCreateTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.TextAnnotationCreateTool#event:annotationCreated
  Overrides:
    - Core.Tools.TextAnnotationCreateTool#event:annotationCreated

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.StampAnnotation | The annotation that was added

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

#### fileRejected

  Triggered when a file has been rejected because of exceeding file size limit

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `reasons` | Object | The rejection reasons object ###### Properties
  Name | Type | Description
  --- | --- | ---
  `reason` | string | Reason why the file was rejected
  `maxSize` | number | Maximum accpted file size in bytes
  `size` | number | Uploaded file size in bytes

#### locationSelected

  Triggered when a page location has been clicked on by the tool

  ##### Parameters:

  Name | Type | Argument | Description
  --- | --- | --- | ---
  `pageCoordinates` | Core.Tools.PageCoordinate |  | Indicates where the tool clicked
  `signatureWidget` | Core.Annotations.SignatureWidgetAnnotation | <optional> | The signature widget that was clicked to trigger the event

#### signatureDeleted

  Triggered when the tool deletes a signature

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was deleted
  `index` | number | The index of the annotation in the list

#### signatureSaved

  Triggered when the tool saves a signature

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was saved

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

#### fileRejected

  Triggered when a file has been rejected because of exceeding file size limit

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `reasons` | Object | The rejection reasons object ###### Properties
  Name | Type | Description
  --- | --- | ---
  `reason` | string | Reason why the file was rejected
  `maxSize` | number | Maximum accpted file size in bytes
  `size` | number | Uploaded file size in bytes

#### fileRejected

  Triggered when a file has been rejected because of exceeding file size limit

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `reasons` | Object | The rejection reasons object ###### Properties
  Name | Type | Description
  --- | --- | ---
  `reason` | string | Reason why the file was rejected
  `maxSize` | number | Maximum accpted file size in bytes
  `size` | number | Uploaded file size in bytes

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationAdded
  Overrides:
    - Core.Tools.RectangleCreateTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.GenericAnnotationCreateTool#event:annotationCreated
  Overrides:
    - Core.Tools.RectangleCreateTool#event:annotationCreated

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.TextAnnotationCreateTool#event:annotationAdded
  Overrides:
    - Core.Tools.TextAnnotationCreateTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.TextAnnotationCreateTool#event:annotationCreated
  Overrides:
    - Core.Tools.TextAnnotationCreateTool#event:annotationCreated

#### selectionComplete

  Triggered when the user has released the mouse after selecting text

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `startLocation` | object | An object with keys "quad" and "pageNumber" which is the starting quad and page number of the text selection
  `allQuads` | object | An object with keys being the page numbers and values being an array of quads for the selected text on that page

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.TextAnnotationCreateTool#event:annotationAdded
  Overrides:
    - Core.Tools.TextAnnotationCreateTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.TextAnnotationCreateTool#event:annotationCreated
  Overrides:
    - Core.Tools.TextAnnotationCreateTool#event:annotationCreated

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.TextAnnotationCreateTool#event:annotationAdded
  Overrides:
    - Core.Tools.TextAnnotationCreateTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.TextAnnotationCreateTool#event:annotationCreated
  Overrides:
    - Core.Tools.TextAnnotationCreateTool#event:annotationCreated

#### annotationAdded

  Triggered when an annotation has been added to the document by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotation` | Core.Annotations.Annotation | The annotation that was added

  Inherited From:
    - Core.Tools.TextAnnotationCreateTool#event:annotationAdded
  Overrides:
    - Core.Tools.TextAnnotationCreateTool#event:annotationAdded

#### annotationCreated

  Triggered when an annotation has been created by the tool

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `annotations` | Core.Annotations.Annotation | The annotation that was created

  Inherited From:
    - Core.Tools.TextAnnotationCreateTool#event:annotationCreated
  Overrides:
    - Core.Tools.TextAnnotationCreateTool#event:annotationCreated

#### mentionChanged

  Triggered when a mention or mentions have been changed (added, deleted, modified). Attach like instance.mentions.on('mentionChanged', callback)

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `mentions` | UI.MentionsManager.Mention | The mentions that were changed
  `action` | 'add' | 'modify' | 'delete' | The action that occurred (add, delete, modify)

#### annotationFilterChanged

  Triggered when annotation filter in the notes panel has changed. Returns empty arrays if the filter is cleared.

  ##### Type: object

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `types` | Array.<string> | Types filter
  `authors` | Array.<string> | Author filter
  `colors` | Array.<string> | Color filter
  `statuses` | Array.<string> | Status filter

#### beforeTabChanged

  Triggered before the UI switches tabs

  ##### Type: object

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `currentTab` | object | An object containing the properties for the currently active tab (null if no currently active tab) ###### Properties
  Name | Type | Description
  --- | --- | ---
  `id` | number | The id of the tab being switched to
  `src` | string | Source of current tab
  `options` | string | Tab load options
  `annotationsChanged` | boolean | True if the annotations have been changed since loading the tab
  `nextTab` | object | An object containing the properties for the tab being switched to ###### Properties
  Name | Type | Description
  --- | --- | ---
  `id` | number | The id of the tab being switched to
  `src` | string | Source of current tab
  `options` | string | Tab load options

#### documentLoaded

  Triggered when a new document has been loaded.

#### documentMerged

  Triggered when a new document has been merged into the thumbnails panel.

  ##### Type: object

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `filename` | string | File name
  `pages` | Array.<number> | Page numbers

#### dragOutline

  Triggered when dragging Outline item.

#### dragOutline

  Triggered when dropping Outline item.

#### fileDownloaded

  Triggered when the file has finished downloading.

#### finishedSavingPDF

  Deprecated:
    - Since version 8.3. Use fileDownloaded instead

#### fullscreenModeToggled

  Triggered when fullscreen mode is toggled.

  ##### Type: object

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `isInFullscreen` | boolean | Whether in fullscreen mode or not.

#### loaderror

  Triggered when there is an error loading the document.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `err` | object | The error

#### outlineBookmarksChanged

  Triggered when outline bookmarks have changed.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `bookmarkData` | object | ###### Properties
  Name | Type | Description
  --- | --- | ---
  `bookmark` | object | The changed bookmark ###### Properties
  Name | Type | Description
  --- | --- | ---
  `id` | string | Changed outline bookmark id
  `name` | string | Changed outline bookmark name
  `path` | string | Changed outline path in the outline tree
  `action` | string | The action that triggered the outline bookmarks change

#### panelResized

  Triggered when the panels are resized.

  ##### Type: object

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `element` | string | DataElement name
  `width` | number | New panel width

#### selectedThumbnailChanged

  Triggered when the selected thumbnail changed.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `selectedThumbnailPageIndexes` | array | The array of indexes of currently selected thumbnails

#### tabAdded

  Triggered when a Tab is added

  ##### Type: object

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `id` | number | The id of the tab being added
  `src` | string | Source of current tab
  `options` | string | Tab load options

#### tabDeleted

  Triggered when a Tab is deleted

  ##### Type: object

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `id` | number | The id of the tab being deleted
  `src` | string | Source of current tab
  `options` | string | Tab load options

#### tabMoved

  Triggered when a Tab is moved

  ##### Type: object

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `id` | number | The id of the tab being moved
  `src` | string | Source of moved tab
  `options` | string | Tab load options
  `prevIndex` | number | Previous index of tab
  `newIndex` | number | New index of tab

#### themeChanged

  Triggered when the UI theme has changed.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `theme` | string | The new UI theme

#### thumbnailDragged

  Triggered when thumbnail(s) are dragged in the thumbnail panel

#### thumbnailDropped

  Triggered when dragged thumbnail(s) are dropped to a new location in the thumbnail panel

  ##### Type: object

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `pageNumbersBeforeMove` | Array.<number> | The array of page numbers to be moved
  `pageNumbersAfterMove` | Array.<number> | The array of page numbers of where thumbnails being dropped
  `numberOfPagesMoved` | number | Number of page(s) being moved

#### toolbarGroupChanged

  Triggered when the toolbar group has changed.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `toolbarGroup` | string | The new toolbar group

#### userBookmarksChanged

  Triggered when user bookmarks have changed.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `bookmarks` | object | The new bookmarks

#### viewerLoaded

  Triggered when the viewer has loaded.

#### visibilityChanged

  Triggered when the visibility of an element has changed.

  ##### Type: object

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `element` | string | DataElement name
  `isVisible` | boolean | The new visibility

#### Search results