|
FoxitPDFSDKforWeb
7.1.1
Foxit PDF SDK for Web
|
The namespace that contains PDF objects like PDFDoc, PDFPage, PDFForm. These objects can be accessed by the getter functions of PDFDocRender or PDFViewer instead of those constructors. More...
Modules | |
| coordinates | |
| Collection of coordinates. | |
| annots | |
| constant | |
| form | |
| search | |
Classes | |
| class | PDFBookmark |
| class | PDFDoc |
| class | PDFPage |
Enumerations | |
| enum | DataEvents { annotationUpdated = 'annotation-updated' , annotationAppearanceUpdated = 'annotation-appearance-updated', annotationReplyAdd = 'annotation-reply-add', annotationReviewStateAnnotAdd = 'annotation-review-state-annot-add', annotationMarkedStateAnnotAdd = 'annotation-marked-state-annot-add', annotationStatesCleared = 'annotation-states-cleared', annotationRemoved = 'annotation-removed', annotationMovedPosition = 'annotation-moved-position', annotationAdd = 'annotation-add', annotationImported = 'annotation-imported', actionUpdated ='action-updated', actionAdd ='action-add' , layerVisibleChange = 'layer-visible-change', bookmarkAdded = 'bookmark-added', bookmarkUpdated = 'bookmark-updated', bookmarkRemoved = 'bookmark-removed', stateAnnotNameUpdated = 'state-annot-name-updated', pageInfoChange = 'page-info-change', pageRotationChange = 'page-rotation-change' , drmEncryptSuccess = "drm-encrypt-success", drmEncryptFailed = "drm-encrypt-failed" } |
| PDF data engine's event type. More... | |
Variables | |
| const | Error_Code |
| Enumeration for error code. | |
The namespace that contains PDF objects like PDFDoc, PDFPage, PDFForm. These objects can be accessed by the getter functions of PDFDocRender or PDFViewer instead of those constructors.
| enum DataEvents |
PDF data engine's event type.
| Enumerator | |
|---|---|
| annotationUpdated | If an annotation is updated, an event with this type will be triggered. function example (pdfViewer, DataEvents) { pdfViewer.eventEmitter.on(DataEvents.annotationUpdated, (annots) => { //do something with annotations updated. }) } |
| annotationAppearanceUpdated | If an annotation's appearance is updated, an event with this type will be triggered. function example (pdfViewer, DataEvents) { pdfViewer.eventEmitter.on(DataEvents.annotationAppearanceUpdated, (annots) => { //do something with annotations updated. }) } |
| annotationReplyAdd | If an reply annotation is added, an event with this type will be triggered. function example (pdfViewer, DataEvents) { pdfViewer.eventEmitter.on(DataEvents.annotationReplyAdd, (replyAnnot) => { //do something with reply annot added. }) } |
| annotationReviewStateAnnotAdd | This event will be triggered after an review state added. function example (pdfViewer, DataEvents) { pdfViewer.eventEmitter.on(DataEvents.annotationReviewStateAnnotAdd, (stateAnnot) => { // do something after review state annot added }) } |
| annotationMarkedStateAnnotAdd | This event will be triggered after an marked state added. function example (pdfViewer, DataEvents) { pdfViewer.eventEmitter.on(DataEvents.annotationReviewStateAnnotAdd, (stateAnnot) => { // do something after marked state annot added }) } |
| annotationStatesCleared | This event will be triggered after all states removed. function example (pdfViewer, DataEvents) { pdfViewer.eventEmitter.on(DataEvents.annotationStatesCleared, (stateAnnot) => { // do something after all states removed }) } |
| annotationRemoved | If some annotations are removed, an event with this type will be triggered. function example (pdfViewer, DataEvents) { pdfViewer.eventEmitter.on(DataEvents.annotationRemoved, (removedAnnots) => { //do something with annotations removed. }) } |
| annotationMovedPosition | If annotations are moved, an event with this type will be triggered. function example (pdfViewer, DataEvents) { pdfViewer.eventEmitter.on(DataEvents.annotationMovedPosition, (movedAnnots, page, trigger) => { //do something with annotations moved. }) } |
| annotationAdd | If annotations are added, an event with this type will be triggered. function example (pdfViewer, DataEvents) { pdfViewer.eventEmitter.on(DataEvents.annotationAdd, (annotations) => { //do something with annotations added. }) } |
| annotationImported | If annotations are imported, an event with this type will be triggered. function example (pdfViewer, DataEvents) { pdfViewer.eventEmitter.on(DataEvents.annotationImported, (PDFDoc) => { //do something. }) } |
| actionUpdated | If the action of the annotation is updated, an event with this type will be triggered. function example (pdfViewer, DataEvents) { pdfViewer.eventEmitter.on(DataEvents.actionUpdated, (annot) => { //do something with annotation. }) } |
| actionAdd | If annotation added an action, an event with this type will be triggered. function example (pdfViewer, DataEvents) { pdfViewer.eventEmitter.on(DataEvents.actionAdd, (annot) => { //do something with annotation. }) } |
| layerVisibleChange | If visibility of a layer node is changed, an event with this type will be triggered. function example (pdfViewer, DataEvents) { pdfViewer.eventEmitter.on(DataEvents.layerVisibleChange, (PDFDoc) => { //do something. }) } |
| bookmarkAdded | If bookmark has been added, an event with this type will be triggered. function example (pdfViewer, DataEvents) { pdfViewer.eventEmitter.on(DataEvents.bookmarkAdded, (bookmark) => { //do something. }) } |
| bookmarkUpdated | If bookmark has been updated, an event with this type will be triggered. function example (pdfViewer, DataEvents) { pdfViewer.eventEmitter.on(DataEvents.bookmarkUpdated, (bookmark) => { //do something. }) } |
| bookmarkRemoved | If bookmark has been removed, an event with this type will be triggered. function example (pdfViewer, DataEvents) { pdfViewer.eventEmitter.on(DataEvents.bookmarkRemoved, (removedBookmarkId) => { //do something. }) } |
| stateAnnotNameUpdated | This event will be triggered when name of a state annotation been updated. function example (pdfViewer, DataEvents) { pdfViewer.eventEmitter.on(DataEvents.stateAnnotNameUpdated, (PDFDoc) => { //do something. }) } |
| pageInfoChange | Triggered when the page info changes. eg= width, height, rotation. function example (pdfViewer, DataEvents) { pdfViewer.eventEmitter.on(DataEvents.pageInfoChange, (PDFPage) => { //do something. }) } |
| pageRotationChange | Triggered when the page Angle changes. function example (pdfViewer, DataEvents) { pdfViewer.eventEmitter.on(DataEvents.pageRotationChange, (PDFPage, newRotaion, oldRotaion) => { //do something. }) } |
| drmEncryptSuccess | Triggered when the document DRM encryption is successful. function example (pdfViewer, DataEvents) { pdfViewer.eventEmitter.on(DataEvents.drmEncryptSuccess, (PDFDoc) => { //do something. }) } |
| drmEncryptFailed | Triggered when the document DRM encryption is fail. function example (pdfViewer, DataEvents) { pdfViewer.eventEmitter.on(DataEvents.drmEncryptFailed, (PDFDoc) => { //do something. }) } |