Skip to main content
Version: Version 5 beta

Type Alias: EventMap

EventMap = object

Global event map combining all domain event maps with full event paths. Used for the main viewer’s addEventListener/removeEventListener.

Properties

PdfTools.document.annotationAdded()

PdfTools.document.annotationAdded: (annotation) => void

Fired when an annotation is added to the document.

Parameters

annotation

Annotation

Returns

void


PdfTools.document.annotationDeleted()

PdfTools.document.annotationDeleted: (annotation) => void

Fired when an annotation is deleted from the document.

Parameters

annotation

Annotation

Returns

void


PdfTools.document.annotationUpdated()

PdfTools.document.annotationUpdated: (annotation) => void

Fired when an annotation is updated in the document.

Parameters

annotation

Annotation

Returns

void


PdfTools.document.opened()

PdfTools.document.opened: (inputDocument) => void

Fired when a document is opened.

Parameters

inputDocument

InputFile | InputUri

Returns

void


PdfTools.document.printCompleted()

PdfTools.document.printCompleted: () => void

Fired when document printing has completed successfully.

Returns

void


PdfTools.document.printFailed()

PdfTools.document.printFailed: (error) => void

Fired when document printing has failed.

Parameters

error

Error

Returns

void


PdfTools.document.printStarted()

PdfTools.document.printStarted: () => void

Fired when document printing has started.

Returns

void


PdfTools.documentView.clicked()

PdfTools.documentView.clicked: (pageNumber, point) => void

Fired when the document view is clicked.

Parameters

pageNumber

number

point

Point

Returns

void


PdfTools.documentView.doubleclicked()

PdfTools.documentView.doubleclicked: (pageNumber, point) => void

Fired when the document view is double-clicked.

Parameters

pageNumber

number

point

Point

Returns

void


PdfTools.documentView.fitModeChanged()

PdfTools.documentView.fitModeChanged: (fitMode) => void

Fired when the fit mode changes.

Parameters

fitMode

FitMode

Returns

void


PdfTools.documentView.pageChanged()

PdfTools.documentView.pageChanged: (pageNumber) => void

Fired when the current page changes.

Parameters

pageNumber

number

Returns

void


PdfTools.documentView.pageModeChanged()

PdfTools.documentView.pageModeChanged: (pageMode) => void

Fired when the page layout mode changes.

Parameters

pageMode

PageLayoutMode

Returns

void


PdfTools.documentView.rotated()

PdfTools.documentView.rotated: (rotation) => void

Fired when the document view is rotated.

Parameters

rotation

Rotation

Returns

void


PdfTools.documentView.setCursor()

PdfTools.documentView.setCursor: (cursor) => void

Fired when the cursor style is changed.

Parameters

cursor

Cursor

Returns

void


PdfTools.documentView.zoomChanged()

PdfTools.documentView.zoomChanged: (zoom) => void

Fired when the zoom level changes.

Parameters

zoom

number

Returns

void


PdfTools.plugins.activated()

PdfTools.plugins.activated: (pluginId) => void

Fired when a plugin is activated.

Parameters

pluginId

string

Returns

void


PdfTools.plugins.deactivated()

PdfTools.plugins.deactivated: (pluginId) => void

Fired when a plugin is deactivated.

Parameters

pluginId

string

Returns

void


PdfTools.plugins.deregistered()

PdfTools.plugins.deregistered: (pluginId) => void

Fired when a plugin is deregistered.

Parameters

pluginId

string

Returns

void


PdfTools.plugins.registered()

PdfTools.plugins.registered: (pluginId) => void

Fired when a plugin is registered.

Parameters

pluginId

string

Returns

void