Classes
- Action
- Dispatcher
- GoTo
- Dest
- Hide
- JavaScript
- Named
- ResetForm
- SubmitForm
- URI
- Annotation
- BoxControlHandle
- BoxSelectionModel
- ButtonWidgetAnnotation
- CalloutControlHandle
- CalloutSelectionModel
- CaretAnnotation
- CheckButtonWidgetAnnotation
- ChoiceWidgetAnnotation
- Color
- ControlHandle
- EllipseAnnotation
- Font
- Forms
- Field
- FieldManager
- FreeHandAnnotation
- FreeTextAnnotation
- FreeTextSelectionModel
- HTMLAnnotation
- IPathAnnotation
- LineAnnotation
- LineControlHandle
- LineSelectionModel
- Link
- ListWidgetAnnotation
- MarkupAnnotation
- PathControlHandle
- PathSelectionModel
- Point
- PolygonAnnotation
- PolygonControlHandle
- PolygonSelectionModel
- PolylineAnnotation
- PopupAnnotation
- RadioButtonWidgetAnnotation
- Rect
- RectangleAnnotation
- SelectionModel
- SignatureWidgetAnnotation
- StampAnnotation
- StickyAnnotation
- TextHighlightAnnotation
- TextMarkupAnnotation
- TextSelectionModel
- TextSquigglyAnnotation
- TextStrikeoutAnnotation
- TextUnderlineAnnotation
- TextWidgetAnnotation
- WidgetAnnotation
- WidgetFlags
- BaseReaderControl
- AnnotationManager
- Bookmark
- DisplayMode
- DisplayModeManager
- Document
- DocumentViewer
- AndroidContentPartRetriever
- AzurePartRetriever
- ExternalPdfPartRetriever
- HttpPartRetriever
- IOSPartRetriever
- LocalPartRetriever
- LocalPdfPartRetriever
- StreamingPartRetriever
- WinRTPartRetriever
- ReaderControl
- AnnotationEditTool
- AnnotationSelectTool
- ArrowCreateTool
- CalloutCreateTool
- EllipseCreateTool
- FreeHandCreateTool
- FreeTextCreateTool
- GenericAnnotationCreateTool
- LineCreateTool
- PanTool
- PolygonCloudCreateTool
- PolygonCreateTool
- PolylineCreateTool
- RectangleCreateTool
- SignatureCreateTool
- StampCreateTool
- StickyCreateTool
- TextAnnotationCreateTool
- TextHighlightCreateTool
- TextSelectTool
- TextSquigglyCreateTool
- TextStrikeoutCreateTool
- TextTool
- TextUnderlineCreateTool
- Tool
- WebViewerInterface
Namespaces
Events
-
calculate
-
A signal that the field should fire its own calculation events.
Parameters:
Name Type Description source
Annotations.Forms.Field The field that caused the calculation event.
Listeners of This Event:
-
change
-
An event that represents a field's value having changed.
Parameters:
Name Type Description field
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:
-
addReply
-
Triggered when a reply has been added to an annotation
Parameters:
Name Type Description evt
object Event object
annotation
object The annotation that was added
parent
object The annotation that is the direct parent of the first annotation
root
object 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.on('annotationChanged', callback)
Parameters:
Name Type Description evt
object Event object, this has an imported property that will be true if the annotation change is the result of importing annotations using importAnnotations, importAnnotCommand or if the imported parameter is set to true when calling addAnnotations or deleteAnnotations
annotations
array The annotations that were changed
action
string The action that occurred (add, delete, modify)
-
annotationDoubleClicked
-
Triggered after an annotation has been double clicked
Parameters:
Name Type Description evt
object Event object
annotation
object The annotation that has been double clicked
-
annotationFiltered
-
Triggered after the annotations have been filtered.
Parameters:
Name Type Description evt
object Event object
annotationList
array List of all annotations
-
annotationHidden
-
Triggered after annotations have been hidden/shown.
Parameters:
Name Type Description evt
object Event object
annotationList
array List of annotations that were hidden or shown
hidden
boolean Whether the annotations have been hidden or shown
-
annotationSelected
-
Triggered after annotation selection has been changed.
Parameters:
Name Type Description evt
object Event object
annotationList
array List of annotations that have selected or deselected
action
string Either 'selected' or 'deselected'
-
annotationToggled
-
Triggered after annotations have been toggled on/off.
Parameters:
Name Type Description evt
object Event object
markupOff
boolean Whether the annotations are visible or not
annotationList
array List of all annotations
useFilter
boolean Whether a filter is being used or not
-
deleteReply
-
Triggered when a reply has been deleted from an annotation
Parameters:
Name Type Description evt
object Event object
annotation
object The annotation that was deleted
root
object The annotation that is the root parent of the first annotation
-
fieldChanged
-
Triggered when a field's value has been changed. Attach like annotManager.on('fieldChanged', callback)
Parameters:
Name Type Description evt
object Event object
field
object The field that was changed
value
string The field's new value
-
notify
-
Triggered when there is a notification related to annotations.
Parameters:
Name Type Description evt
object Event object
type
string The type of notification that has occurred
-
setNoteText
-
Triggered when the text should be set on a note
Parameters:
Name Type Description evt
object Event object
annotation
object The annotation that needs to have its note text updated
root
object The annotation that is the root parent of the first annotation
-
beforeDocumentLoaded
-
Triggered just before the document has been loaded into the viewer
Parameters:
Name Type Description evt
object jQuery's event object
-
changePage
-
Triggered when the page should be changed. Only fired when using a non-scrollable custom display mode.
Parameters:
Name Type Description evt
object jQuery's event object
pageNum
int The 1-indexed page number
-
dblClick
-
Triggered for the dblClick event in the DocumentViewer's viewing area
Parameters:
Name Type Description evt
object jQuery's event object
nativeEvt
object Event object of the native JavaScript event
-
displayModeUpdated
-
Triggered when the display mode is updated
Parameters:
Name Type Description evt
object jQuery's event object
-
displayPageLocation
-
Triggered when a page location should be displayed
Parameters:
Name Type Description evt
object jQuery's event object
pageNum
int The 1-indexed page number
verticalOffset
float The offset from the top of the page
horizontalOffset
float The offset from the left of the page
-
documentLoaded
-
Triggered when the document has been loaded
Parameters:
Name Type Description evt
object jQuery's event object
-
fitModeUpdated
-
Triggered when the fit mode has changed
Parameters:
Name Type Description evt
object jQuery's event object
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 evt
object jQuery's event object
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 evt
object jQuery's event object
nativeEvt
object Event object of the native JavaScript event
-
layoutChanged
-
Triggered when the layout has changed because pages have permanently been added, removed, moved or changed in some other way.
Parameters:
Name Type Description evt
object jQuery's event object
changes
object An object with keys added, removed, moved and contentChanged, indicating which pages have changed
-
linkReady
-
Triggered when a link is created on the page.
Parameters:
Name Type Description evt
object jQuery's event object
linkElement
object The HTML span element that represents the link
link
object Link object that contains more information about the link
-
mouseEnter
-
Triggered for the mouseEnter event in the DocumentViewer's viewing area
Parameters:
Name Type Description evt
object jQuery's event object
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 evt
object jQuery's event object
nativeEvt
object Event object of the native JavaScript event
-
mouseLeftDown
-
Triggered for the mouseLeftButtonDown event in the DocumentViewer's viewing area Attach like docViewer.on('mouseLeftDown', callback)
Parameters:
Name Type Description evt
object jQuery's event object
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 evt
object jQuery's event object
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 evt
object jQuery's event object
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 evt
object jQuery's event object
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 evt
object jQuery's event object
nativeEvt
object Event object of the native JavaScript event
-
pageComplete
-
Triggered when a page has been completely rendered.
Parameters:
Name Type Argument Description evt
object jQuery's event object
pageIndex
object The 0-indexed page index
canvas
object <optional>
The canvas for the page
-
pageNumberUpdated
-
Triggered when the page number is updated
Parameters:
Name Type Description evt
object jQuery's event object
pageNumber
int The new page number (1-indexed)
-
rotationUpdated
-
Triggered when the page rotation has changed
Parameters:
Name Type Argument Description evt
object jQuery's event object
rotation
CoreControls.PageRotation The new viewing rotation.
pageNumber
number <optional>
Optionally the specific page number that had its rotation changed
-
textSelected
-
Triggered when the selected text has changed
Parameters:
Name Type Description evt
object jQuery's event object
quads
array An array of bounding box quads of the selected text
text
string The selected text
pageIndex
int The zero-indexed page number that the text was selected on
-
toolModeUpdated
-
Triggered when the tool mode has changed
Parameters:
Name Type Description evt
object jQuery's event object
toolModeClass
object The tool mode class that has been changed to.
-
zoomUpdated
-
Triggered when the zoom level has been updated
Parameters:
Name Type Description evt
object jQuery's event object
zoom
int The new zoom level of the viewer
-
documentLoaded
-
A global DOM event that is triggered when a document has been loaded.
Parameters:
Name Type Description e
a JavaScript event object
-
fitModeChanged
-
A global DOM event that is triggered when the fit mode has changed
Parameters:
Name Type Description e
a JavaScript event object
toolMode
object the new fit mode
-
layoutModeChanged
-
A global DOM event that is triggered when the display mode has changed
Parameters:
Name Type Description e
a JavaScript event object
toolMode
object the new display mode
-
pageChanged
-
A global DOM event that is triggered when the current page number has changed.
Parameters:
Name Type Description e
a JavaScript event object
pageNumber
integer the new 1-based page number
-
pageCompleted
-
A global DOM event that is triggered when a page had finished rendering.
Parameters:
Name Type Description e
a JavaScript event object
pageNumber
integer the 1-based page number that finished rendering
-
viewerLoaded
-
A global DOM event that is triggered when the viewer has been loaded and ReaderControl is constructed.
Parameters:
Name Type Description e
a JavaScript event object
-
zoomChanged
-
A global DOM event that is triggered when the document view's zoom level has changed.
Parameters:
Name Type Description e
a JavaScript event object
zoom
number the new zoom level value
-
annotationAdded
-
Triggered when an annotation has been added to the document by the tool
Parameters:
Name Type Description evt
object Event object
annotation
Annotations.Annotation The annotation that was added
- Inherited From:
-
annotationCreated
-
Triggered when an annotation has been created by the tool
Parameters:
Name Type Description evt
object Event object
annotations
Annotations.Annotation The annotation that was created
- Inherited From:
-
annotationAdded
-
Triggered when an annotation has been added to the document by the tool
Parameters:
Name Type Description evt
object Event object
annotation
Annotations.Annotation The annotation that was added
- Inherited From:
-
annotationCreated
-
Triggered when an annotation has been created by the tool
Parameters:
Name Type Description evt
object Event object
annotations
Annotations.Annotation The annotation that was created
- Inherited From:
-
annotationAdded
-
Triggered when an annotation has been added to the document by the tool
Parameters:
Name Type Description evt
object Event object
annotation
Annotations.Annotation The annotation that was added
- Inherited From:
-
annotationCreated
-
Triggered when an annotation has been created by the tool
Parameters:
Name Type Description evt
object Event object
annotations
Annotations.Annotation The annotation that was created
- Inherited From:
-
annotationAdded
-
Triggered when an annotation has been added to the document by the tool
Parameters:
Name Type Description evt
object Event object
annotation
Annotations.Annotation The annotation that was added
- Inherited From:
-
annotationCreated
-
Triggered when an annotation has been created by the tool
Parameters:
Name Type Description evt
object Event object
annotations
Annotations.Annotation The annotation that was created
- Inherited From:
-
annotationAdded
-
Triggered when an annotation has been added to the document by the tool
Parameters:
Name Type Description evt
object Event object
annotation
Annotations.Annotation The annotation that was added
- Inherited From:
-
annotationCreated
-
Triggered when an annotation has been created by the tool
Parameters:
Name Type Description evt
object Event object
annotations
Annotations.Annotation The annotation that was created
- Inherited From:
-
annotationAdded
-
Triggered when an annotation has been added to the document by the tool
Parameters:
Name Type Description evt
object Event object
annotation
Annotations.Annotation The annotation that was added
-
annotationCreated
-
Triggered when an annotation has been created by the tool
Parameters:
Name Type Description evt
object Event object
annotations
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 evt
object Event object
annotation
Annotations.Annotation The annotation that was added
- Inherited From:
-
annotationCreated
-
Triggered when an annotation has been created by the tool
Parameters:
Name Type Description evt
object Event object
annotations
Annotations.Annotation The annotation that was created
- Inherited From:
-
annotationAdded
-
Triggered when an annotation has been added to the document by the tool
Parameters:
Name Type Description evt
object Event object
annotation
Annotations.Annotation The annotation that was added
- Inherited From:
-
annotationCreated
-
Triggered when an annotation has been created by the tool
Parameters:
Name Type Description evt
object Event object
annotations
Annotations.Annotation The annotation that was created
- Inherited From:
-
annotationAdded
-
Triggered when an annotation has been added to the document by the tool
Parameters:
Name Type Description evt
object Event object
annotation
Annotations.Annotation The annotation that was added
- Inherited From:
-
annotationCreated
-
Triggered when an annotation has been created by the tool
Parameters:
Name Type Description evt
object Event object
annotations
Annotations.Annotation The annotation that was created
- Inherited From:
-
annotationAdded
-
Triggered when an annotation has been added to the document by the tool
Parameters:
Name Type Description evt
object Event object
annotation
Annotations.Annotation The annotation that was added
- Inherited From:
-
annotationCreated
-
Triggered when an annotation has been created by the tool
Parameters:
Name Type Description evt
object Event object
annotations
Annotations.Annotation The annotation that was created
- Inherited From:
-
annotationAdded
-
Triggered when an annotation has been added to the document by the tool
Parameters:
Name Type Description evt
object Event object
annotation
Annotations.Annotation The annotation that was added
- Inherited From:
-
annotationCreated
-
Triggered when an annotation has been created by the tool
Parameters:
Name Type Description evt
object Event object
annotations
Annotations.Annotation The annotation that was created
- Inherited From:
-
annotationAdded
-
Triggered when an annotation has been added to the document by the tool
Parameters:
Name Type Description evt
object Event object
annotation
Annotations.Annotation The annotation that was added
-
locationSelected
-
Triggered when a page location has been clicked on by the tool
Parameters:
Name Type Description evt
object Event object
pageCoordinates
Tools.PageCoordinate Indicates where the tool clicked
-
saveDefault
-
Triggered when the tool saves a signature as the default
Parameters:
Name Type Description evt
object Event object
paths
Array.<Array> An array of arrays that contains the coordinates of the signature points
-
annotationAdded
-
Triggered when an annotation has been added to the document by the tool
Parameters:
Name Type Description evt
object Event object
annotation
Annotations.Annotation The annotation that was added
-
annotationCreated
-
Triggered when an annotation has been created by the tool
Parameters:
Name Type Description evt
object Event object
annotations
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 evt
object Event object
annotation
Annotations.Annotation The annotation that was added
-
annotationCreated
-
Triggered when an annotation has been created by the tool
Parameters:
Name Type Description evt
object Event object
annotations
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 evt
object Event object
annotation
Annotations.Annotation The annotation that was added
- Inherited From:
-
annotationCreated
-
Triggered when an annotation has been created by the tool
Parameters:
Name Type Description evt
object Event object
annotations
Annotations.Annotation The annotation that was created
- Inherited From:
-
annotationAdded
-
Triggered when an annotation has been added to the document by the tool
Parameters:
Name Type Description evt
object Event object
annotation
Annotations.Annotation The annotation that was added
- Inherited From:
-
annotationCreated
-
Triggered when an annotation has been created by the tool
Parameters:
Name Type Description evt
object Event object
annotations
Annotations.Annotation The annotation that was created
- Inherited From:
-
annotationAdded
-
Triggered when an annotation has been added to the document by the tool
Parameters:
Name Type Description evt
object Event object
annotation
Annotations.Annotation The annotation that was added
- Inherited From:
-
annotationCreated
-
Triggered when an annotation has been created by the tool
Parameters:
Name Type Description evt
object Event object
annotations
Annotations.Annotation The annotation that was created
- Inherited From:
-
annotationAdded
-
Triggered when an annotation has been added to the document by the tool
Parameters:
Name Type Description evt
object Event object
annotation
Annotations.Annotation The annotation that was added
- Inherited From:
-
annotationCreated
-
Triggered when an annotation has been created by the tool
Parameters:
Name Type Description evt
object Event object
annotations
Annotations.Annotation The annotation that was created
- Inherited From: