@pdftools/four-heights-pdf-web-viewer 4.3.6

package/es6/pdf-viewer-api/PdfViewingWrapper.d.ts

@@ -0,0 +1,178 @@
+import { PdfFitMode, PdfPageLayoutMode, DocumentChange, RotationDirection } from './enums';
+import { Annotation, PdfDestination, PdfItem, PdfItemsOnPage, PdfPoint, PdfRect, Point, Rect, TextSelection, PdfPageSize, QuadrilateralOnPage, InputFile, InputUri, ViewOptions, AnnotationFilterCallback, RenderOptions, SaveOptions, PdfViewerApiOptions } from './types';
+import { PdfViewing } from '../pdf-viewing/PdfViewing';
+import { PdfStampSetting } from '../pdf-web-viewer/WebViewerOptions';
+import { RenderCanvasOptions } from './PdfViewerApi';
+export interface PdfViewerApiEventMap {
+    firstVisiblePage: number;
+    lastVisiblePage: number;
+    pageNumber: number;
+    rotation: number;
+    zoom: number;
+    fitMode: PdfFitMode;
+    pageLayoutMode: PdfPageLayoutMode;
+    busyState: boolean;
+    unsavedChanges: boolean;
+    canvasInvalidated: boolean;
+    error: Error;
+    itemCreated: PdfItem;
+    itemUpdated: PdfItem;
+    itemDeleted: DeletedItem;
+    pageChanged: number;
+}
+interface DeletedItem {
+    id: number;
+    page: number;
+    categoryType: 1;
+}
+export type PdfViewerApiEventListener = <K extends keyof PdfViewerApiEventMap>(e: PdfViewerApiEventMap[K]) => void;
+export type PdfViewerApiEventTypes = keyof PdfViewerApiEventMap;
+export declare class PdfViewingWrapper {
+    private pdfController;
+    private pdfDocument;
+    private pdfStampDocuments;
+    private objectUrls;
+    private registeredPdfStamps;
+    private view;
+    private eventListeners;
+    private viewportSize;
+    private textFragmentCache;
+    private nativeAnnotationCache;
+    private handleAnnotationCache;
+    private pageAnnotationCache;
+    private imageBitmapCache;
+    private ignoreDocumentPreferences;
+    private nativeOutlines;
+    private devicePixelRatio;
+    private xDPI;
+    private yDPI;
+    private pdfViewerApiOptions;
+    private licenseFeatures;
+    constructor(key: string, pdfViewerApiOptions: PdfViewerApiOptions);
+    getIgnoringPreferences(): boolean;
+    setIgnoringPreferences(ignorePreferences: boolean): void;
+    open(pdfFile: InputFile | InputUri, fdfFiles?: (InputFile | InputUri)[] | null, password?: string | null, viewOptions?: ViewOptions | null, renderOptions?: RenderOptions | null, viewportSize?: {
+        width: number;
+        height: number;
+    }): Promise<void>;
+    save(saveOptions?: SaveOptions): Promise<unknown>;
+    close(): void;
+    destroy(): void;
+    registerPdfStampFile(pdfStampFileName: string, data: Uint8Array, onStampCreated: (pdfStamp: PdfStampSetting) => void): void;
+    getPageCount(): number | null;
+    registerImage(imageBuffer: Uint8Array): Promise<number>;
+    registerPdfPage(fileName: string, pageNumber: number): Promise<number>;
+    getPageNumber(): number;
+    getFitMode(): PdfFitMode;
+    setFitMode(mode: number): void;
+    setPageNumber(page: number): void;
+    getZoom(): number;
+    setZoom(zoom: number, location?: Point): void;
+    getRotation(): number;
+    setRotation(rotation: number): void;
+    setBorderSize(size: number): void;
+    getBorderSize(): number;
+    suspendDrawing(): void;
+    resumeDrawing(): void;
+    renderCanvas(ctx: CanvasRenderingContext2D, options: RenderCanvasOptions): void;
+    renderPage(page: number, width: number, height: number, annotationFilter?: AnnotationFilterCallback): Promise<ImageData>;
+    rotatePage(pageNumber: number, direction: RotationDirection): void;
+    getPagePdfSize(page: number): Promise<PdfPageSize>;
+    setLicenseKey(key: string): boolean;
+    getSupportedFeatures(): PdfViewing.LicenseFeature;
+    hasChanges(): DocumentChange | null;
+    getSearchIterator(keyword: string, page: number, caseSensitive: boolean, wrap: boolean, regex: boolean): PdfViewing.Pdf.Content.TextSearchIterator | undefined;
+    getTextFragmentOnPoint(point: Point): any;
+    getWordOnPoint(point: PdfPoint): TextSelection | null;
+    getTextSelection(startPoint: PdfPoint, endPoint: PdfPoint): TextSelection | null;
+    getRectangularTextSelection(startPoint: PdfPoint, endPoint: PdfPoint): TextSelection | null;
+    getText(startPoint: PdfPoint, endPoint: PdfPoint): string | null;
+    getTextForRectangularSelection(startPoint: PdfPoint, endPoint: PdfPoint): string | null;
+    private createWebViewerFragment;
+    getIsOpen(): boolean;
+    getOutlines(parent: any): Promise<unknown>;
+    goTo(destination: PdfDestination): void;
+    private goToPage;
+    goToRectangle(rectangle: PdfRect): void;
+    getAnnotationsFromPage(page: number): Promise<PdfItemsOnPage>;
+    deleteItem(item: any): Promise<void>;
+    private validateViewingSdkVersion;
+    private deleteAnnotation;
+    getItem(id: number): PdfItem | null;
+    createItem(item: any): Promise<any>;
+    private createAnnotationFilter;
+    private createMarkupAnnotation;
+    private createAnnotation;
+    private createQuadrilateralList;
+    private convertToNativeBorderStyle;
+    private convertToWebViewerBorderStyle;
+    updateItem(item: any): Promise<PdfItem>;
+    getTextStampAspectRatio(stampText: string): Promise<number>;
+    private createNativeColor;
+    private createWebViewerAnnotation;
+    private getAnnotationBehaviors;
+    private addPopup;
+    getOpenPopups(firstPage: number, lastPage: number): Annotation[];
+    private convertColorToRgbaString;
+    getPageLayoutMode(): PdfViewing.Pdf.Navigation.PageLayoutMode;
+    setPageLayoutMode(layout: PdfViewing.Pdf.Navigation.PageLayoutMode): void;
+    getScrollMaxPosition(): PdfViewing.Pdf.Geometry.Integer.ScrollPosition | undefined;
+    getScrollPosition(): PdfViewing.Pdf.Geometry.Integer.ScrollPosition | undefined;
+    setScrollPosition(pos: any): void;
+    getPageScreenRect(page: number): Rect | null;
+    getClosestPointOnPdfByScreenPoint(point: Point, padding?: number, page?: number): PdfPoint;
+    transformPdfLengthToScreenLength(pdfLength: number): number;
+    transformScreenLengthToPdfLength(pdfLength: number): number;
+    transformScreenPointToPdfPoint(point: Point, page?: number): {
+        pdfPoint: {
+            pdfX: number;
+            pdfY: number;
+            page: number;
+        };
+        isOnPage: boolean;
+    } | {
+        pdfPoint: null;
+        isOnPage: boolean;
+    } | null;
+    transformPdfPointToScreenPoint(pdfPoint: PdfPoint): {
+        x: number | undefined;
+        y: number | undefined;
+    };
+    transformPdfPageRectToScreenRect(pdfRect: PdfRect): {
+        x: number | undefined;
+        y: number | undefined;
+        w: number | undefined;
+        h: number | undefined;
+    };
+    transformScreenRectToPdfRect(screenRect: Rect, page: number): {
+        pdfX: number | undefined;
+        pdfY: number | undefined;
+        pdfW: number | undefined;
+        pdfH: number | undefined;
+        page: number;
+    } | null;
+    transformQuadrilateralToViewport(quadrilateral: QuadrilateralOnPage): Point[];
+    getAnnotationsOnPoint(point: Point, onlySelectable: boolean): PdfItem[] | null;
+    getItemsFromPage(page: number, type: number): Promise<PdfItemsOnPage> | undefined;
+    private onDocumentOpened;
+    private ViewingPageLayoutToWwPageLayout;
+    private WwPageLayoutToViewingPageLayout;
+    private WwFitModeToViewingFitMode;
+    getLastVisiblePage(): number;
+    getFirstVisiblePage(): number;
+    private drawImages;
+    addEventListener<K extends keyof PdfViewerApiEventMap>(type: K, listener: (e: PdfViewerApiEventMap[K]) => void): void;
+    removeEventListener<K extends keyof PdfViewerApiEventMap>(type: K, listener: (e: PdfViewerApiEventMap[K]) => void): void;
+    private dispatchEvent;
+    private attachEventListeners;
+    private onViewUpdated;
+    private onImageRemovedFromCache;
+    private onImageCreated;
+    getProductVersion(): string;
+    private getXDPI;
+    private getYDPI;
+    private ViewingPdfRect2WwPdfRect;
+    private ViewingQuadrilateral2WwPdfRect;
+    private ViewingVPRect2WwVpRect;
+}
+export {};