export type PDFPageProxy = import("../src/display/api").PDFPageProxy; export type PageViewport = import("../src/display/display_utils").PageViewport; export type AnnotationLayerBuilder = import("./annotation_layer_builder").AnnotationLayerBuilder; export type AnnotationEditorLayerBuilder = import("./annotation_editor_layer_builder").AnnotationEditorLayerBuilder; export type EventBus = import("./event_utils").EventBus; export type StructTreeLayerBuilder = any; export type TextHighlighter = import("./text_highlighter").TextHighlighter; export type TextLayerBuilder = import("./text_layer_builder").TextLayerBuilder; export type RenderingStates = any; export type XfaLayerBuilder = import("./xfa_layer_builder").XfaLayerBuilder; export type TextAccessibilityManager = import("./text_accessibility.js").TextAccessibilityManager; /** * @interface */ export class IDownloadManager { /** * @param {string} url * @param {string} filename */ downloadUrl(url: string, filename: string): void; /** * @param {Uint8Array} data * @param {string} filename * @param {string} [contentType] */ downloadData(data: Uint8Array, filename: string, contentType?: string | undefined): void; /** * @param {HTMLElement} element * @param {Uint8Array} data * @param {string} filename * @returns {boolean} Indicating if the data was opened. */ openOrDownloadData(element: HTMLElement, data: Uint8Array, filename: string): boolean; /** * @param {Blob} blob * @param {string} url * @param {string} filename */ download(blob: Blob, url: string, filename: string): void; } /** * @interface */ export class IL10n { /** * @returns {Promise} - Resolves to the current locale. */ getLanguage(): Promise; /** * @returns {Promise} - Resolves to 'rtl' or 'ltr'. */ getDirection(): Promise; /** * Translates text identified by the key and adds/formats data using the args * property bag. If the key was not found, translation falls back to the * fallback text. * @param {string} key * @param {Object | null} [args] * @param {string} [fallback] * @returns {Promise} */ get(key: string, args?: Object | null | undefined, fallback?: string | undefined): Promise; /** * Translates HTML element. * @param {HTMLElement} element * @returns {Promise} */ translate(element: HTMLElement): Promise; } /** * @interface */ export class IPDFAnnotationEditorLayerFactory { /** * @typedef {Object} CreateAnnotationEditorLayerBuilderParameters * @property {AnnotationEditorUIManager} [uiManager] * @property {HTMLDivElement} pageDiv * @property {PDFPageProxy} pdfPage * @property {IL10n} l10n * @property {AnnotationStorage} [annotationStorage] - Storage for annotation * @property {TextAccessibilityManager} [accessibilityManager] * data in forms. */ /** * @param {CreateAnnotationEditorLayerBuilderParameters} * @returns {AnnotationEditorLayerBuilder} */ createAnnotationEditorLayerBuilder({ uiManager, pageDiv, pdfPage, l10n, annotationStorage, accessibilityManager, }: { uiManager?: any; pageDiv: HTMLDivElement; pdfPage: PDFPageProxy; l10n: IL10n; /** * - Storage for annotation */ annotationStorage?: any; /** * data in forms. */ accessibilityManager?: import("./text_accessibility.js").TextAccessibilityManager | undefined; }): AnnotationEditorLayerBuilder; } /** * @interface */ export class IPDFAnnotationLayerFactory { /** * @typedef {Object} CreateAnnotationLayerBuilderParameters * @property {HTMLDivElement} pageDiv * @property {PDFPageProxy} pdfPage * @property {AnnotationStorage} [annotationStorage] - Storage for annotation * data in forms. * @property {string} [imageResourcesPath] - Path for image resources, mainly * for annotation icons. Include trailing slash. * @property {boolean} renderForms * @property {IL10n} l10n * @property {boolean} [enableScripting] * @property {Promise} [hasJSActionsPromise] * @property {Object} [mouseState] * @property {Promise> | null>} * [fieldObjectsPromise] * @property {Map} [annotationCanvasMap] - Map some * annotation ids with canvases used to render them. * @property {TextAccessibilityManager} [accessibilityManager] */ /** * @param {CreateAnnotationLayerBuilderParameters} * @returns {AnnotationLayerBuilder} */ createAnnotationLayerBuilder({ pageDiv, pdfPage, annotationStorage, imageResourcesPath, renderForms, l10n, enableScripting, hasJSActionsPromise, mouseState, fieldObjectsPromise, annotationCanvasMap, accessibilityManager, }: { pageDiv: HTMLDivElement; pdfPage: PDFPageProxy; /** * - Storage for annotation * data in forms. */ annotationStorage?: any; /** * - Path for image resources, mainly * for annotation icons. Include trailing slash. */ imageResourcesPath?: string | undefined; renderForms: boolean; l10n: IL10n; enableScripting?: boolean | undefined; hasJSActionsPromise?: Promise | undefined; mouseState?: Object | undefined; fieldObjectsPromise?: Promise<{ [x: string]: Object[]; } | null> | undefined; /** * - Map some * annotation ids with canvases used to render them. */ annotationCanvasMap?: Map | undefined; accessibilityManager?: import("./text_accessibility.js").TextAccessibilityManager | undefined; }): AnnotationLayerBuilder; } /** @typedef {import("../src/display/api").PDFPageProxy} PDFPageProxy */ /** @typedef {import("../src/display/display_utils").PageViewport} PageViewport */ /** @typedef {import("./annotation_layer_builder").AnnotationLayerBuilder} AnnotationLayerBuilder */ /** @typedef {import("./annotation_editor_layer_builder").AnnotationEditorLayerBuilder} AnnotationEditorLayerBuilder */ /** @typedef {import("./event_utils").EventBus} EventBus */ /** @typedef {import("./struct_tree_builder").StructTreeLayerBuilder} StructTreeLayerBuilder */ /** @typedef {import("./text_highlighter").TextHighlighter} TextHighlighter */ /** @typedef {import("./text_layer_builder").TextLayerBuilder} TextLayerBuilder */ /** @typedef {import("./ui_utils").RenderingStates} RenderingStates */ /** @typedef {import("./xfa_layer_builder").XfaLayerBuilder} XfaLayerBuilder */ /** @typedef {import("./text_accessibility.js").TextAccessibilityManager} TextAccessibilityManager */ /** * @interface */ export class IPDFLinkService { /** * @type {number} */ get pagesCount(): number; /** * @param {number} value */ set page(arg: number); /** * @type {number} */ get page(): number; /** * @param {number} value */ set rotation(arg: number); /** * @type {number} */ get rotation(): number; /** * @param {boolean} value */ set externalLinkEnabled(arg: boolean); /** * @type {boolean} */ get externalLinkEnabled(): boolean; /** * @param {string|Array} dest - The named, or explicit, PDF destination. */ goToDestination(dest: string | any[]): Promise; /** * @param {number|string} val - The page number, or page label. */ goToPage(val: number | string): void; /** * @param {HTMLAnchorElement} link * @param {string} url * @param {boolean} [newWindow] */ addLinkAttributes(link: HTMLAnchorElement, url: string, newWindow?: boolean | undefined): void; /** * @param dest - The PDF destination object. * @returns {string} The hyperlink to the PDF object. */ getDestinationHash(dest: any): string; /** * @param hash - The PDF parameters/hash. * @returns {string} The hyperlink to the PDF object. */ getAnchorUrl(hash: any): string; /** * @param {string} hash */ setHash(hash: string): void; /** * @param {string} action */ executeNamedAction(action: string): void; /** * @param {Object} action */ executeSetOCGState(action: Object): void; /** * @param {number} pageNum - page number. * @param {Object} pageRef - reference to the page. */ cachePageRef(pageNum: number, pageRef: Object): void; /** * @param {number} pageNumber */ isPageVisible(pageNumber: number): void; /** * @param {number} pageNumber */ isPageCached(pageNumber: number): void; } /** * @interface */ export class IPDFStructTreeLayerFactory { /** * @typedef {Object} CreateStructTreeLayerBuilderParameters * @property {PDFPageProxy} pdfPage */ /** * @param {CreateStructTreeLayerBuilderParameters} * @returns {StructTreeLayerBuilder} */ createStructTreeLayerBuilder({ pdfPage }: { pdfPage: PDFPageProxy; }): any; } /** * @interface */ export class IPDFTextLayerFactory { /** * @typedef {Object} CreateTextLayerBuilderParameters * @property {HTMLDivElement} textLayerDiv * @property {number} pageIndex * @property {PageViewport} viewport * @property {EventBus} eventBus * @property {TextHighlighter} highlighter * @property {TextAccessibilityManager} [accessibilityManager] */ /** * @param {CreateTextLayerBuilderParameters} * @returns {TextLayerBuilder} */ createTextLayerBuilder({ textLayerDiv, pageIndex, viewport, eventBus, highlighter, accessibilityManager, }: { textLayerDiv: HTMLDivElement; pageIndex: number; viewport: PageViewport; eventBus: EventBus; highlighter: TextHighlighter; accessibilityManager?: import("./text_accessibility.js").TextAccessibilityManager | undefined; }): TextLayerBuilder; } /** * @interface */ export class IPDFXfaLayerFactory { /** * @typedef {Object} CreateXfaLayerBuilderParameters * @property {HTMLDivElement} pageDiv * @property {PDFPageProxy} pdfPage * @property {AnnotationStorage} [annotationStorage] - Storage for annotation * data in forms. */ /** * @param {CreateXfaLayerBuilderParameters} * @returns {XfaLayerBuilder} */ createXfaLayerBuilder({ pageDiv, pdfPage, annotationStorage }: { pageDiv: HTMLDivElement; pdfPage: PDFPageProxy; /** * - Storage for annotation * data in forms. */ annotationStorage?: any; }): XfaLayerBuilder; } /** * @interface */ export class IRenderableView { /** @type {function | null} */ resume: Function | null; /** * @type {string} - Unique ID for rendering queue. */ get renderingId(): string; /** * @type {RenderingStates} */ get renderingState(): any; /** * @returns {Promise} Resolved on draw completion. */ draw(): Promise; }