UNPKG

1.93 kBTypeScriptView Raw
1export type IRenderableView = import("./interfaces").IRenderableView;
2export type PDFViewer = import("./pdf_viewer").PDFViewer;
3export type PDFThumbnailViewer = import("./pdf_thumbnail_viewer").PDFThumbnailViewer;
4/**
5 * Controls rendering of the views for pages and thumbnails.
6 */
7export class PDFRenderingQueue {
8 pdfViewer: import("./pdf_viewer").PDFViewer | null;
9 pdfThumbnailViewer: import("./pdf_thumbnail_viewer").PDFThumbnailViewer | null;
10 onIdle: any;
11 highestPriorityPage: string | null;
12 /** @type {number} */
13 idleTimeout: number;
14 printing: boolean;
15 isThumbnailViewEnabled: boolean;
16 /**
17 * @param {PDFViewer} pdfViewer
18 */
19 setViewer(pdfViewer: PDFViewer): void;
20 /**
21 * @param {PDFThumbnailViewer} pdfThumbnailViewer
22 */
23 setThumbnailViewer(pdfThumbnailViewer: PDFThumbnailViewer): void;
24 /**
25 * @param {IRenderableView} view
26 * @returns {boolean}
27 */
28 isHighestPriority(view: IRenderableView): boolean;
29 /**
30 * @returns {boolean}
31 */
32 hasViewer(): boolean;
33 /**
34 * @param {Object} currentlyVisiblePages
35 */
36 renderHighestPriority(currentlyVisiblePages: Object): void;
37 /**
38 * @param {Object} visible
39 * @param {Array} views
40 * @param {boolean} scrolledDown
41 * @param {boolean} [preRenderExtra]
42 */
43 getHighestPriority(visible: Object, views: any[], scrolledDown: boolean, preRenderExtra?: boolean | undefined): any;
44 /**
45 * @param {IRenderableView} view
46 * @returns {boolean}
47 */
48 isViewFinished(view: IRenderableView): boolean;
49 /**
50 * Render a page or thumbnail view. This calls the appropriate function
51 * based on the views state. If the view is already rendered it will return
52 * `false`.
53 *
54 * @param {IRenderableView} view
55 */
56 renderView(view: IRenderableView): boolean;
57}