@divriots/pdfjs-dist 3.10.111-divriots2.0

package/types/web/pdf_page_view.d.ts

@@ -0,0 +1,209 @@
+export type PageViewport = import("../src/display/display_utils").PageViewport;
+export type OptionalContentConfig = import("../src/display/optional_content_config").OptionalContentConfig;
+export type EventBus = import("./event_utils").EventBus;
+export type IL10n = import("./interfaces").IL10n;
+export type IRenderableView = import("./interfaces").IRenderableView;
+export type PDFRenderingQueue = import("./pdf_rendering_queue").PDFRenderingQueue;
+export type PDFPageViewOptions = {
+    /**
+     * - The viewer element.
+     */
+    container?: HTMLDivElement | undefined;
+    /**
+     * - The application event bus.
+     */
+    eventBus: EventBus;
+    /**
+     * - The page unique ID (normally its number).
+     */
+    id: number;
+    /**
+     * - The page scale display.
+     */
+    scale?: number | undefined;
+    /**
+     * - The page viewport.
+     */
+    defaultViewport: PageViewport;
+    /**
+     * -
+     * A promise that is resolved with an {@link OptionalContentConfig } instance.
+     * The default value is `null`.
+     */
+    optionalContentConfigPromise?: Promise<import("../src/display/optional_content_config").OptionalContentConfig> | undefined;
+    /**
+     * - The rendering queue object.
+     */
+    renderingQueue?: import("./pdf_rendering_queue").PDFRenderingQueue | undefined;
+    /**
+     * - Controls if the text layer used for
+     * selection and searching is created. The constants from {TextLayerMode}
+     * should be used. The default value is `TextLayerMode.ENABLE`.
+     */
+    textLayerMode?: number | undefined;
+    /**
+     * - Controls if the annotation layer is
+     * created, and if interactive form elements or `AnnotationStorage`-data are
+     * being rendered. The constants from {@link AnnotationMode } should be used;
+     * see also {@link RenderParameters } and {@link GetOperatorListParameters }.
+     * The default value is `AnnotationMode.ENABLE_FORMS`.
+     */
+    annotationMode?: number | undefined;
+    /**
+     * - Path for image resources, mainly
+     * for annotation icons. Include trailing slash.
+     */
+    imageResourcesPath?: string | undefined;
+    /**
+     * - Allows to use an
+     * OffscreenCanvas if needed.
+     */
+    isOffscreenCanvasSupported?: boolean | undefined;
+    /**
+     * - The maximum supported canvas size in
+     * total pixels, i.e. width * height. Use `-1` for no limit, or `0` for
+     * CSS-only zooming. The default value is 4096 * 4096 (16 mega-pixels).
+     */
+    maxCanvasPixels?: number | undefined;
+    /**
+     * - Overwrites background and foreground colors
+     * with user defined ones in order to improve readability in high contrast
+     * mode.
+     */
+    pageColors?: Object | undefined;
+    /**
+     * - Localization service.
+     */
+    l10n?: import("./interfaces").IL10n | undefined;
+    /**
+     * - The function that is used to lookup
+     * the necessary layer-properties.
+     */
+    layerProperties?: Function | undefined;
+};
+/**
+ * @implements {IRenderableView}
+ */
+export class PDFPageView implements IRenderableView {
+    /**
+     * @param {PDFPageViewOptions} options
+     */
+    constructor(options: PDFPageViewOptions);
+    id: number;
+    renderingId: string;
+    pdfPage: any;
+    pageLabel: string | null;
+    rotation: number;
+    scale: number;
+    viewport: import("../src/display/display_utils").PageViewport;
+    pdfPageRotate: number;
+    _optionalContentConfigPromise: Promise<import("../src/display/optional_content_config").OptionalContentConfig> | null;
+    imageResourcesPath: string;
+    isOffscreenCanvasSupported: boolean;
+    maxCanvasPixels: any;
+    pageColors: Object | null;
+    eventBus: import("./event_utils").EventBus;
+    renderingQueue: import("./pdf_rendering_queue").PDFRenderingQueue | undefined;
+    l10n: {
+        getLanguage(): Promise<string>;
+        getDirection(): Promise<string>;
+        get(key: any, args?: null, fallback?: any): Promise<any>;
+        translate(element: any): Promise<void>;
+    };
+    renderTask: any;
+    resume: (() => void) | null;
+    _isStandalone: boolean | undefined;
+    _container: HTMLDivElement | undefined;
+    _annotationCanvasMap: any;
+    annotationLayer: AnnotationLayerBuilder | null;
+    annotationEditorLayer: AnnotationEditorLayerBuilder | null;
+    textLayer: TextLayerBuilder | null;
+    zoomLayer: ParentNode | null;
+    xfaLayer: XfaLayerBuilder | null;
+    structTreeLayer: any;
+    div: HTMLDivElement;
+    set renderingState(arg: number);
+    get renderingState(): number;
+    setPdfPage(pdfPage: any): void;
+    destroy(): void;
+    get _textHighlighter(): any;
+    /**
+     * @private
+     */
+    private _resetZoomLayer;
+    reset({ keepZoomLayer, keepAnnotationLayer, keepAnnotationEditorLayer, keepXfaLayer, keepTextLayer, }?: {
+        keepZoomLayer?: boolean | undefined;
+        keepAnnotationLayer?: boolean | undefined;
+        keepAnnotationEditorLayer?: boolean | undefined;
+        keepXfaLayer?: boolean | undefined;
+        keepTextLayer?: boolean | undefined;
+    }): void;
+    /**
+     * @typedef {Object} PDFPageViewUpdateParameters
+     * @property {number} [scale] The new scale, if specified.
+     * @property {number} [rotation] The new rotation, if specified.
+     * @property {Promise<OptionalContentConfig>} [optionalContentConfigPromise]
+     *   A promise that is resolved with an {@link OptionalContentConfig}
+     *   instance. The default value is `null`.
+     * @property {number} [drawingDelay]
+     */
+    /**
+     * Update e.g. the scale and/or rotation of the page.
+     * @param {PDFPageViewUpdateParameters}
+     */
+    update({ scale, rotation, optionalContentConfigPromise, drawingDelay, }: {
+        /**
+         * The new scale, if specified.
+         */
+        scale?: number | undefined;
+        /**
+         * The new rotation, if specified.
+         */
+        rotation?: number | undefined;
+        /**
+         * A promise that is resolved with an {@link OptionalContentConfig }instance. The default value is `null`.
+         */
+        optionalContentConfigPromise?: Promise<import("../src/display/optional_content_config").OptionalContentConfig> | undefined;
+        drawingDelay?: number | undefined;
+    }): void;
+    /**
+     * PLEASE NOTE: Most likely you want to use the `this.reset()` method,
+     *              rather than calling this one directly.
+     */
+    cancelRendering({ keepAnnotationLayer, keepAnnotationEditorLayer, keepXfaLayer, keepTextLayer, cancelExtraDelay, }?: {
+        keepAnnotationLayer?: boolean | undefined;
+        keepAnnotationEditorLayer?: boolean | undefined;
+        keepXfaLayer?: boolean | undefined;
+        keepTextLayer?: boolean | undefined;
+        cancelExtraDelay?: number | undefined;
+    }): void;
+    cssTransform({ target, redrawAnnotationLayer, redrawAnnotationEditorLayer, redrawXfaLayer, redrawTextLayer, hideTextLayer, }: {
+        target: any;
+        redrawAnnotationLayer?: boolean | undefined;
+        redrawAnnotationEditorLayer?: boolean | undefined;
+        redrawXfaLayer?: boolean | undefined;
+        redrawTextLayer?: boolean | undefined;
+        hideTextLayer?: boolean | undefined;
+    }): void;
+    get width(): number;
+    get height(): number;
+    getPagePoint(x: any, y: any): any[];
+    draw(): Promise<any>;
+    canvas: HTMLCanvasElement | undefined;
+    outputScale: OutputScale | undefined;
+    /**
+     * @param {string|null} label
+     */
+    setPageLabel(label: string | null): void;
+    /**
+     * For use by the `PDFThumbnailView.setImage`-method.
+     * @ignore
+     */
+    get thumbnailCanvas(): HTMLCanvasElement | null | undefined;
+    #private;
+}
+import { AnnotationLayerBuilder } from "./annotation_layer_builder.js";
+import { AnnotationEditorLayerBuilder } from "./annotation_editor_layer_builder.js";
+import { TextLayerBuilder } from "./text_layer_builder.js";
+import { XfaLayerBuilder } from "./xfa_layer_builder.js";
+import { OutputScale } from "./ui_utils.js";

package/types/web/pdf_rendering_queue.d.ts

@@ -0,0 +1,53 @@
+export type IRenderableView = import("./interfaces").IRenderableView;
+export type PDFViewer = import("./pdf_viewer").PDFViewer;
+export type PDFThumbnailViewer = import("./pdf_thumbnail_viewer").PDFThumbnailViewer;
+/**
+ * Controls rendering of the views for pages and thumbnails.
+ */
+export class PDFRenderingQueue {
+    pdfViewer: import("./pdf_viewer").PDFViewer | null;
+    pdfThumbnailViewer: import("./pdf_thumbnail_viewer").PDFThumbnailViewer | null;
+    onIdle: any;
+    highestPriorityPage: string | null;
+    /** @type {number} */
+    idleTimeout: number;
+    printing: boolean;
+    isThumbnailViewEnabled: boolean;
+    /**
+     * @param {PDFViewer} pdfViewer
+     */
+    setViewer(pdfViewer: PDFViewer): void;
+    /**
+     * @param {PDFThumbnailViewer} pdfThumbnailViewer
+     */
+    setThumbnailViewer(pdfThumbnailViewer: PDFThumbnailViewer): void;
+    /**
+     * @param {IRenderableView} view
+     * @returns {boolean}
+     */
+    isHighestPriority(view: IRenderableView): boolean;
+    /**
+     * @param {Object} currentlyVisiblePages
+     */
+    renderHighestPriority(currentlyVisiblePages: Object): void;
+    /**
+     * @param {Object} visible
+     * @param {Array} views
+     * @param {boolean} scrolledDown
+     * @param {boolean} [preRenderExtra]
+     */
+    getHighestPriority(visible: Object, views: any[], scrolledDown: boolean, preRenderExtra?: boolean | undefined): any;
+    /**
+     * @param {IRenderableView} view
+     * @returns {boolean}
+     */
+    isViewFinished(view: IRenderableView): boolean;
+    /**
+     * Render a page or thumbnail view. This calls the appropriate function
+     * based on the views state. If the view is already rendered it will return
+     * `false`.
+     *
+     * @param {IRenderableView} view
+     */
+    renderView(view: IRenderableView): boolean;
+}

package/types/web/pdf_scripting_manager.component.d.ts

@@ -0,0 +1,5 @@
+export { PDFScriptingManagerComponents as PDFScriptingManager };
+declare class PDFScriptingManagerComponents extends PDFScriptingManager {
+    constructor(options: any);
+}
+import { PDFScriptingManager } from "./pdf_scripting_manager.js";

package/types/web/pdf_scripting_manager.d.ts

@@ -0,0 +1,61 @@
+export type EventBus = import("./event_utils").EventBus;
+export type PDFScriptingManagerOptions = {
+    /**
+     * - The application event bus.
+     */
+    eventBus: EventBus;
+    /**
+     * - The path and filename of the scripting
+     * bundle.
+     */
+    sandboxBundleSrc: string;
+    /**
+     * - The factory that is used when
+     * initializing scripting; must contain a `createScripting` method.
+     * PLEASE NOTE: Primarily intended for the default viewer use-case.
+     */
+    externalServices?: Object | undefined;
+    /**
+     * - The function that is used to lookup
+     * the necessary document properties.
+     */
+    docProperties?: Function | undefined;
+};
+/**
+ * @typedef {Object} PDFScriptingManagerOptions
+ * @property {EventBus} eventBus - The application event bus.
+ * @property {string} sandboxBundleSrc - The path and filename of the scripting
+ *   bundle.
+ * @property {Object} [externalServices] - The factory that is used when
+ *   initializing scripting; must contain a `createScripting` method.
+ *   PLEASE NOTE: Primarily intended for the default viewer use-case.
+ * @property {function} [docProperties] - The function that is used to lookup
+ *   the necessary document properties.
+ */
+export class PDFScriptingManager {
+    /**
+     * @param {PDFScriptingManagerOptions} options
+     */
+    constructor({ eventBus, sandboxBundleSrc, externalServices, docProperties, }: PDFScriptingManagerOptions);
+    setViewer(pdfViewer: any): void;
+    setDocument(pdfDocument: any): Promise<void>;
+    dispatchWillSave(): Promise<any>;
+    dispatchDidSave(): Promise<any>;
+    dispatchWillPrint(): Promise<void>;
+    dispatchDidPrint(): Promise<any>;
+    get destroyPromise(): any;
+    get ready(): boolean;
+    /**
+     * @private
+     */
+    private get _internalEvents();
+    /**
+     * @private
+     */
+    private get _pageOpenPending();
+    /**
+     * @private
+     */
+    private get _visitedPages();
+    #private;
+}

package/types/web/pdf_single_page_viewer.d.ts

@@ -0,0 +1,7 @@
+export class PDFSinglePageViewer extends PDFViewer {
+    set scrollMode(arg: any);
+    _updateScrollMode(): void;
+    set spreadMode(arg: any);
+    _updateSpreadMode(): void;
+}
+import { PDFViewer } from "./pdf_viewer.js";

package/types/web/pdf_thumbnail_view.d.ts

@@ -0,0 +1,131 @@
+export type EventBus = import("./event_utils").EventBus;
+export type IL10n = import("./interfaces").IL10n;
+export type IPDFLinkService = import("./interfaces").IPDFLinkService;
+export type IRenderableView = import("./interfaces").IRenderableView;
+export type PDFRenderingQueue = import("./pdf_rendering_queue").PDFRenderingQueue;
+export type PDFThumbnailViewOptions = {
+    /**
+     * - The viewer element.
+     */
+    container: HTMLDivElement;
+    /**
+     * - The application event bus.
+     */
+    eventBus: EventBus;
+    /**
+     * - The thumbnail's unique ID (normally its number).
+     */
+    id: number;
+    /**
+     * - The page viewport.
+     */
+    defaultViewport: PageViewport;
+    /**
+     * -
+     * A promise that is resolved with an {@link OptionalContentConfig } instance.
+     * The default value is `null`.
+     */
+    optionalContentConfigPromise?: Promise<OptionalContentConfig> | undefined;
+    /**
+     * - The navigation/linking service.
+     */
+    linkService: IPDFLinkService;
+    /**
+     * - The rendering queue object.
+     */
+    renderingQueue: PDFRenderingQueue;
+    /**
+     * - Localization service.
+     */
+    l10n: IL10n;
+    /**
+     * - Overwrites background and foreground colors
+     * with user defined ones in order to improve readability in high contrast
+     * mode.
+     */
+    pageColors?: Object | undefined;
+};
+/**
+ * @implements {IRenderableView}
+ */
+export class PDFThumbnailView implements IRenderableView {
+    /**
+     * @param {PDFThumbnailViewOptions} options
+     */
+    constructor({ container, eventBus, id, defaultViewport, optionalContentConfigPromise, linkService, renderingQueue, l10n, pageColors, }: PDFThumbnailViewOptions);
+    id: number;
+    renderingId: string;
+    pageLabel: string | null;
+    pdfPage: any;
+    rotation: number;
+    viewport: PageViewport;
+    pdfPageRotate: any;
+    _optionalContentConfigPromise: Promise<OptionalContentConfig> | null;
+    pageColors: Object | null;
+    eventBus: import("./event_utils").EventBus;
+    linkService: import("./interfaces").IPDFLinkService;
+    renderingQueue: import("./pdf_rendering_queue").PDFRenderingQueue;
+    renderTask: any;
+    renderingState: number;
+    resume: (() => void) | null;
+    l10n: import("./interfaces").IL10n;
+    anchor: HTMLAnchorElement;
+    div: HTMLDivElement;
+    _placeholderImg: HTMLDivElement;
+    canvasWidth: number | undefined;
+    canvasHeight: number | undefined;
+    scale: number | undefined;
+    setPdfPage(pdfPage: any): void;
+    reset(): void;
+    update({ rotation }: {
+        rotation?: null | undefined;
+    }): void;
+    /**
+     * PLEASE NOTE: Most likely you want to use the `this.reset()` method,
+     *              rather than calling this one directly.
+     */
+    cancelRendering(): void;
+    /**
+     * @private
+     */
+    private _getPageDrawContext;
+    /**
+     * @private
+     */
+    private _convertCanvasToImage;
+    image: HTMLImageElement | undefined;
+    draw(): Promise<any>;
+    setImage(pageView: any): void;
+    /**
+     * @private
+     */
+    private _reduceImage;
+    get _thumbPageTitle(): Promise<string>;
+    get _thumbPageCanvas(): Promise<string>;
+    /**
+     * @param {string|null} label
+     */
+    setPageLabel(label: string | null): void;
+    #private;
+}
+/**
+ * @typedef {Object} PDFThumbnailViewOptions
+ * @property {HTMLDivElement} container - The viewer element.
+ * @property {EventBus} eventBus - The application event bus.
+ * @property {number} id - The thumbnail's unique ID (normally its number).
+ * @property {PageViewport} defaultViewport - The page viewport.
+ * @property {Promise<OptionalContentConfig>} [optionalContentConfigPromise] -
+ *   A promise that is resolved with an {@link OptionalContentConfig} instance.
+ *   The default value is `null`.
+ * @property {IPDFLinkService} linkService - The navigation/linking service.
+ * @property {PDFRenderingQueue} renderingQueue - The rendering queue object.
+ * @property {IL10n} l10n - Localization service.
+ * @property {Object} [pageColors] - Overwrites background and foreground colors
+ *   with user defined ones in order to improve readability in high contrast
+ *   mode.
+ */
+export class TempImageFactory {
+    static "__#51@#tempCanvas": null;
+    static getCanvas(width: any, height: any): (HTMLCanvasElement | CanvasRenderingContext2D | null)[];
+    static destroyCanvas(): void;
+}

package/types/web/pdf_thumbnail_viewer.d.ts

@@ -0,0 +1,104 @@
+export type PDFDocumentProxy = import("../src/display/api").PDFDocumentProxy;
+export type EventBus = import("./event_utils").EventBus;
+export type IL10n = import("./interfaces").IL10n;
+export type IPDFLinkService = import("./interfaces").IPDFLinkService;
+export type PDFRenderingQueue = import("./pdf_rendering_queue").PDFRenderingQueue;
+export type PDFThumbnailViewerOptions = {
+    /**
+     * - The container for the thumbnail
+     * elements.
+     */
+    container: HTMLDivElement;
+    /**
+     * - The application event bus.
+     */
+    eventBus: EventBus;
+    /**
+     * - The navigation/linking service.
+     */
+    linkService: IPDFLinkService;
+    /**
+     * - The rendering queue object.
+     */
+    renderingQueue: PDFRenderingQueue;
+    /**
+     * - Localization service.
+     */
+    l10n: IL10n;
+    /**
+     * - Overwrites background and foreground colors
+     * with user defined ones in order to improve readability in high contrast
+     * mode.
+     */
+    pageColors?: Object | undefined;
+};
+/**
+ * @typedef {Object} PDFThumbnailViewerOptions
+ * @property {HTMLDivElement} container - The container for the thumbnail
+ *   elements.
+ * @property {EventBus} eventBus - The application event bus.
+ * @property {IPDFLinkService} linkService - The navigation/linking service.
+ * @property {PDFRenderingQueue} renderingQueue - The rendering queue object.
+ * @property {IL10n} l10n - Localization service.
+ * @property {Object} [pageColors] - Overwrites background and foreground colors
+ *   with user defined ones in order to improve readability in high contrast
+ *   mode.
+ */
+/**
+ * Viewer control to display thumbnails for pages in a PDF document.
+ */
+export class PDFThumbnailViewer {
+    /**
+     * @param {PDFThumbnailViewerOptions} options
+     */
+    constructor({ container, eventBus, linkService, renderingQueue, l10n, pageColors, }: PDFThumbnailViewerOptions);
+    container: HTMLDivElement;
+    eventBus: import("./event_utils").EventBus;
+    linkService: import("./interfaces").IPDFLinkService;
+    renderingQueue: import("./pdf_rendering_queue").PDFRenderingQueue;
+    l10n: import("./interfaces").IL10n;
+    pageColors: Object | null;
+    scroll: {
+        right: boolean;
+        down: boolean;
+        lastX: any;
+        lastY: any;
+        _eventHandler: (evt: any) => void;
+    };
+    /**
+     * @private
+     */
+    private _scrollUpdated;
+    getThumbnail(index: any): any;
+    /**
+     * @private
+     */
+    private _getVisibleThumbs;
+    scrollThumbnailIntoView(pageNumber: any): void;
+    _currentPageNumber: any;
+    set pagesRotation(arg: any);
+    get pagesRotation(): any;
+    _pagesRotation: any;
+    cleanup(): void;
+    /**
+     * @private
+     */
+    private _resetView;
+    _thumbnails: any[] | undefined;
+    _pageLabels: any[] | null | undefined;
+    /**
+     * @param {PDFDocumentProxy} pdfDocument
+     */
+    setDocument(pdfDocument: PDFDocumentProxy): void;
+    pdfDocument: import("../src/display/api").PDFDocumentProxy | undefined;
+    /**
+     * @private
+     */
+    private _cancelRendering;
+    /**
+     * @param {Array|null} labels
+     */
+    setPageLabels(labels: any[] | null): void;
+    forceRendering(): boolean;
+    #private;
+}

package/types/web/pdf_viewer.component.d.ts

@@ -0,0 +1,24 @@
+import { AnnotationLayerBuilder } from "./annotation_layer_builder.js";
+import { DownloadManager } from "./download_manager.js";
+import { EventBus } from "./event_utils.js";
+import { FindState } from "./pdf_find_controller.js";
+import { GenericL10n } from "./genericl10n.js";
+import { LinkTarget } from "./pdf_link_service.js";
+import { NullL10n } from "./l10n_utils.js";
+import { parseQueryString } from "./ui_utils.js";
+import { PDFFindController } from "./pdf_find_controller.js";
+import { PDFHistory } from "./pdf_history.js";
+import { PDFLinkService } from "./pdf_link_service.js";
+import { PDFPageView } from "./pdf_page_view.js";
+import { PDFScriptingManager } from "./pdf_scripting_manager.component.js";
+import { PDFSinglePageViewer } from "./pdf_single_page_viewer.js";
+import { PDFViewer } from "./pdf_viewer.js";
+import { ProgressBar } from "./ui_utils.js";
+import { RenderingStates } from "./ui_utils.js";
+import { ScrollMode } from "./ui_utils.js";
+import { SimpleLinkService } from "./pdf_link_service.js";
+import { SpreadMode } from "./ui_utils.js";
+import { StructTreeLayerBuilder } from "./struct_tree_layer_builder.js";
+import { TextLayerBuilder } from "./text_layer_builder.js";
+import { XfaLayerBuilder } from "./xfa_layer_builder.js";
+export { AnnotationLayerBuilder, DownloadManager, EventBus, FindState, GenericL10n, LinkTarget, NullL10n, parseQueryString, PDFFindController, PDFHistory, PDFLinkService, PDFPageView, PDFScriptingManager, PDFSinglePageViewer, PDFViewer, ProgressBar, RenderingStates, ScrollMode, SimpleLinkService, SpreadMode, StructTreeLayerBuilder, TextLayerBuilder, XfaLayerBuilder };