pdf-generator-api-pdfviewer/dist/PDFViewer.d.ts

PDF viewer by PDF Generator API

interface PDFViewerParams {
    readonly container: HTMLElement;
    options?: PDFViewerOptions | undefined;
}
declare enum Theme {
    Light = "light",
    Dark = "dark",
    PDFApi = "pdfapi"
}
declare enum Scale {
    AutomaticZoom = "auto",
    ActualSize = "page-actual",
    PageFit = "page-fit",
    PageWidth = "page-width"
}
declare enum Event {
    DocumentUploaded = "document-uploaded",
    DocumentSaved = "document-saved",
    DocumentPrinted = "document-printed",
    SignatureAdded = "signature-added",
    DocumentUpdated = "document-updated"
}
type ToolbarIconSize = 16 | 24 | 32 | 48;
type ToolbarFontSize = NumericRange<10, 24>;
type NumericRange<Start extends number, End extends number, Arr extends unknown[] = [], Acc extends number = never> = Arr['length'] extends End ? Acc | Start | End : NumericRange<Start, End, [...Arr, 1], Arr[Start] extends undefined ? Acc : Acc | Arr['length']>;
interface PDFViewerOptions {
    readonly theme: Theme;
    readonly initialScale: Scale | number;
    readonly toolbarFontSize: ToolbarFontSize;
    readonly toolbarIconSize: ToolbarIconSize;
    readonly scaleDropdown: boolean;
    readonly search: boolean;
    readonly signature: boolean;
    readonly print: boolean;
    readonly download: boolean;
    readonly upload: boolean;
}
declare class PDFViewer {
    private readonly container;
    /**
     * The iframe window internal ID
     */
    private iframeId;
    /**
     * The iframe state
     */
    private isIframeLoaded;
    /**
     * Interval (in milliseconds) for checking the iframe loading state
     */
    private readonly LOADING_INTERVAL;
    /**
     * Default settings
     */
    private options;
    constructor(params: PDFViewerParams);
    /**
     * Sets application settings
     *
     * @param options - PDFViewerOptions
     */
    setOptions: (options: PDFViewerOptions) => void;
    /**
     * Loads a document via a URL
     *
     * @param url - string
     */
    loadUrl: (url: string) => Promise<void>;
    /**
     * Loads a document that is base64 encoded
     *
     * @param encodedPdf - string
     */
    loadBase64: (encodedPdf: string) => Promise<void>;
    /**
     * Returns the base64 encoded PDF document
     */
    getBase64: () => Promise<string>;
    /**
     * Renders a PDF document using the PDF.js API
     *
     * @param documentParams - OpenDocumentParams
     */
    private render;
    /**
     * Applies global settings
     */
    private applyOptions;
    /**
     * UI initialization
     */
    private initUI;
    /**
     * Style loader
     *
     * @param document - Document
     */
    private loadStyles;
    /**
     * Script loader
     *
     * @param document - Document
     */
    private loadScripts;
    /**
     * Returns the PDF.js application instance
     * Retries until the application is loaded
     */
    private pdfJsApplication;
}

export { Event, PDFViewer, type PDFViewerOptions, type PDFViewerParams, Scale, Theme, type ToolbarFontSize, type ToolbarIconSize };