ngx-extended-pdf-viewer
Version:
Embedding PDF files in your Angular application. Highly configurable viewer including the toolbar, sidebar, and all the features you're used to.
193 lines (192 loc) • 9.34 kB
TypeScript
import { OnChanges, SimpleChanges, OnDestroy, EventEmitter, NgZone, TemplateRef, OnInit } from '@angular/core';
import { PagesLoadedEvent } from './events/pages-loaded-event';
import { PageRenderedEvent } from './events/page-rendered-event';
import { PdfDownloadedEvent } from './events/pdf-downloaded-event';
import { PdfLoadedEvent } from './events/pdf-loaded-event';
import { VerbosityLevel } from './options/verbosity-level';
import { FindState, FindResultMatchesCount } from './events/find-result';
import { PdfDummyComponentsComponent } from './pdf-dummy-components/pdf-dummy-components.component';
import { AfterViewInit, ElementRef } from '@angular/core';
import { PDFNotificationService } from './pdf-notification-service';
import { TextLayerRenderedEvent } from './events/textlayer-rendered';
import { Location } from '@angular/common';
export declare class NgxExtendedPdfViewerComponent implements OnInit, AfterViewInit, OnChanges, OnDestroy {
private ngZone;
private platformId;
private notificationService;
private location;
static ngxExtendedPdfViewerInitialized: boolean;
/**
* The dummy components are inserted automatically when the user customizes the toolbar
* without adding every original toolbar item. Without the dummy components, the
* initialization code of pdf.js crashes because it assume that every standard widget is there.
*/
dummyComponents: PdfDummyComponentsComponent;
root: ElementRef;
private pinchOnMobileSupport;
customFindbarInputArea: TemplateRef<any>;
customToolbar: TemplateRef<any>;
customFindbar: TemplateRef<any>;
customFindbarButtons: TemplateRef<any> | undefined;
customSecondaryToolbar: TemplateRef<any>;
private secondaryToolbarComponent;
private _src;
srcChange: EventEmitter<string>;
contextMenuAllowed: boolean;
afterPrint: EventEmitter<void>;
beforePrint: EventEmitter<void>;
currentZoomFactor: EventEmitter<number>;
enablePrint: boolean;
/**
* Number of milliseconds to wait between initializing the PDF viewer and loading the PDF file.
* Most users can let this parameter safely at it's default value of zero.
* Set this to 1000 or higher if you run into timing problems (typically caused by loading the locale files
* after the PDF files, so they are not available when the PDF viewer is initialized).
*/
delayFirstView: number;
/** store the timeout id so it can be canceled if user leaves the page before the PDF is shown */
private initTimeout;
/** How many log messages should be printed?
* Legal values: VerbosityLevel.INFOS (= 5), VerbosityLevel.WARNINGS (= 1), VerbosityLevel.ERRORS (= 0) */
logLevel: VerbosityLevel;
enablePinchOnMobile: boolean;
primaryMenuVisible: boolean;
/** option to increase (or reduce) print resolution. Default is 150 (dpi). Sensible values
* are 300, 600, and 1200. Note the increase memory consumption, which may even result in a browser crash. */
printResolution: any;
rotation: 0 | 90 | 180 | 270;
rotationChange: EventEmitter<0 | 90 | 180 | 270>;
src: string | ArrayBuffer | Blob | Uint8Array;
base64Src: string;
minHeight: string | undefined;
private _height;
height: string;
/**
* If this flag is true, this components adds a link to the locale assets. The pdf viewer
* sees this link and uses it to load the locale files automatically.
* @param useBrowserLocale boolean
*/
useBrowserLocale: boolean;
backgroundColor: string;
/** Allows the user to define the name of the file after clicking "download" */
filenameForDownload: string;
/** Allows the user to disable the keyboard bindings completely */
ignoreKeyboard: boolean;
/** Allows the user to disable a list of key bindings. */
ignoreKeys: Array<string>;
/** Allows the user to enable a list of key bindings explicitly. If this property is set, every other key binding is ignored. */
acceptKeys: Array<string>;
/** Allows the user to put the viewer's svg images into an arbitrary folder */
imageResourcesPath: string;
/** Override the default locale. This must be the complete locale name, such as "es-ES". The string is allowed to be all lowercase.
*/
language: string | undefined;
/** By default, listening to the URL is deactivated because often the anchor tag is used for the Angular router */
listenToURL: boolean;
/** Navigate to a certain "named destination" */
nameddest: string | undefined;
/** allows you to pass a password to read password-protected files */
password: string | undefined;
_showSidebarButton: boolean;
viewerPositionTop: string;
/** pdf.js can show signatures, but fails to verify them. So they are switched off by default.
* Set "[showUnverifiedSignatures]"="true" to display e-signatures nonetheless.
*/
showUnverifiedSignatures: boolean;
startTabindex: number | undefined;
showSidebarButton: boolean;
/** If [showSideBarButton]="true", do you want the sidebar to be shown by default ([showSidebarOnLoad])="true")
* or not? By default, this flag is undefined, telling the PDF viewer to use the last setting used with this particular
* document, or to hide the sidebar if the document is opened for the first time.
* @deprecated Use showSidebar instead; dreprecated since 1.8.0; to be removed with 2.0.0
*/
showSidebarOnLoad: boolean | undefined;
sidebarVisible: boolean | undefined;
sidebarVisibleChange: EventEmitter<boolean>;
showFindButton: boolean | undefined;
showPagingButtons: boolean;
showZoomButtons: boolean;
showPresentationModeButton: boolean;
showOpenFileButton: boolean;
showPrintButton: boolean;
showDownloadButton: boolean;
showBookmarkButton: boolean;
showSecondaryToolbarButton: boolean;
/** Set by the event (secondaryMenuIsEmpty) */
hideKebabMenuForSecondaryToolbar: boolean;
showRotateButton: boolean;
handTool: boolean;
handToolChange: EventEmitter<boolean>;
showHandToolButton: boolean;
showScrollingButton: boolean;
showSpreadButton: boolean;
showPropertiesButton: boolean;
showBorders: boolean;
spread: 'off' | 'even' | 'odd';
spreadChange: EventEmitter<"off" | "even" | "odd">;
page: number | undefined;
pageChange: EventEmitter<number>;
pageLabel: string | undefined;
pageLabelChange: EventEmitter<string>;
pagesLoaded: EventEmitter<PagesLoadedEvent>;
pageRendered: EventEmitter<PageRenderedEvent>;
pdfDownloaded: EventEmitter<PdfDownloadedEvent>;
pdfLoaded: EventEmitter<PdfLoadedEvent>;
pdfLoadingFailed: EventEmitter<Error>;
textLayer: boolean | undefined;
/** deprecated */
textlayerRendered: EventEmitter<TextLayerRenderedEvent>;
textLayerRendered: EventEmitter<TextLayerRenderedEvent>;
updateFindMatchesCount: EventEmitter<FindResultMatchesCount>;
updateFindState: EventEmitter<FindState>;
/** Legal values: undefined, 'auto', 'page-actual', 'page_fit', 'page-width', or '50' (or any other percentage) */
zoom: string | number | undefined;
zoomChange: EventEmitter<string | number>;
/** This attributes allows you to increase the size of the UI elements so you can use them on small mobile devices.
* This attribute is a string with a percent character at the end (e.g. "150%").
*/
_mobileFriendlyZoom: string;
mobileFriendlyZoomScale: number;
toolbarPaddingTop: string;
toolbarWidth: string;
toolbarWidthInPixels: number;
secondaryToolbarTop: string | undefined;
findbarTop: string | undefined;
findbarLeft: string | undefined;
/**
* This attributes allows you to increase the size of the UI elements so you can use them on small mobile devices.
* This attribute is a string with a percent character at the end (e.g. "150%").
*/
mobileFriendlyZoom: string;
/** Deprecated. Please use [mobileFriendlyZoom] instead.
* This attributes allows you to increase the size of the UI elements so you can use them on small mobile devices.
* This attribute is a string with a percent character at the end (e.g. "150%").*/
mobileZoom: string;
private _top;
readonly sidebarPositionTop: string;
calcViewerPositionTop(): void;
constructor(ngZone: NgZone, platformId: any, notificationService: PDFNotificationService, location: Location);
private loadViewer;
emitZoomChange(value: string | number): void;
ngOnInit(): void;
ngAfterViewInit(): void;
private assignTabindexes;
private showElementsRecursively;
private collectElementPositions;
private doInitPDFViewer;
/** Notifies every widget that implements onLibraryInit() that the PDF viewer objects are available */
private afterLibraryInit;
checkHeight(): void;
onSpreadChange(newSpread: 'off' | 'even' | 'odd'): void;
private activateTextlayerIfNecessary;
private overrideDefaultSettings;
private openPDF;
private selectCursorTool;
ngOnDestroy(): void;
private isPrimaryMenuVisible;
ngOnChanges(changes: SimpleChanges): void;
private setZoom;
onResize(): void;
onContextMenu(): boolean;
onSecondaryMenuIsEmpty(hideKebabButton: boolean): void;
}