WorkerPDFiumPage

@scaryterry/pdfium

---

Defined in: src/context/worker-client.ts:490

High-level worker-backed PDF page.

Extends

• AsyncDisposable

Properties

height

readonly height: number

Defined in: src/context/worker-client.ts:506

Page height in points.

---

index

readonly index: number

Defined in: src/context/worker-client.ts:498

Zero-based page index.

---

width

readonly width: number

Defined in: src/context/worker-client.ts:502

Page width in points.

Accessors

disposed

Get Signature

get disposed(): boolean

Defined in: src/core/disposable.ts:74

Whether this resource has been disposed.

Returns

boolean

Inherited from

AsyncDisposable.disposed

---

id

Get Signature

get id(): string

Defined in: src/context/worker-client.ts:522

Internal page ID used by the worker protocol.

Returns

string

Methods

[asyncDispose]()

[asyncDispose](): Promise<void>

Defined in: src/core/disposable.ts:210

Asynchronously dispose of this resource.

Returns

Promise<void>

Inherited from

AsyncDisposable.[asyncDispose]

---

addInkStroke()

addInkStroke(annotationIndex, points): Promise<number>

Defined in: src/context/worker-client.ts:722

Parameters

Parameter	Type
annotationIndex	number
points	object[]

Returns

Promise<number>

---

appendAnnotationAttachmentPoints()

appendAnnotationAttachmentPoints(annotationIndex, points): Promise<boolean>

Defined in: src/context/worker-client.ts:712

Parameters

Parameter	Type
annotationIndex	number
points	SerialisedQuadPoints

Returns

Promise<boolean>

---

applyRedactions()

applyRedactions(fillColour?, removeIntersectingAnnotations?): Promise<{ appliedRegionCount: number; insertedFillObjectCount: number; removedAnnotationCount: number; removedObjectCount: number; }>

Defined in: src/context/worker-client.ts:618

Parameters

Parameter	Type
fillColour?	Colour
removeIntersectingAnnotations?	boolean

Returns

Promise<{ appliedRegionCount: number; insertedFillObjectCount: number; removedAnnotationCount: number; removedObjectCount: number; }>

---

canFormUndo()

canFormUndo(): Promise<boolean>

Defined in: src/context/worker-client.ts:645

Returns

Promise<boolean>

---

createAnnotation()

createAnnotation(subtype): Promise<SerialisedAnnotation>

Defined in: src/context/worker-client.ts:659

Parameters

Parameter	Type
subtype	AnnotationType

Returns

Promise<SerialisedAnnotation>

---

dispose()

dispose(): Promise<void>

Defined in: src/core/disposable.ts:221

Alias for Symbol.asyncDispose for explicit calls.

Returns

Promise<void>

Inherited from

AsyncDisposable.dispose

---

findText()

findText(query, flags?): Promise<TextSearchResult[]>

Defined in: src/context/worker-client.ts:594

Parameters

Parameter	Type
query	string
flags?	TextSearchFlags

Returns

Promise<TextSearchResult[]>

---

flatten()

flatten(flags?): Promise<FlattenResult>

Defined in: src/context/worker-client.ts:613

Parameters

Parameter	Type
flags?	FlattenFlags

Returns

Promise<FlattenResult>

---

formUndo()

formUndo(): Promise<boolean>

Defined in: src/context/worker-client.ts:650

Returns

Promise<boolean>

---

generateContent()

generateContent(): Promise<boolean>

Defined in: src/context/worker-client.ts:727

Returns

Promise<boolean>

---

getAnnotations()

getAnnotations(): Promise<SerialisedAnnotation[]>

Defined in: src/context/worker-client.ts:559

Returns

Promise<SerialisedAnnotation[]>

---

getCharacterInfo()

getCharacterInfo(charIndex): Promise<CharacterInfo | undefined>

Defined in: src/context/worker-client.ts:599

Parameters

Parameter	Type
charIndex	number

Returns

Promise<CharacterInfo | undefined>

---

getCharAtPos()

getCharAtPos(x, y): Promise<CharAtPosResponse | null>

Defined in: src/context/worker-client.ts:584

Parameters

Parameter	Type
x	number
y	number

Returns

Promise<CharAtPosResponse | null>

---

getCharBox()

getCharBox(charIndex): Promise<CharBox | undefined>

Defined in: src/context/worker-client.ts:604

Parameters

Parameter	Type
charIndex	number

Returns

Promise<CharBox | undefined>

---

getFormSelectedText()

getFormSelectedText(): Promise<string | null>

Defined in: src/context/worker-client.ts:640

Returns

Promise<string | null>

---

getFormWidgets()

getFormWidgets(): Promise<SerialisedFormWidget[]>

Defined in: src/context/worker-client.ts:631

Returns

Promise<SerialisedFormWidget[]>

---

getLinks()

getLinks(): Promise<SerialisedLink[]>

Defined in: src/context/worker-client.ts:569

Returns

Promise<SerialisedLink[]>

---

getPageInfo()

getPageInfo(): Promise<PageInfoResponse>

Defined in: src/context/worker-client.ts:554

Returns

Promise<PageInfoResponse>

---

getPageObjects()

getPageObjects(): Promise<SerialisedPageObject[]>

Defined in: src/context/worker-client.ts:564

Returns

Promise<SerialisedPageObject[]>

---

getStructureTree()

getStructureTree(): Promise<StructureElement[] | null>

Defined in: src/context/worker-client.ts:579

Returns

Promise<StructureElement[] | null>

---

getText()

getText(): Promise<string>

Defined in: src/context/worker-client.ts:537

Extract text from this page.

Returns

Promise<string>

---

getTextInRect()

getTextInRect(left, top, right, bottom): Promise<string>

Defined in: src/context/worker-client.ts:589

Parameters

Parameter	Type
left	number
top	number
right	number
bottom	number

Returns

Promise<string>

---

getTextLayout()

getTextLayout(): Promise<{ rects: Float32Array; text: string; }>

Defined in: src/context/worker-client.ts:545

Extract text and text rectangles from this page.

Returns

Promise<{ rects: Float32Array; text: string; }>

---

getWebLinks()

getWebLinks(): Promise<WebLink[]>

Defined in: src/context/worker-client.ts:574

Returns

Promise<WebLink[]>

---

removeAnnotation()

removeAnnotation(annotationIndex): Promise<boolean>

Defined in: src/context/worker-client.ts:664

Parameters

Parameter	Type
annotationIndex	number

Returns

Promise<boolean>

---

render()

render(options, onProgress?): Promise<RenderResult>

Defined in: src/context/worker-client.ts:529

Render this page.

Parameters

Parameter	Type
options	RenderOptions
onProgress?	ProgressCallback

Returns

Promise<RenderResult>

---

setAnnotationAttachmentPoints()

setAnnotationAttachmentPoints(annotationIndex, quadIndex, points): Promise<boolean>

Defined in: src/context/worker-client.ts:703

Parameters

Parameter	Type
annotationIndex	number
quadIndex	number
points	SerialisedQuadPoints

Returns

Promise<boolean>

---

setAnnotationBorder()

setAnnotationBorder(annotationIndex, hRadius, vRadius, borderWidth): Promise<boolean>

Defined in: src/context/worker-client.ts:693

Parameters

Parameter	Type
annotationIndex	number
hRadius	number
vRadius	number
borderWidth	number

Returns

Promise<boolean>

---

setAnnotationColour()

setAnnotationColour(annotationIndex, colourType, colour): Promise<boolean>

Defined in: src/context/worker-client.ts:674

Parameters

Parameter	Type
annotationIndex	number
colourType	AnnotationColourType
colour	Colour

Returns

Promise<boolean>

---

setAnnotationFlags()

setAnnotationFlags(annotationIndex, flags): Promise<boolean>

Defined in: src/context/worker-client.ts:683

Parameters

Parameter	Type
annotationIndex	number
flags	number

Returns

Promise<boolean>

---

setAnnotationRect()

setAnnotationRect(annotationIndex, rect): Promise<boolean>

Defined in: src/context/worker-client.ts:669

Parameters

Parameter	Type
annotationIndex	number
rect	Rect

Returns

Promise<boolean>

---

setAnnotationString()

setAnnotationString(annotationIndex, key, value): Promise<boolean>

Defined in: src/context/worker-client.ts:688

Parameters

Parameter	Type
annotationIndex	number
key	string
value	string

Returns

Promise<boolean>

---

setAnnotationURI()

setAnnotationURI(annotationIndex, uri): Promise<boolean>

Defined in: src/context/worker-client.ts:717

Parameters

Parameter	Type
annotationIndex	number
uri	string

Returns

Promise<boolean>

---

setRotation()

setRotation(rotation): Promise<void>

Defined in: src/context/worker-client.ts:736

Parameters

Parameter	Type
rotation	PageRotation

Returns

Promise<void>