mirror of
https://github.com/wassname/DefinitelyTyped.git
synced 2026-09-09 11:13:57 +08:00
Merge pull request #6492 from falendary/pdf-zh-fix
fixing untyped arguments
This commit is contained in:
Masahiro Wakame
Vendored
+103
-103
@@ -72,66 +72,66 @@ interface PDFProgressData {
|
||||
interface PDFDocumentProxy {
|
||||
|
||||
/**
|
||||
* Total number of pages the PDF contains.
|
||||
**/
|
||||
* Total number of pages the PDF contains.
|
||||
**/
|
||||
numPages: number;
|
||||
|
||||
/**
|
||||
* A unique ID to identify a PDF. Not guaranteed to be unique. [jbaldwin: haha what]
|
||||
**/
|
||||
* A unique ID to identify a PDF. Not guaranteed to be unique. [jbaldwin: haha what]
|
||||
**/
|
||||
fingerprint: string;
|
||||
|
||||
/**
|
||||
* True if embedded document fonts are in use. Will be set during rendering of the pages.
|
||||
**/
|
||||
* True if embedded document fonts are in use. Will be set during rendering of the pages.
|
||||
**/
|
||||
embeddedFontsUsed(): boolean;
|
||||
|
||||
/**
|
||||
* @param number The page number to get. The first page is 1.
|
||||
* @return A promise that is resolved with a PDFPageProxy.
|
||||
**/
|
||||
* @param number The page number to get. The first page is 1.
|
||||
* @return A promise that is resolved with a PDFPageProxy.
|
||||
**/
|
||||
getPage(number: number): PDFPromise<PDFPageProxy>;
|
||||
|
||||
/**
|
||||
* TODO: return type of Promise<???>
|
||||
* A promise that is resolved with a lookup table for mapping named destinations to reference numbers.
|
||||
**/
|
||||
* TODO: return type of Promise<???>
|
||||
* A promise that is resolved with a lookup table for mapping named destinations to reference numbers.
|
||||
**/
|
||||
getDestinations(): PDFPromise<any[]>;
|
||||
|
||||
/**
|
||||
* A promise that is resolved with an array of all the JavaScript strings in the name tree.
|
||||
**/
|
||||
* A promise that is resolved with an array of all the JavaScript strings in the name tree.
|
||||
**/
|
||||
getJavaScript(): PDFPromise<string[]>;
|
||||
|
||||
/**
|
||||
* A promise that is resolved with an array that is a tree outline (if it has one) of the PDF. @see PDFTreeNode
|
||||
**/
|
||||
* A promise that is resolved with an array that is a tree outline (if it has one) of the PDF. @see PDFTreeNode
|
||||
**/
|
||||
getOutline(): PDFPromise<PDFTreeNode[]>;
|
||||
|
||||
/**
|
||||
* A promise that is resolved with the info and metadata of the PDF.
|
||||
**/
|
||||
* A promise that is resolved with the info and metadata of the PDF.
|
||||
**/
|
||||
getMetadata(): PDFPromise<{ info: PDFInfo; metadata: PDFMetadata }>;
|
||||
|
||||
/**
|
||||
* Is the PDF encrypted?
|
||||
**/
|
||||
* Is the PDF encrypted?
|
||||
**/
|
||||
isEncrypted(): PDFPromise<boolean>;
|
||||
|
||||
/**
|
||||
* A promise that is resolved with Uint8Array that has the raw PDF data.
|
||||
**/
|
||||
* A promise that is resolved with Uint8Array that has the raw PDF data.
|
||||
**/
|
||||
getData(): PDFPromise<Uint8Array>;
|
||||
|
||||
/**
|
||||
* TODO: return type of Promise<???>
|
||||
* A promise that is resolved when the document's data is loaded.
|
||||
**/
|
||||
* TODO: return type of Promise<???>
|
||||
* A promise that is resolved when the document's data is loaded.
|
||||
**/
|
||||
dataLoaded(): PDFPromise<any[]>;
|
||||
|
||||
/**
|
||||
*
|
||||
**/
|
||||
*
|
||||
**/
|
||||
destroy(): void;
|
||||
}
|
||||
|
||||
@@ -173,11 +173,11 @@ interface PDFAnnotationData {
|
||||
interface PDFAnnotations {
|
||||
getData(): PDFAnnotationData;
|
||||
hasHtml(): boolean; // always false
|
||||
getHtmlElement(commonOjbs): HTMLElement; // throw new NotImplementedException()
|
||||
getHtmlElement(commonOjbs: any): HTMLElement; // throw new NotImplementedException()
|
||||
getEmptyContainer(tagName: string, rect: number[]): HTMLElement; // deprecated
|
||||
isViewable(): boolean;
|
||||
loadResources(keys): PDFPromise<any>;
|
||||
getOperatorList(evaluator): PDFPromise<any>;
|
||||
loadResources(keys: any): PDFPromise<any>;
|
||||
getOperatorList(evaluator: any): PDFPromise<any>;
|
||||
// ... todo
|
||||
}
|
||||
|
||||
@@ -206,142 +206,142 @@ interface PDFViewerParams {
|
||||
}
|
||||
|
||||
/**
|
||||
* RenderTask is basically a promise but adds a cancel function to termiate it.
|
||||
**/
|
||||
* RenderTask is basically a promise but adds a cancel function to termiate it.
|
||||
**/
|
||||
interface PDFRenderTask extends PDFPromise<PDFPageProxy> {
|
||||
|
||||
/**
|
||||
* Cancel the rendering task. If the task is currently rendering it will not be cancelled until graphics pauses with a timeout. The promise that this object extends will resolve when cancelled.
|
||||
**/
|
||||
* Cancel the rendering task. If the task is currently rendering it will not be cancelled until graphics pauses with a timeout. The promise that this object extends will resolve when cancelled.
|
||||
**/
|
||||
cancel(): void;
|
||||
}
|
||||
|
||||
interface PDFPageProxy {
|
||||
|
||||
/**
|
||||
* Page number of the page. First page is 1.
|
||||
**/
|
||||
* Page number of the page. First page is 1.
|
||||
**/
|
||||
pageNumber(): number;
|
||||
|
||||
/**
|
||||
* The number of degrees the page is rotated clockwise.
|
||||
**/
|
||||
* The number of degrees the page is rotated clockwise.
|
||||
**/
|
||||
rotate(): number;
|
||||
|
||||
/**
|
||||
* The reference that points to this page.
|
||||
**/
|
||||
* The reference that points to this page.
|
||||
**/
|
||||
ref(): PDFRef;
|
||||
|
||||
/**
|
||||
* @return An array of the visible portion of the PDF page in the user space units - [x1, y1, x2, y2].
|
||||
**/
|
||||
* @return An array of the visible portion of the PDF page in the user space units - [x1, y1, x2, y2].
|
||||
**/
|
||||
view(): number[];
|
||||
|
||||
/**
|
||||
* @param scale The desired scale of the viewport.
|
||||
* @param rotate Degrees to rotate the viewport. If omitted this defaults to the page rotation.
|
||||
* @return
|
||||
**/
|
||||
* @param scale The desired scale of the viewport.
|
||||
* @param rotate Degrees to rotate the viewport. If omitted this defaults to the page rotation.
|
||||
* @return
|
||||
**/
|
||||
getViewport(scale: number, rotate?: number): PDFPageViewport;
|
||||
|
||||
/**
|
||||
* A promise that is resolved with an array of the annotation objects.
|
||||
**/
|
||||
* A promise that is resolved with an array of the annotation objects.
|
||||
**/
|
||||
getAnnotations(): PDFPromise<PDFAnnotations>;
|
||||
|
||||
/**
|
||||
* Begins the process of rendering a page to the desired context.
|
||||
* @param params Rendering options.
|
||||
* @return An extended promise that is resolved when the page finishes rendering.
|
||||
**/
|
||||
* Begins the process of rendering a page to the desired context.
|
||||
* @param params Rendering options.
|
||||
* @return An extended promise that is resolved when the page finishes rendering.
|
||||
**/
|
||||
render(params: PDFRenderParams): PDFRenderTask;
|
||||
|
||||
/**
|
||||
* A promise that is resolved with the string that is the text content frm the page.
|
||||
**/
|
||||
getTextContent(): PDFPromise<TextContent>;
|
||||
* A promise that is resolved with the string that is the text content frm the page.
|
||||
**/
|
||||
getTextContent(): PDFPromise<TextContent>;
|
||||
|
||||
/**
|
||||
* marked as future feature
|
||||
**/
|
||||
* marked as future feature
|
||||
**/
|
||||
//getOperationList(): PDFPromise<>;
|
||||
|
||||
/**
|
||||
* Destroyes resources allocated by the page.
|
||||
**/
|
||||
* Destroyes resources allocated by the page.
|
||||
**/
|
||||
destroy(): void;
|
||||
}
|
||||
|
||||
interface TextContentItem {
|
||||
str: string;
|
||||
transform: number[]; // [0..5] 4=x, 5=y
|
||||
width: number;
|
||||
height: number;
|
||||
dir: string; // Left-to-right (ltr), etc
|
||||
fontName: string; // A lookup into the styles map of the owning TextContent
|
||||
str: string;
|
||||
transform: number[]; // [0..5] 4=x, 5=y
|
||||
width: number;
|
||||
height: number;
|
||||
dir: string; // Left-to-right (ltr), etc
|
||||
fontName: string; // A lookup into the styles map of the owning TextContent
|
||||
}
|
||||
|
||||
interface TextContent {
|
||||
items: TextContentItem[];
|
||||
styles: any;
|
||||
items: TextContentItem[];
|
||||
styles: any;
|
||||
}
|
||||
|
||||
/**
|
||||
* A PDF document and page is built of many objects. E.g. there are objects for fonts, images, rendering code and such. These objects might get processed inside of a worker. The `PDFObjects` implements some basic functions to manage these objects.
|
||||
**/
|
||||
* A PDF document and page is built of many objects. E.g. there are objects for fonts, images, rendering code and such. These objects might get processed inside of a worker. The `PDFObjects` implements some basic functions to manage these objects.
|
||||
**/
|
||||
interface PDFObjects {
|
||||
get(objId, callback?): any;
|
||||
resolve(objId, data);
|
||||
isResolved(objId): boolean;
|
||||
hasData(objId): boolean;
|
||||
getData(objId): any;
|
||||
get(objId: number, callback?: any): any;
|
||||
resolve(objId: number, data: any): any;
|
||||
isResolved(objId: number): boolean;
|
||||
hasData(objId: number): boolean;
|
||||
getData(objId: number): any;
|
||||
clear(): void;
|
||||
}
|
||||
|
||||
interface PDFJSStatic {
|
||||
|
||||
/**
|
||||
* The maximum allowed image size in total pixels e.g. width * height. Images above this value will not be drawn. Use -1 for no limit.
|
||||
**/
|
||||
* The maximum allowed image size in total pixels e.g. width * height. Images above this value will not be drawn. Use -1 for no limit.
|
||||
**/
|
||||
maxImageSize: number;
|
||||
|
||||
/**
|
||||
* By default fonts are converted to OpenType fonts and loaded via font face rules. If disabled, the font will be rendered using a built in font renderer that constructs the glyphs with primitive path commands.
|
||||
**/
|
||||
* By default fonts are converted to OpenType fonts and loaded via font face rules. If disabled, the font will be rendered using a built in font renderer that constructs the glyphs with primitive path commands.
|
||||
**/
|
||||
disableFontFace: boolean;
|
||||
|
||||
/**
|
||||
* This is the main entry point for loading a PDF and interacting with it.
|
||||
* NOTE: If a URL is used to fetch the PDF data a standard XMLHttpRequest(XHR)
|
||||
* is used, which means it must follow the same origin rules that any XHR does
|
||||
* e.g. No corss domain requests without CORS.
|
||||
* @param source
|
||||
* @param pdfDataRangeTransport Used if you want to manually server range requests for data in the PDF. @ee viewer.js for an example of pdfDataRangeTransport's interface.
|
||||
* @param passwordCallback Used to request a password if wrong or no password was provided. The callback receives two parameters: function that needs to be called with new password and the reason.
|
||||
* @param progressCallback Progress callback.
|
||||
* @return A promise that is resolved with PDFDocumentProxy object.
|
||||
**/
|
||||
* This is the main entry point for loading a PDF and interacting with it.
|
||||
* NOTE: If a URL is used to fetch the PDF data a standard XMLHttpRequest(XHR)
|
||||
* is used, which means it must follow the same origin rules that any XHR does
|
||||
* e.g. No corss domain requests without CORS.
|
||||
* @param source
|
||||
* @param pdfDataRangeTransport Used if you want to manually server range requests for data in the PDF. @ee viewer.js for an example of pdfDataRangeTransport's interface.
|
||||
* @param passwordCallback Used to request a password if wrong or no password was provided. The callback receives two parameters: function that needs to be called with new password and the reason.
|
||||
* @param progressCallback Progress callback.
|
||||
* @return A promise that is resolved with PDFDocumentProxy object.
|
||||
**/
|
||||
getDocument(
|
||||
source: string,
|
||||
pdfDataRangeTransport?,
|
||||
passwordCallback?: (fn: (password: string) => void, reason: string) => string,
|
||||
progressCallback?: (progressData: PDFProgressData) => void)
|
||||
: PDFPromise<PDFDocumentProxy>;
|
||||
source: string,
|
||||
pdfDataRangeTransport?: any,
|
||||
passwordCallback?: (fn: (password: string) => void, reason: string) => string,
|
||||
progressCallback?: (progressData: PDFProgressData) => void)
|
||||
: PDFPromise<PDFDocumentProxy>;
|
||||
|
||||
getDocument(
|
||||
source: Uint8Array,
|
||||
pdfDataRangeTransport?,
|
||||
passwordCallback?: (fn: (password: string) => void, reason: string) => string,
|
||||
progressCallback?: (progressData: PDFProgressData) => void)
|
||||
: PDFPromise<PDFDocumentProxy>;
|
||||
source: Uint8Array,
|
||||
pdfDataRangeTransport?: any,
|
||||
passwordCallback?: (fn: (password: string) => void, reason: string) => string,
|
||||
progressCallback?: (progressData: PDFProgressData) => void)
|
||||
: PDFPromise<PDFDocumentProxy>;
|
||||
|
||||
getDocument(
|
||||
source: PDFSource,
|
||||
pdfDataRangeTransport?,
|
||||
passwordCallback?: (fn: (password: string) => void, reason: string) => string,
|
||||
progressCallback?: (progressData: PDFProgressData) => void)
|
||||
: PDFPromise<PDFDocumentProxy>;
|
||||
source: PDFSource,
|
||||
pdfDataRangeTransport?: any,
|
||||
passwordCallback?: (fn: (password: string) => void, reason: string) => string,
|
||||
progressCallback?: (progressData: PDFProgressData) => void)
|
||||
: PDFPromise<PDFDocumentProxy>;
|
||||
|
||||
PDFViewer(params: PDFViewerParams): void;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user