Skip to main content
Version: Version 5

Type Alias: DocumentEventMap

DocumentEventMap = object

Event map for document events.

Properties

annotationAdded

annotationAdded: (annotation) => void

Fired when an annotation is added to the document.

Parameters

annotation

Annotation

The annotation that was added.

Returns

void


annotationDeleted

annotationDeleted: (annotation) => void

Fired when an annotation is deleted from the document.

Parameters

annotation

Annotation

The annotation that was deleted.

Returns

void


annotationUpdated

annotationUpdated: (annotation) => void

Fired when an annotation is updated in the document.

Parameters

annotation

Annotation

The annotation that was updated.

Returns

void


changed

changed: () => void

Fired when the document has been modified.

Returns

void


opened

opened: (inputDocument) => void

Fired when a document is opened.

Parameters

inputDocument

InputFile | InputUri

The input document that was opened.

Returns

void


pageRendered

pageRendered: (pageNumber) => void

Fired when a page has been rendered.

Parameters

pageNumber

number

The number of the page that was rendered.

Returns

void


pageRotated

pageRotated: (pageNumber, rotation) => void

Fired when a page has been rotated.

Parameters

pageNumber

number

The number of the page that was rotated.

rotation

Rotation

The new rotation value of the page.

Returns

void


printCompleted

printCompleted: () => void

Fired when document printing has completed successfully.

Returns

void


printFailed

printFailed: (error) => void

Fired when document printing has failed.

Parameters

error

Error

The error that caused the print to fail.

Returns

void


printStarted

printStarted: () => void

Fired when document printing has started.

Returns

void