export type PDFDocumentProxy = import("../src/display/api").PDFDocumentProxy;
|
export type PDFPageProxy = import("../src/display/api").PDFPageProxy;
|
export type PageViewport = import("../src/display/display_utils").PageViewport;
|
export type EventBus = import("./event_utils").EventBus;
|
export type IDownloadManager = import("./interfaces").IDownloadManager;
|
export type IL10n = import("./interfaces").IL10n;
|
export type IPDFAnnotationLayerFactory = import("./interfaces").IPDFAnnotationLayerFactory;
|
export type IPDFAnnotationEditorLayerFactory = import("./interfaces").IPDFAnnotationEditorLayerFactory;
|
export type IPDFLinkService = import("./interfaces").IPDFLinkService;
|
export type IPDFStructTreeLayerFactory = import("./interfaces").IPDFStructTreeLayerFactory;
|
export type IPDFTextLayerFactory = import("./interfaces").IPDFTextLayerFactory;
|
export type IPDFXfaLayerFactory = import("./interfaces").IPDFXfaLayerFactory;
|
export type TextAccessibilityManager = import("./text_accessibility.js").TextAccessibilityManager;
|
export type PDFViewerOptions = {
|
/**
|
* - The container for the viewer element.
|
*/
|
container: HTMLDivElement;
|
/**
|
* - The viewer element.
|
*/
|
viewer?: HTMLDivElement | undefined;
|
/**
|
* - The application event bus.
|
*/
|
eventBus: EventBus;
|
/**
|
* - The navigation/linking service.
|
*/
|
linkService: IPDFLinkService;
|
/**
|
* - The download manager
|
* component.
|
*/
|
downloadManager?: import("./interfaces").IDownloadManager | undefined;
|
/**
|
* - The find controller
|
* component.
|
*/
|
findController?: any;
|
/**
|
* - The scripting manager
|
* component.
|
*/
|
scriptingManager?: any;
|
/**
|
* - The rendering queue object.
|
*/
|
renderingQueue?: PDFRenderingQueue | undefined;
|
/**
|
* - Removes the border shadow around
|
* the pages. The default value is `false`.
|
*/
|
removePageBorders?: boolean | undefined;
|
/**
|
* - Controls if the text layer used for
|
* selection and searching is created, and if the improved text selection
|
* behaviour is enabled. 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;
|
/**
|
* - Enables the creation and editing
|
* of new Annotations. The constants from {@link AnnotationEditorType } should
|
* be used. The default value is `AnnotationEditorType.DISABLE`.
|
*/
|
annotationEditorMode?: number | undefined;
|
/**
|
* - Path for image resources, mainly
|
* mainly for annotation icons. Include trailing slash.
|
*/
|
imageResourcesPath?: string | undefined;
|
/**
|
* - Enables automatic rotation of
|
* landscape pages upon printing. The default is `false`.
|
*/
|
enablePrintAutoRotate?: boolean | undefined;
|
/**
|
* - Enables CSS only zooming. The default
|
* value is `false`.
|
*/
|
useOnlyCssZoom?: boolean | undefined;
|
/**
|
* - The maximum supported canvas size in
|
* total pixels, i.e. width * height. Use -1 for no limit. The default value
|
* is 4096 * 4096 (16 mega-pixels).
|
*/
|
maxCanvasPixels?: number | undefined;
|
/**
|
* - Localization service.
|
*/
|
l10n: IL10n;
|
/**
|
* - Enables PDF document permissions,
|
* when they exist. The default value is `false`.
|
*/
|
enablePermissions?: boolean | undefined;
|
/**
|
* - Overwrites background and foreground colors
|
* with user defined ones in order to improve readability in high contrast
|
* mode.
|
*/
|
pageColors?: Object | undefined;
|
};
|
/**
|
* Simple viewer control to display PDF content/pages.
|
*
|
* @implements {IPDFAnnotationLayerFactory}
|
* @implements {IPDFAnnotationEditorLayerFactory}
|
* @implements {IPDFStructTreeLayerFactory}
|
* @implements {IPDFTextLayerFactory}
|
* @implements {IPDFXfaLayerFactory}
|
*/
|
export class BaseViewer implements IPDFAnnotationLayerFactory, IPDFAnnotationEditorLayerFactory, IPDFStructTreeLayerFactory, IPDFTextLayerFactory, IPDFXfaLayerFactory {
|
/**
|
* @param {PDFViewerOptions} options
|
*/
|
constructor(options: PDFViewerOptions);
|
container: HTMLDivElement;
|
viewer: Element | null;
|
eventBus: import("./event_utils").EventBus;
|
linkService: import("./interfaces").IPDFLinkService;
|
downloadManager: import("./interfaces").IDownloadManager | null;
|
findController: any;
|
_scriptingManager: any;
|
removePageBorders: boolean;
|
textLayerMode: number;
|
imageResourcesPath: string;
|
enablePrintAutoRotate: boolean;
|
renderer: any;
|
useOnlyCssZoom: boolean;
|
maxCanvasPixels: number | undefined;
|
l10n: import("./interfaces").IL10n;
|
pageColors: Object | null;
|
defaultRenderingQueue: boolean;
|
renderingQueue: PDFRenderingQueue | undefined;
|
scroll: {
|
right: boolean;
|
down: boolean;
|
lastX: any;
|
lastY: any;
|
_eventHandler: (evt: any) => void;
|
};
|
presentationModeState: number;
|
_onBeforeDraw: ((evt: any) => void) | null;
|
_onAfterDraw: any;
|
get pagesCount(): number;
|
getPageView(index: any): any;
|
/**
|
* @type {boolean} - True if all {PDFPageView} objects are initialized.
|
*/
|
get pageViewsReady(): boolean;
|
/**
|
* @type {boolean}
|
*/
|
get renderForms(): boolean;
|
/**
|
* @type {boolean}
|
*/
|
get enableScripting(): boolean;
|
/**
|
* @param {number} val - The page number.
|
*/
|
set currentPageNumber(arg: number);
|
/**
|
* @type {number}
|
*/
|
get currentPageNumber(): number;
|
/**
|
* @returns {boolean} Whether the pageNumber is valid (within bounds).
|
* @private
|
*/
|
private _setCurrentPageNumber;
|
_currentPageNumber: any;
|
/**
|
* @param {string} val - The page label.
|
*/
|
set currentPageLabel(arg: string | null);
|
/**
|
* @type {string|null} Returns the current page label, or `null` if no page
|
* labels exist.
|
*/
|
get currentPageLabel(): string | null;
|
/**
|
* @param {number} val - Scale of the pages in percents.
|
*/
|
set currentScale(arg: number);
|
/**
|
* @type {number}
|
*/
|
get currentScale(): number;
|
/**
|
* @param val - The scale of the pages (in percent or predefined value).
|
*/
|
set currentScaleValue(arg: string);
|
/**
|
* @type {string}
|
*/
|
get currentScaleValue(): string;
|
/**
|
* @param {number} rotation - The rotation of the pages (0, 90, 180, 270).
|
*/
|
set pagesRotation(arg: number);
|
/**
|
* @type {number}
|
*/
|
get pagesRotation(): number;
|
_pagesRotation: any;
|
get firstPagePromise(): any;
|
get onePageRendered(): any;
|
get pagesPromise(): any;
|
/**
|
* @param {PDFDocumentProxy} pdfDocument
|
*/
|
setDocument(pdfDocument: PDFDocumentProxy): void;
|
pdfDocument: import("../src/display/api").PDFDocumentProxy | undefined;
|
_scrollMode: any;
|
_optionalContentConfigPromise: Promise<any> | Promise<import("../src/display/optional_content_config.js").OptionalContentConfig> | null | undefined;
|
/**
|
* @param {Array|null} labels
|
*/
|
setPageLabels(labels: any[] | null): void;
|
_pageLabels: any[] | null | undefined;
|
_resetView(): void;
|
_pages: any[] | undefined;
|
_currentScale: any;
|
_currentScaleValue: any;
|
_location: {
|
pageNumber: any;
|
scale: any;
|
top: number;
|
left: number;
|
rotation: any;
|
pdfOpenParams: string;
|
} | null | undefined;
|
_firstPageCapability: any;
|
_onePageRenderedCapability: any;
|
_pagesCapability: any;
|
_previousScrollMode: any;
|
_spreadMode: any;
|
_scrollUpdate(): void;
|
_setScaleUpdatePages(newScale: any, newValue: any, noScroll?: boolean, preset?: boolean): void;
|
/**
|
* @private
|
*/
|
private get _pageWidthScaleFactor();
|
_setScale(value: any, noScroll?: boolean): void;
|
/**
|
* @param {string} label - The page label.
|
* @returns {number|null} The page number corresponding to the page label,
|
* or `null` when no page labels exist and/or the input is invalid.
|
*/
|
pageLabelToPageNumber(label: string): number | null;
|
/**
|
* @typedef {Object} ScrollPageIntoViewParameters
|
* @property {number} pageNumber - The page number.
|
* @property {Array} [destArray] - The original PDF destination array, in the
|
* format: <page-ref> </XYZ|/FitXXX> <args..>
|
* @property {boolean} [allowNegativeOffset] - Allow negative page offsets.
|
* The default value is `false`.
|
* @property {boolean} [ignoreDestinationZoom] - Ignore the zoom argument in
|
* the destination array. The default value is `false`.
|
*/
|
/**
|
* Scrolls page into view.
|
* @param {ScrollPageIntoViewParameters} params
|
*/
|
scrollPageIntoView({ pageNumber, destArray, allowNegativeOffset, ignoreDestinationZoom, }: {
|
/**
|
* - The page number.
|
*/
|
pageNumber: number;
|
/**
|
* - The original PDF destination array, in the
|
* format: <page-ref> </XYZ|/FitXXX> <args..>
|
*/
|
destArray?: any[] | undefined;
|
/**
|
* - Allow negative page offsets.
|
* The default value is `false`.
|
*/
|
allowNegativeOffset?: boolean | undefined;
|
/**
|
* - Ignore the zoom argument in
|
* the destination array. The default value is `false`.
|
*/
|
ignoreDestinationZoom?: boolean | undefined;
|
}): void;
|
_updateLocation(firstPage: any): void;
|
update(): void;
|
containsElement(element: any): boolean;
|
focus(): void;
|
get _isContainerRtl(): boolean;
|
get isInPresentationMode(): boolean;
|
get isChangingPresentationMode(): boolean;
|
get isHorizontalScrollbarEnabled(): boolean;
|
get isVerticalScrollbarEnabled(): boolean;
|
_getVisiblePages(): Object;
|
/**
|
* @param {number} pageNumber
|
*/
|
isPageVisible(pageNumber: number): any;
|
/**
|
* @param {number} pageNumber
|
*/
|
isPageCached(pageNumber: number): any;
|
cleanup(): void;
|
/**
|
* @private
|
*/
|
private _cancelRendering;
|
forceRendering(currentlyVisiblePages: any): boolean;
|
/**
|
* @typedef {Object} CreateTextLayerBuilderParameters
|
* @property {HTMLDivElement} textLayerDiv
|
* @property {number} pageIndex
|
* @property {PageViewport} viewport
|
* @property {boolean} [enhanceTextSelection]
|
* @property {EventBus} eventBus
|
* @property {TextHighlighter} highlighter
|
* @property {TextAccessibilityManager} [accessibilityManager]
|
*/
|
/**
|
* @param {CreateTextLayerBuilderParameters}
|
* @returns {TextLayerBuilder}
|
*/
|
createTextLayerBuilder({ textLayerDiv, pageIndex, viewport, enhanceTextSelection, eventBus, highlighter, accessibilityManager, }: {
|
textLayerDiv: HTMLDivElement;
|
pageIndex: number;
|
viewport: PageViewport;
|
enhanceTextSelection?: boolean | undefined;
|
eventBus: EventBus;
|
highlighter: TextHighlighter;
|
accessibilityManager?: import("./text_accessibility.js").TextAccessibilityManager | undefined;
|
}): TextLayerBuilder;
|
/**
|
* @typedef {Object} CreateTextHighlighterParameters
|
* @property {number} pageIndex
|
* @property {EventBus} eventBus
|
*/
|
/**
|
* @param {CreateTextHighlighterParameters}
|
* @returns {TextHighlighter}
|
*/
|
createTextHighlighter({ pageIndex, eventBus }: {
|
pageIndex: number;
|
eventBus: EventBus;
|
}): TextHighlighter;
|
/**
|
* @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<boolean>} [hasJSActionsPromise]
|
* @property {Object} [mouseState]
|
* @property {Promise<Object<string, Array<Object>> | null>}
|
* [fieldObjectsPromise]
|
* @property {Map<string, HTMLCanvasElement>} [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<boolean> | undefined;
|
mouseState?: Object | undefined;
|
fieldObjectsPromise?: Promise<{
|
[x: string]: Object[];
|
} | null> | undefined;
|
/**
|
* - Map some
|
* annotation ids with canvases used to render them.
|
*/
|
annotationCanvasMap?: Map<string, HTMLCanvasElement> | undefined;
|
accessibilityManager?: import("./text_accessibility.js").TextAccessibilityManager | undefined;
|
}): AnnotationLayerBuilder;
|
/**
|
* @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, accessibilityManager, l10n, annotationStorage, }: {
|
uiManager?: any;
|
pageDiv: HTMLDivElement;
|
pdfPage: PDFPageProxy;
|
l10n: IL10n;
|
/**
|
* - Storage for annotation
|
*/
|
annotationStorage?: any;
|
/**
|
* data in forms.
|
*/
|
accessibilityManager?: import("./text_accessibility.js").TextAccessibilityManager | undefined;
|
}): AnnotationEditorLayerBuilder;
|
/**
|
* @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;
|
/**
|
* @typedef {Object} CreateStructTreeLayerBuilderParameters
|
* @property {PDFPageProxy} pdfPage
|
*/
|
/**
|
* @param {CreateStructTreeLayerBuilderParameters}
|
* @returns {StructTreeLayerBuilder}
|
*/
|
createStructTreeLayerBuilder({ pdfPage }: {
|
pdfPage: PDFPageProxy;
|
}): StructTreeLayerBuilder;
|
/**
|
* @type {boolean} Whether all pages of the PDF document have identical
|
* widths and heights.
|
*/
|
get hasEqualPageSizes(): boolean;
|
/**
|
* Returns sizes of the pages.
|
* @returns {Array} Array of objects with width/height/rotation fields.
|
*/
|
getPagesOverview(): any[];
|
/**
|
* @param {Promise<OptionalContentConfig>} promise - A promise that is
|
* resolved with an {@link OptionalContentConfig} instance.
|
*/
|
set optionalContentConfigPromise(arg: Promise<any>);
|
/**
|
* @type {Promise<OptionalContentConfig | null>}
|
*/
|
get optionalContentConfigPromise(): Promise<any>;
|
/**
|
* @param {number} mode - The direction in which the document pages should be
|
* laid out within the scrolling container.
|
* The constants from {ScrollMode} should be used.
|
*/
|
set scrollMode(arg: number);
|
/**
|
* @type {number} One of the values in {ScrollMode}.
|
*/
|
get scrollMode(): number;
|
_updateScrollMode(pageNumber?: null): void;
|
/**
|
* @param {number} mode - Group the pages in spreads, starting with odd- or
|
* even-number pages (unless `SpreadMode.NONE` is used).
|
* The constants from {SpreadMode} should be used.
|
*/
|
set spreadMode(arg: number);
|
/**
|
* @type {number} One of the values in {SpreadMode}.
|
*/
|
get spreadMode(): number;
|
_updateSpreadMode(pageNumber?: null): void;
|
/**
|
* @private
|
*/
|
private _getPageAdvance;
|
/**
|
* Go to the next page, taking scroll/spread-modes into account.
|
* @returns {boolean} Whether navigation occured.
|
*/
|
nextPage(): boolean;
|
/**
|
* Go to the previous page, taking scroll/spread-modes into account.
|
* @returns {boolean} Whether navigation occured.
|
*/
|
previousPage(): boolean;
|
/**
|
* Increase the current zoom level one, or more, times.
|
* @param {number} [steps] - Defaults to zooming once.
|
*/
|
increaseScale(steps?: number | undefined): void;
|
/**
|
* Decrease the current zoom level one, or more, times.
|
* @param {number} [steps] - Defaults to zooming once.
|
*/
|
decreaseScale(steps?: number | undefined): void;
|
updateContainerHeightCss(): void;
|
/**
|
* @param {number} mode - AnnotationEditor mode (None, FreeText, Ink, ...)
|
*/
|
set annotationEditorMode(arg: number);
|
/**
|
* @type {number}
|
*/
|
get annotationEditorMode(): number;
|
set annotationEditorParams(arg: any);
|
refresh(): void;
|
#private;
|
}
|
export namespace PagesCountLimit {
|
const FORCE_SCROLL_MODE_PAGE: number;
|
const FORCE_LAZY_PAGE_INIT: number;
|
const PAUSE_EAGER_PAGE_INIT: number;
|
}
|
/**
|
* @typedef {Object} PDFViewerOptions
|
* @property {HTMLDivElement} container - The container for the viewer element.
|
* @property {HTMLDivElement} [viewer] - The viewer element.
|
* @property {EventBus} eventBus - The application event bus.
|
* @property {IPDFLinkService} linkService - The navigation/linking service.
|
* @property {IDownloadManager} [downloadManager] - The download manager
|
* component.
|
* @property {PDFFindController} [findController] - The find controller
|
* component.
|
* @property {PDFScriptingManager} [scriptingManager] - The scripting manager
|
* component.
|
* @property {PDFRenderingQueue} [renderingQueue] - The rendering queue object.
|
* @property {boolean} [removePageBorders] - Removes the border shadow around
|
* the pages. The default value is `false`.
|
* @property {number} [textLayerMode] - Controls if the text layer used for
|
* selection and searching is created, and if the improved text selection
|
* behaviour is enabled. The constants from {TextLayerMode} should be used.
|
* The default value is `TextLayerMode.ENABLE`.
|
* @property {number} [annotationMode] - 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`.
|
* @property {number} [annotationEditorMode] - Enables the creation and editing
|
* of new Annotations. The constants from {@link AnnotationEditorType} should
|
* be used. The default value is `AnnotationEditorType.DISABLE`.
|
* @property {string} [imageResourcesPath] - Path for image resources, mainly
|
* mainly for annotation icons. Include trailing slash.
|
* @property {boolean} [enablePrintAutoRotate] - Enables automatic rotation of
|
* landscape pages upon printing. The default is `false`.
|
* @property {boolean} [useOnlyCssZoom] - Enables CSS only zooming. The default
|
* value is `false`.
|
* @property {number} [maxCanvasPixels] - The maximum supported canvas size in
|
* total pixels, i.e. width * height. Use -1 for no limit. The default value
|
* is 4096 * 4096 (16 mega-pixels).
|
* @property {IL10n} l10n - Localization service.
|
* @property {boolean} [enablePermissions] - Enables PDF document permissions,
|
* when they exist. The default value is `false`.
|
* @property {Object} [pageColors] - Overwrites background and foreground colors
|
* with user defined ones in order to improve readability in high contrast
|
* mode.
|
*/
|
export class PDFPageViewBuffer {
|
constructor(size: any);
|
push(view: any): void;
|
/**
|
* After calling resize, the size of the buffer will be `newSize`.
|
* The optional parameter `idsToKeep` is, if present, a Set of page-ids to
|
* push to the back of the buffer, delaying their destruction. The size of
|
* `idsToKeep` has no impact on the final size of the buffer; if `idsToKeep`
|
* is larger than `newSize`, some of those pages will be destroyed anyway.
|
*/
|
resize(newSize: any, idsToKeep?: null): void;
|
has(view: any): boolean;
|
[Symbol.iterator](): IterableIterator<any>;
|
#private;
|
}
|
import { PDFRenderingQueue } from "./pdf_rendering_queue.js";
|
import { TextHighlighter } from "./text_highlighter.js";
|
import { TextLayerBuilder } from "./text_layer_builder.js";
|
import { AnnotationLayerBuilder } from "./annotation_layer_builder.js";
|
import { AnnotationEditorLayerBuilder } from "./annotation_editor_layer_builder.js";
|
import { XfaLayerBuilder } from "./xfa_layer_builder.js";
|
import { StructTreeLayerBuilder } from "./struct_tree_layer_builder.js";
|
