ComPDFKit Web SDK
    Preparing search index...

    Interface ViewerEvents

    Events fired by DocumentViewer, with their listener arguments.

    interface ViewerEvents {
        activeSearchResultChanged: [result: SearchResult];
        annotationsLoaded: [];
        beforeDocumentLoaded: [];
        beforePermissionAction: [
            request: (
                | { action: "copy"
                | "tool"
                | "contentEdit" }
                | { action: "annotation" } & AnnotationPermissionTarget
            ) & { preventDefault: () => void; toolName?: string },
        ];
        beginRendering: [];
        bookmarksUpdated: [];
        budgetPressure: [
            info: {
                kind: "text"
                | "appearance"
                | "canvas";
                limit: number;
                used: number;
            },
        ];
        click: [e: PointerEvent];
        compareAnnotationsLoaded: [
            doc1Annotations: Core.Annotations.Annotation[],
            doc2Annotations: Core.Annotations.Annotation[],
            diffCount: number,
        ];
        dblClick: [e: PointerEvent];
        displayModeUpdated: [mode: DisplayMode];
        displayPageLocation: [pageNumber: number, x: number, y: number];
        documentLoaded: [];
        documentUnloaded: [];
        endOfDocumentResult: [reached: boolean];
        finishedRendering: [];
        fitModeUpdated: [mode: Core.FitMode];
        keyDown: [e: KeyboardEvent];
        keyUp: [e: KeyboardEvent];
        longTap: [e: PointerEvent];
        mouseEnter: [e: PointerEvent];
        mouseLeave: [e: PointerEvent];
        mouseLeftDown: [e: PointerEvent];
        mouseLeftUp: [e: PointerEvent];
        mouseMove: [e: PointerEvent];
        mouseRightDown: [e: PointerEvent];
        mouseRightUp: [e: PointerEvent];
        pageComplete: [pageNumber: number, canvas: HTMLCanvasElement];
        pageNumberUpdated: [pageNumber: number];
        pagesUpdated: [changes: PageChanges];
        rotationUpdated: [rotation: number, pageNumber?: number];
        searchInProgress: [inProgress: boolean];
        searchResultsChanged: [results: SearchResult[]];
        tap: [e: PointerEvent];
        textSelected: [
            quads: Core.Annotations.Quad[]
            | null,
            text: string,
            pageNumber?: number,
        ];
        toolModeUpdated: [next: Tool, prev: Tool];
        toolUpdated: [tool: Tool];
        userBookmarksChanged: [
            bookmarks: Record<number, string>,
            changes: { added: number[]; removed: number[]; updated: number[] },
        ];
        visiblePagesChanged: [pageNumbers: number[]];
        zoomUpdated: [zoom: number];
    }
    Index
    activeSearchResultChanged: [result: SearchResult]

    The active search result changed.

    annotationsLoaded: []

    The annotations of the document have been loaded.

    const { documentViewer, annotationManager } = instance.Core;
    documentViewer.addEventListener('annotationsLoaded', () => {
    console.log(annotationManager.getAnnotationsList().length);
    });
    beforeDocumentLoaded: []

    A document is about to load.

    beforePermissionAction: [
        request: (
            | { action: "copy"
            | "tool"
            | "contentEdit" }
            | { action: "annotation" } & AnnotationPermissionTarget
        ) & { preventDefault: () => void; toolName?: string },
    ]

    Synchronous veto at real action entry; Core itself has no document-permission policy/cache.

    beginRendering: []

    Page rendering started after a period with nothing rendering.

    bookmarksUpdated: []

    The document outline changed (forwarded from Document bookmarksUpdated)

    budgetPressure: [
        info: {
            kind: "text"
            | "appearance"
            | "canvas";
            limit: number;
            used: number;
        },
    ]

    Budget warning: appearance / canvas / text caches approaching their limits

    click: [e: PointerEvent]

    Click in the viewer.

    compareAnnotationsLoaded: [
        doc1Annotations: Core.Annotations.Annotation[],
        doc2Annotations: Core.Annotations.Annotation[],
        diffCount: number,
    ]

    startSemanticDiff finished: difference annotations of both sides and the number of differences

    dblClick: [e: PointerEvent]

    Double click in the viewer.

    displayModeUpdated: [mode: DisplayMode]

    The display mode changed.

    displayPageLocation: [pageNumber: number, x: number, y: number]

    displayPageLocation was called; receives the page number and the horizontal and vertical offsets.

    documentLoaded: []

    A document finished loading and is shown.

    const { documentViewer } = instance.Core;
    documentViewer.addEventListener('documentLoaded', () => {
    console.log(documentViewer.getDocument().getFilename());
    });
    documentUnloaded: []

    The document was closed.

    endOfDocumentResult: [reached: boolean]

    Fired by the UI when a one-by-one search (fullSearch: false) reaches the end (same name as the UI searchText event, argument always true)

    finishedRendering: []

    All pending page renders finished.

    fitModeUpdated: [mode: Core.FitMode]

    The fit mode changed.

    keyDown: [e: KeyboardEvent]

    Key pressed while the viewer has focus.

    keyUp: [e: KeyboardEvent]

    Key released while the viewer has focus.

    longTap: [e: PointerEvent]

    Touch or pen held in place for a long press.

    mouseEnter: [e: PointerEvent]

    Pointer entered the viewer.

    mouseLeave: [e: PointerEvent]

    Pointer left the viewer.

    mouseLeftDown: [e: PointerEvent]

    Left button or primary pointer pressed in the viewer.

    mouseLeftUp: [e: PointerEvent]

    Left button or primary pointer released in the viewer.

    mouseMove: [e: PointerEvent]

    Pointer moved in the viewer.

    mouseRightDown: [e: PointerEvent]

    Right button pressed in the viewer.

    mouseRightUp: [e: PointerEvent]

    Right button released in the viewer.

    pageComplete: [pageNumber: number, canvas: HTMLCanvasElement]

    A page finished rendering; receives the page number and its canvas.

    pageNumberUpdated: [pageNumber: number]

    The current page changed.

    const { documentViewer } = instance.Core;
    documentViewer.addEventListener('pageNumberUpdated', (pageNumber) => {
    console.log(`Current page: ${pageNumber}`);
    });
    pagesUpdated: [changes: PageChanges]

    The page structure changed (forwarded from Document.pagesUpdated; view and annotations already updated to the new page order)

    rotationUpdated: [rotation: number, pageNumber?: number]

    The view rotation changed, for one page when a page number is given.

    searchInProgress: [inProgress: boolean]

    A search started (true) or stopped (false).

    searchResultsChanged: [results: SearchResult[]]

    The list of search results changed.

    tap: [e: PointerEvent]

    Short press and release without moving.

    textSelected: [
        quads: Core.Annotations.Quad[]
        | null,
        text: string,
        pageNumber?: number,
    ]

    The text selection changed; quads are null when the selection was cleared.

    const { documentViewer } = instance.Core;
    documentViewer.addEventListener('textSelected', (quads, text, pageNumber) => {
    if (quads)
    console.log(pageNumber, text);
    });
    toolModeUpdated: [next: Tool, prev: Tool]

    The current tool changed; receives the new and the previous tool.

    toolUpdated: [tool: Tool]

    A tool's settings changed.

    userBookmarksChanged: [
        bookmarks: Record<number, string>,
        changes: { added: number[]; removed: number[]; updated: number[] },
    ]

    User bookmarks changed: all bookmarks (page index → text) and this change's additions, modifications and deletions (page indexes)

    visiblePagesChanged: [pageNumbers: number[]]

    The set of visible pages changed.

    zoomUpdated: [zoom: number]

    The zoom level changed.

    const { documentViewer } = instance.Core;
    documentViewer.addEventListener('zoomUpdated', (zoom) => {
    console.log(`Zoom: ${Math.round(zoom * 100)}%`);
    });