PDFTron WebViewer HTML5

Classes

Classes

Action
Dispatcher
GoTo
Dest
GoToR
Hide
JavaScript
Named
ResetForm
SubmitForm
URI
Annotation
Border
BoxControlHandle
BoxSelectionModel
ButtonWidgetAnnotation
CalloutControlHandle
CalloutSelectionModel
CaretAnnotation
CheckButtonWidgetAnnotation
ChoiceWidgetAnnotation
Color
ControlHandle
CustomAnnotation
EllipseAnnotation
Font
Forms
EmbeddedJS
Field
FieldManager
FreeHandAnnotation
FreeTextAnnotation
FreeTextSelectionModel
HTMLAnnotation
IPathAnnotation
LineAnnotation
LineControlHandle
LineSelectionModel
Link
ListWidgetAnnotation
MarkupAnnotation
PathControlHandle
PathSelectionModel
Point
PolygonAnnotation
PolygonControlHandle
PolygonSelectionModel
PolylineAnnotation
PopupAnnotation
Quad
RadioButtonWidgetAnnotation
Rect
RectangleAnnotation
RedactionAnnotation
RedactionSelectionModel
SelectionModel
SignatureWidgetAnnotation
StampAnnotation
StickyAnnotation
TextHighlightAnnotation
TextMarkupAnnotation
TextSelectionModel
TextSquigglyAnnotation
TextStrikeoutAnnotation
TextUnderlineAnnotation
TextWidgetAnnotation
WidgetAnnotation
WidgetFlags
AnnotationManager
BlackBoxAnnotationManager
Bookmark
DisplayMode
DisplayModeManager
Document
DocumentViewer
AndroidContentPartRetriever
ArrayBufferPdfPartRetriever
AzurePartRetriever
ExternalPdfPartRetriever
HttpPartRetriever
IOSPartRetriever
LocalPartRetriever
LocalPdfPartRetriever
MagicPartRetriever
PartRetriever
RangeStreamingPartRetriever
StreamingPartRetriever
WinRTPartRetriever
Action
ActionParameter
Annot
AnnotBorderStyle
AppearanceReferenceList
AttrObj
Bookmark
CaretAnnot
ChunkRenderer
CircleAnnot
ClassMap
ColorPt
ColorSpace
ContentItem
ContentReplacer
ConversionMonitor
Date
Destination
DictIterator
DocumentConversion
Element
ElementBuilder
ElementReader
ElementWriter
FDFDoc
FDFField
Field
FileAttachmentAnnot
FileSpec
Filter
FilterReader
FilterWriter
Flattener
Font
FreeTextAnnot
Function
GeometryCollection
GState
HighlightAnnot
Highlights
HTML2PDF
HTML2PDF_Proxy
HTML2PDF_TOCSettings
HTML2PDF_WebPageSettings
Image
InkAnnot
Iterator
KeyStrokeActionResult
KeyStrokeEventData
LineAnnot
LinkAnnot
MarkupAnnot
Matrix2D
MovieAnnot
NameTree
NumberTree
Obj
ObjSet
OCG
OCGConfig
OCGContext
OCMD
Optimizer
OwnedBitmap
Page
PageLabel
PageSet
PatternColor
PDFACompliance
PDFDC
PDFDCEX
PDFDoc
PDFDocInfo
PDFDocViewPrefs
PDFDraw
PDFNet
PDFRasterizer
PDFView
PDFViewCtrl
Point
PolygonAnnot
PolyLineAnnot
PopupAnnot
ProgressMonitor
QuadPoint
Rect
Redaction
RedactionAnnot
RedactionAppearance
Redactor
RoleMap
RubberStampAnnot
ScreenAnnot
SDFDoc
SecurityHandler
SElement
Shading
SignatureHandler
SoundAnnot
SquareAnnot
SquigglyAnnot
Stamper
STree
StrikeOutAnnot
TextAnnot
TextExtractor
TextExtractorLine
TextExtractorStyle
TextExtractorWord
TextMarkupAnnot
TextSearch
UnderlineAnnot
ViewChangeCollection
WatermarkAnnot
WidgetAnnot
WebViewer
AnnotationEditTool
AnnotationSelectTool
AreaMeasurementCreateTool
ArrowCreateTool
CalloutCreateTool
DistanceMeasurementCreateTool
EllipseCreateTool
EraserTool
FreeHandCreateTool
FreeTextCreateTool
GenericAnnotationCreateTool
LineCreateTool
MarqueeZoomTool
PanTool
PerimeterMeasurementCreateTool
PolygonCloudCreateTool
PolygonCreateTool
PolylineCreateTool
RectangleCreateTool
RedactionCreateTool
SignatureCreateTool
StampCreateTool
StickyCreateTool
TextAnnotationCreateTool
TextHighlightCreateTool
TextSelectTool
TextSquigglyCreateTool
TextStrikeoutCreateTool
TextTool
TextUnderlineCreateTool
Tool
eventHandler
WebViewer
Header

Namespaces

Actions
Annotations
CoreControls
PartRetrievers
PDFNet
Tools
utils

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

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'

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

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
evt object

Event object
annotation object <optional>

The annotation that needs to have its permissions updated

blackBoxAnnotationsDisabled

Triggered when collaboration has abruptly closed or been disabled. Attach like bbAnnotManager.on('blackBoxAnnotationsDisabled', callback)

Parameters:
Name Type Description
evt object

Event object

blackBoxAnnotationsEnabled

Triggered when collaboration is enabled for blackbox. Attach like bbAnnotManager.on('blackBoxAnnotationsEnabled', callback)

Parameters:
Name Type Description
event object

Event object
the string

user name as specified by blackbox collaboration.
the string

user ID as specified by blackbox collaboration.

colorSeparationAdded

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

Parameters:
Name Type Description
evt object

jQuery's event object
colorData object

An object with properties of the color separation

Properties
Name Type Description
name string

The name of the color separation
rgb array

An array containing the R, G and B values for the separation

annotationsLoaded

Triggered when all the document annotations have been loaded

Parameters:
Name Type Description
evt object

jQuery's event object

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

click

Triggered for the click 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

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 a new document has been loaded

Parameters:
Name Type Description
evt object

jQuery's event object

documentUnloaded

Triggered when the current document has been closed and unloaded

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

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

searchInProgress

Triggered when a search starts or ends

Parameters:
Name Type Description
evt object

jQuery's event object
inProgress boolean

Whether a search is in progress or not
isFullSearch boolean

Whether this is a full text search or not

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

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
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
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: