IPageReader
Defined in: src/core/interfaces.ts:96
Interface for interacting with a PDF page.
Extends
Section titled “Extends”Disposable
Properties
Section titled “Properties”height
Section titled “height”
readonlyheight:number
Defined in: src/core/interfaces.ts:103
readonlyindex:number
Defined in: src/core/interfaces.ts:98
The zero-based index of this page.
rotation
Section titled “rotation”rotation:
PageRotation
Defined in: src/core/interfaces.ts:106
Page rotation.
readonlysize:PageSize
Defined in: src/core/interfaces.ts:101
Page dimensions.
readonlywidth:number
Defined in: src/core/interfaces.ts:102
Methods
Section titled “Methods”[dispose]()
Section titled “[dispose]()”[dispose]():
void
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.esnext.disposable.d.ts:36
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Disposable.[dispose]
findText()
Section titled “findText()”findText(
query,flags?):IterableIterator<TextSearchResult>
Defined in: src/core/interfaces.ts:115
Find text occurrences.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
query | string |
flags? | TextSearchFlags |
Returns
Section titled “Returns”IterableIterator<TextSearchResult>
getAnnotations()
Section titled “getAnnotations()”getAnnotations():
Annotation[]
Defined in: src/core/interfaces.ts:118
Get annotations.
Returns
Section titled “Returns”getObjects()
Section titled “getObjects()”getObjects():
PDFiumPageObject[]
Defined in: src/core/interfaces.ts:127
Get page objects.
Returns
Section titled “Returns”getPageBox()
Section titled “getPageBox()”getPageBox(
boxType):PageBox|undefined
Defined in: src/core/interfaces.ts:109
Get specific page box.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
boxType | PageBoxType |
Returns
Section titled “Returns”PageBox | undefined
getText()
Section titled “getText()”getText():
string
Defined in: src/core/interfaces.ts:112
Get text content.
Returns
Section titled “Returns”string
objects()
Section titled “objects()”objects():
IterableIterator<PDFiumPageObject>
Defined in: src/core/interfaces.ts:128
Returns
Section titled “Returns”IterableIterator<PDFiumPageObject>
render()
Section titled “render()”render(
options?):RenderResult
Defined in: src/core/interfaces.ts:121
Render the page.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options? | RenderOptions |
Returns
Section titled “Returns”startProgressiveRender()
Section titled “startProgressiveRender()”startProgressiveRender(
options?):IProgressiveRenderContext
Defined in: src/core/interfaces.ts:124
Start progressive render.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options? | RenderOptions |