ComPDFKit Web SDK
    Preparing search index...

    Variable EventsConst

    Events: {
        ACTIVE_DOCUMENT_VIEWER_CHANGED: "activeDocumentViewerChanged";
        CLOSE_CUSTOM_TEXT_NOTE_PANEL: "closeCustomTextNotePanel";
        FILE_DOWNLOADED: "fileDownloaded";
        FULLSCREEN_MODE_TOGGLED: "fullscreenModeToggled";
        LANGUAGE_CHANGED: "languageChanged";
        LOAD_ERROR: "loaderror";
        MODULAR_UI_IMPORTED: "modularUIImported";
        MULTI_VIEWER_READY: "multiViewerReady";
        NOTE_AUTOSAVED: "wv-note-autosaved";
        OPEN_CUSTOM_TEXT_NOTE_PANEL: "openCustomTextNotePanel";
        PANEL_RESIZED: "panelResized";
        PERMISSION_DENIED: "permissionDenied";
        PERMISSION_VERIFIED: "permissionVerified";
        SELECTED_THUMBNAIL_CHANGED: "selectedThumbnailChanged";
        THEME_CHANGED: "themeChanged";
        TOOLBAR_GROUP_CHANGED: "toolbarGroupChanged";
        TOOLTIP_OPENED: "tooltipOpened";
        TRUSTED_CERTIFICATE_ADDED: "trustedCertificateAdded";
        VIEWER_LOADED: "viewerLoaded";
        VISIBILITY_CHANGED: "visibilityChanged";
    }

    Names of the events of addEventListener. Available as UI.Events.

    Type Declaration

    • ReadonlyACTIVE_DOCUMENT_VIEWER_CHANGED: "activeDocumentViewerChanged"

      The active document viewer changed; the listener receives (newKey, previousKey).

    • ReadonlyCLOSE_CUSTOM_TEXT_NOTE_PANEL: "closeCustomTextNotePanel"

      A custom text note panel should close; the listener receives the note annotation.

    • ReadonlyFILE_DOWNLOADED: "fileDownloaded"

      downloadPdf finished saving the file.

    • ReadonlyFULLSCREEN_MODE_TOGGLED: "fullscreenModeToggled"

      Full-screen mode was entered or left; the listener receives true when entering.

    • ReadonlyLANGUAGE_CHANGED: "languageChanged"

      The language changed; the listener receives (previousLanguage, newLanguage) as language codes.

    • ReadonlyLOAD_ERROR: "loaderror"

      Loading a document failed; the listener receives the error.

    • ReadonlyMODULAR_UI_IMPORTED: "modularUIImported"

      importModularComponents finished applying the imported layout.

    • ReadonlyMULTI_VIEWER_READY: "multiViewerReady"

      The second viewer of the side-by-side view is ready, after enterMultiViewerMode.

    • ReadonlyNOTE_AUTOSAVED: "wv-note-autosaved"

      Note text was saved automatically after typing stopped (only with enableAutosave); the listener receives { annotationId }.

    • ReadonlyOPEN_CUSTOM_TEXT_NOTE_PANEL: "openCustomTextNotePanel"

      A custom text note panel should open; the listener receives the note annotation.

    • ReadonlyPANEL_RESIZED: "panelResized"

      A panel width changed; the listener receives (dataElement, width) with the width in pixels.

    • ReadonlyPERMISSION_DENIED: "permissionDenied"

      An action was refused because the document does not allow it; the listener receives the permission, the action and the viewer key.

    • ReadonlyPERMISSION_VERIFIED: "permissionVerified"

      The owner password was verified; the listener receives the viewer key.

    • ReadonlySELECTED_THUMBNAIL_CHANGED: "selectedThumbnailChanged"

      The selected thumbnails changed; the listener receives the array of selected 0-based page indexes.

    • ReadonlyTHEME_CHANGED: "themeChanged"

      The theme changed; the listener receives the new theme, one of UI.Theme.

    • ReadonlyTOOLBAR_GROUP_CHANGED: "toolbarGroupChanged"

      The active toolbar group changed; the listener receives the new group, one of UI.ToolbarGroup.

    • ReadonlyTOOLTIP_OPENED: "tooltipOpened"

      A tooltip was shown.

    • ReadonlyTRUSTED_CERTIFICATE_ADDED: "trustedCertificateAdded"

      The user added a signer certificate to the trust list from the certificate viewer; the listener receives { fieldName, certificate }, with certificate a copy of the DER bytes. Not fired by UI.VerificationOptions.addTrustedCertificates. The trust list is kept in memory only: store the certificate yourself and pass it to addTrustedCertificates after the viewer loads to trust it again.

    • ReadonlyVIEWER_LOADED: "viewerLoaded"

      The viewer finished loading. Listeners added afterwards are still called once.

    • ReadonlyVISIBILITY_CHANGED: "visibilityChanged"

      An element was opened or closed; the listener receives (dataElement, isVisible).