pdfjs-dist
Version:
Generic build of Mozilla's PDF.js library.
246 lines (245 loc) • 8.88 kB
TypeScript
export type PageViewportParameters = {
/**
* - The xMin, yMin, xMax and
* yMax coordinates.
*/
viewBox: Array<number>;
/**
* - The scale of the viewport.
*/
scale: number;
/**
* - The rotation, in degrees, of the viewport.
*/
rotation: number;
/**
* - The horizontal, i.e. x-axis, offset. The
* default value is `0`.
*/
offsetX?: number | undefined;
/**
* - The vertical, i.e. y-axis, offset. The
* default value is `0`.
*/
offsetY?: number | undefined;
/**
* - If true, the y-axis will not be flipped.
* The default value is `false`.
*/
dontFlip?: boolean | undefined;
};
export type PageViewportCloneParameters = {
/**
* - The scale, overriding the one in the cloned
* viewport. The default value is `this.scale`.
*/
scale?: number | undefined;
/**
* - The rotation, in degrees, overriding the one
* in the cloned viewport. The default value is `this.rotation`.
*/
rotation?: number | undefined;
/**
* - The horizontal, i.e. x-axis, offset.
* The default value is `this.offsetX`.
*/
offsetX?: number | undefined;
/**
* - The vertical, i.e. y-axis, offset.
* The default value is `this.offsetY`.
*/
offsetY?: number | undefined;
/**
* - If true, the x-axis will not be flipped.
* The default value is `false`.
*/
dontFlip?: boolean | undefined;
};
export const AnnotationPrefix: "pdfjs_internal_id_";
export function deprecated(details: any): void;
export class DOMCanvasFactory extends BaseCanvasFactory {
constructor({ ownerDocument }?: {
ownerDocument?: Document | undefined;
});
_document: Document;
/**
* @ignore
*/
_createCanvas(width: any, height: any): HTMLCanvasElement;
}
export class DOMCMapReaderFactory extends BaseCMapReaderFactory {
/**
* @ignore
*/
_fetchData(url: any, compressionType: any): Promise<{
cMapData: any;
compressionType: any;
}>;
}
export class DOMStandardFontDataFactory extends BaseStandardFontDataFactory {
/**
* @ignore
*/
_fetchData(url: any): Promise<any>;
}
export class DOMSVGFactory extends BaseSVGFactory {
/**
* @ignore
*/
_createSVG(type: any): any;
}
export function getColorValues(colors: any): void;
export function getCurrentTransform(ctx: any): any[];
export function getCurrentTransformInverse(ctx: any): any[];
/**
* Gets the filename from a given URL.
* @param {string} url
* @param {boolean} [onlyStripPath]
* @returns {string}
*/
export function getFilenameFromUrl(url: string, onlyStripPath?: boolean | undefined): string;
/**
* Returns the filename or guessed filename from the url (see issue 3455).
* @param {string} url - The original PDF location.
* @param {string} defaultFilename - The value returned if the filename is
* unknown, or the protocol is unsupported.
* @returns {string} Guessed PDF filename.
*/
export function getPdfFilenameFromUrl(url: string, defaultFilename?: string): string;
export function getRGB(color: any): any;
/**
* NOTE: This is (mostly) intended to support printing of XFA forms.
*/
export function getXfaPageViewport(xfaPage: any, { scale, rotation }: {
scale?: number | undefined;
rotation?: number | undefined;
}): PageViewport;
export function isDataScheme(url: any): boolean;
export function isPdfFile(filename: any): boolean;
export function isValidFetchUrl(url: any, baseUrl: any): boolean;
/**
* @param {string} src
* @param {boolean} [removeScriptElement]
* @returns {Promise<void>}
*/
export function loadScript(src: string, removeScriptElement?: boolean | undefined): Promise<void>;
/**
* @typedef {Object} PageViewportParameters
* @property {Array<number>} viewBox - The xMin, yMin, xMax and
* yMax coordinates.
* @property {number} scale - The scale of the viewport.
* @property {number} rotation - The rotation, in degrees, of the viewport.
* @property {number} [offsetX] - The horizontal, i.e. x-axis, offset. The
* default value is `0`.
* @property {number} [offsetY] - The vertical, i.e. y-axis, offset. The
* default value is `0`.
* @property {boolean} [dontFlip] - If true, the y-axis will not be flipped.
* The default value is `false`.
*/
/**
* @typedef {Object} PageViewportCloneParameters
* @property {number} [scale] - The scale, overriding the one in the cloned
* viewport. The default value is `this.scale`.
* @property {number} [rotation] - The rotation, in degrees, overriding the one
* in the cloned viewport. The default value is `this.rotation`.
* @property {number} [offsetX] - The horizontal, i.e. x-axis, offset.
* The default value is `this.offsetX`.
* @property {number} [offsetY] - The vertical, i.e. y-axis, offset.
* The default value is `this.offsetY`.
* @property {boolean} [dontFlip] - If true, the x-axis will not be flipped.
* The default value is `false`.
*/
/**
* PDF page viewport created based on scale, rotation and offset.
*/
export class PageViewport {
/**
* @param {PageViewportParameters}
*/
constructor({ viewBox, scale, rotation, offsetX, offsetY, dontFlip, }: PageViewportParameters);
viewBox: number[];
scale: number;
rotation: number;
offsetX: number;
offsetY: number;
transform: number[];
width: number;
height: number;
/**
* Clones viewport, with optional additional properties.
* @param {PageViewportCloneParameters} [params]
* @returns {PageViewport} Cloned viewport.
*/
clone({ scale, rotation, offsetX, offsetY, dontFlip, }?: PageViewportCloneParameters | undefined): PageViewport;
/**
* Converts PDF point to the viewport coordinates. For examples, useful for
* converting PDF location into canvas pixel coordinates.
* @param {number} x - The x-coordinate.
* @param {number} y - The y-coordinate.
* @returns {Object} Object containing `x` and `y` properties of the
* point in the viewport coordinate space.
* @see {@link convertToPdfPoint}
* @see {@link convertToViewportRectangle}
*/
convertToViewportPoint(x: number, y: number): Object;
/**
* Converts PDF rectangle to the viewport coordinates.
* @param {Array} rect - The xMin, yMin, xMax and yMax coordinates.
* @returns {Array} Array containing corresponding coordinates of the
* rectangle in the viewport coordinate space.
* @see {@link convertToViewportPoint}
*/
convertToViewportRectangle(rect: any[]): any[];
/**
* Converts viewport coordinates to the PDF location. For examples, useful
* for converting canvas pixel location into PDF one.
* @param {number} x - The x-coordinate.
* @param {number} y - The y-coordinate.
* @returns {Object} Object containing `x` and `y` properties of the
* point in the PDF coordinate space.
* @see {@link convertToViewportPoint}
*/
convertToPdfPoint(x: number, y: number): Object;
}
export class PDFDateString {
/**
* Convert a PDF date string to a JavaScript `Date` object.
*
* The PDF date string format is described in section 7.9.4 of the official
* PDF 32000-1:2008 specification. However, in the PDF 1.7 reference (sixth
* edition) Adobe describes the same format including a trailing apostrophe.
* This syntax in incorrect, but Adobe Acrobat creates PDF files that contain
* them. We ignore all apostrophes as they are not necessary for date parsing.
*
* Moreover, Adobe Acrobat doesn't handle changing the date to universal time
* and doesn't use the user's time zone (effectively ignoring the HH' and mm'
* parts of the date string).
*
* @param {string} input
* @returns {Date|null}
*/
static toDateObject(input: string): Date | null;
}
export class PixelsPerInch {
static CSS: number;
static PDF: number;
static PDF_TO_CSS_UNITS: number;
}
declare const RenderingCancelledException_base: any;
export class RenderingCancelledException extends RenderingCancelledException_base {
[x: string]: any;
constructor(msg: any, type: any);
type: any;
}
export class StatTimer {
started: any;
times: any[];
time(name: any): void;
timeEnd(name: any): void;
toString(): string;
}
import { BaseCanvasFactory } from "./base_factory.js";
import { BaseCMapReaderFactory } from "./base_factory.js";
import { BaseStandardFontDataFactory } from "./base_factory.js";
import { BaseSVGFactory } from "./base_factory.js";
export {};