WorkerPDFiumDocument
Defined in: src/context/worker-client.ts:287
High-level worker-backed PDF document.
Extends
Section titled “Extends”Properties
Section titled “Properties”pageCount
Section titled “pageCount”
readonlypageCount:number
Defined in: src/context/worker-client.ts:296
Number of pages in this document.
Accessors
Section titled “Accessors”disposed
Section titled “disposed”Get Signature
Section titled “Get Signature”get disposed():
boolean
Defined in: src/core/disposable.ts:74
Whether this resource has been disposed.
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”Get Signature
Section titled “Get Signature”get id():
string
Defined in: src/context/worker-client.ts:310
Internal document ID used by the worker protocol.
Returns
Section titled “Returns”string
Methods
Section titled “Methods”[asyncDispose]()
Section titled “[asyncDispose]()”[asyncDispose]():
Promise<void>
Defined in: src/core/disposable.ts:210
Asynchronously dispose of this resource.
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”AsyncDisposable.[asyncDispose]
createNUp()
Section titled “createNUp()”createNUp(
options):Promise<WorkerPDFiumDocument>
Defined in: src/context/worker-client.ts:402
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options | NUpLayoutOptions |
Returns
Section titled “Returns”Promise<WorkerPDFiumDocument>
deletePage()
Section titled “deletePage()”deletePage(
pageIndex):Promise<void>
Defined in: src/context/worker-client.ts:450
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
pageIndex | number |
Returns
Section titled “Returns”Promise<void>
dispose()
Section titled “dispose()”dispose():
Promise<void>
Defined in: src/core/disposable.ts:221
Alias for Symbol.asyncDispose for explicit calls.
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”getAllPageDimensions()
Section titled “getAllPageDimensions()”getAllPageDimensions():
Promise<object[]>
Defined in: src/context/worker-client.ts:376
Returns
Section titled “Returns”Promise<object[]>
getAttachments()
Section titled “getAttachments()”getAttachments():
Promise<SerialisedAttachment[]>
Defined in: src/context/worker-client.ts:356
Returns
Section titled “Returns”Promise<SerialisedAttachment[]>
getBookmarks()
Section titled “getBookmarks()”getBookmarks():
Promise<Bookmark[]>
Defined in: src/context/worker-client.ts:351
Returns
Section titled “Returns”Promise<Bookmark[]>
getDocumentInfo()
Section titled “getDocumentInfo()”getDocumentInfo():
Promise<DocumentInfoResponse>
Defined in: src/context/worker-client.ts:346
Returns
Section titled “Returns”Promise<DocumentInfoResponse>
getExtendedDocumentInfo()
Section titled “getExtendedDocumentInfo()”getExtendedDocumentInfo():
Promise<ExtendedDocumentInfoResponse>
Defined in: src/context/worker-client.ts:441
Returns
Section titled “Returns”Promise<ExtendedDocumentInfoResponse>
getJavaScriptActions()
Section titled “getJavaScriptActions()”getJavaScriptActions():
Promise<JavaScriptAction[]>
Defined in: src/context/worker-client.ts:426
Returns
Section titled “Returns”Promise<JavaScriptAction[]>
getMetadata()
Section titled “getMetadata()”getMetadata():
Promise<DocumentMetadata>
Defined in: src/context/worker-client.ts:411
Returns
Section titled “Returns”Promise<DocumentMetadata>
getNamedDestinationByName()
Section titled “getNamedDestinationByName()”getNamedDestinationByName(
name):Promise<NamedDestination|null>
Defined in: src/context/worker-client.ts:366
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
name | string |
Returns
Section titled “Returns”Promise<NamedDestination | null>
getNamedDestinations()
Section titled “getNamedDestinations()”getNamedDestinations():
Promise<NamedDestination[]>
Defined in: src/context/worker-client.ts:361
Returns
Section titled “Returns”Promise<NamedDestination[]>
getPage()
Section titled “getPage()”getPage(
pageIndex):Promise<WorkerPDFiumPage>
Defined in: src/context/worker-client.ts:317
Load a page and return a worker-backed page object.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
pageIndex | number |
Returns
Section titled “Returns”Promise<WorkerPDFiumPage>
getPageLabel()
Section titled “getPageLabel()”getPageLabel(
pageIndex):Promise<string|null>
Defined in: src/context/worker-client.ts:371
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
pageIndex | number |
Returns
Section titled “Returns”Promise<string | null>
getPermissions()
Section titled “getPermissions()”getPermissions():
Promise<DocumentPermissions>
Defined in: src/context/worker-client.ts:416
Returns
Section titled “Returns”Promise<DocumentPermissions>
getPrintPageRanges()
Section titled “getPrintPageRanges()”getPrintPageRanges():
Promise<number[] |undefined>
Defined in: src/context/worker-client.ts:436
Returns
Section titled “Returns”Promise<number[] | undefined>
getSignatures()
Section titled “getSignatures()”getSignatures():
Promise<SerialisedSignature[]>
Defined in: src/context/worker-client.ts:431
Returns
Section titled “Returns”Promise<SerialisedSignature[]>
getViewerPreferences()
Section titled “getViewerPreferences()”getViewerPreferences():
Promise<ViewerPreferences>
Defined in: src/context/worker-client.ts:421
Returns
Section titled “Returns”Promise<ViewerPreferences>
importPages()
Section titled “importPages()”importPages(
sourceDocument,options?):Promise<void>
Defined in: src/context/worker-client.ts:397
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
sourceDocument | WorkerPDFiumDocument |
options? | ImportPagesOptions |
Returns
Section titled “Returns”Promise<void>
insertBlankPage()
Section titled “insertBlankPage()”insertBlankPage(
pageIndex,width,height):Promise<void>
Defined in: src/context/worker-client.ts:455
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
pageIndex | number |
width | number |
height | number |
Returns
Section titled “Returns”Promise<void>
killFormFocus()
Section titled “killFormFocus()”killFormFocus():
Promise<boolean>
Defined in: src/context/worker-client.ts:387
Returns
Section titled “Returns”Promise<boolean>
movePages()
Section titled “movePages()”movePages(
pageIndices,destPageIndex):Promise<void>
Defined in: src/context/worker-client.ts:460
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
pageIndices | number[] |
destPageIndex | number |
Returns
Section titled “Returns”Promise<void>
renderPage()
Section titled “renderPage()”renderPage(
pageIndex,options,onProgress?):Promise<RenderResult>
Defined in: src/context/worker-client.ts:333
High-level convenience rendering method.
Uses a single worker round-trip to load, render, and close the page (instead of 3 sequential round-trips).
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
pageIndex | number |
options | RenderOptions |
onProgress? | ProgressCallback |
Returns
Section titled “Returns”Promise<RenderResult>
save()
Section titled “save()”save(
options?):Promise<Uint8Array<ArrayBufferLike>>
Defined in: src/context/worker-client.ts:381
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options? | SaveOptions |
Returns
Section titled “Returns”Promise<Uint8Array<ArrayBufferLike>>
setFormHighlight()
Section titled “setFormHighlight()”setFormHighlight(
fieldType,colour,alpha):Promise<void>
Defined in: src/context/worker-client.ts:392
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
fieldType | FormFieldType |
colour | Colour |
alpha | number |
Returns
Section titled “Returns”Promise<void>