PDFiumTextObject

Defined in: src/document/page-object.ts:351

Text object on a PDF page.

Provides access to text content, font size, render mode, and font information.

Example

for (const obj of page.objects()) {
  if (obj instanceof PDFiumTextObject) {
    console.log(obj.text, obj.fontSize);
    using font = obj.getFont();
    if (font) console.log(font.familyName);
  }
}

Extends

PDFiumPageObject

Accessors

bounds

Get Signature

get bounds(): Rect

Defined in: src/document/page-object.ts:99

Bounding box in page coordinates (points, origin at bottom-left).

Returns

Rect

Inherited from

PDFiumPageObject.bounds

dashPattern

Get Signature

get dashPattern(): DashPattern | null

Defined in: src/document/page-object.ts:158

Get the dash pattern of this page object.

Returns

DashPattern | null

Inherited from

PDFiumPageObject.dashPattern

fillColour

Get Signature

get fillColour(): Colour | null

Defined in: src/document/page-object.ts:104

Get the fill colour of this page object.

Returns

Colour | null

Inherited from

PDFiumPageObject.fillColour

hasClipPath

Get Signature

get hasClipPath(): boolean

Defined in: src/document/page-object.ts:194

Whether this page object has a clip path applied.

Returns

boolean

Inherited from

PDFiumPageObject.hasClipPath

hasTransparency

Get Signature

get hasTransparency(): boolean

Defined in: src/document/page-object.ts:176

Check if this page object has transparency.

Returns

boolean

Inherited from

PDFiumPageObject.hasTransparency

lineCap

Get Signature

get lineCap(): LineCapStyle

Defined in: src/document/page-object.ts:134

Get the line cap style of this page object.

Returns

LineCapStyle

Inherited from

PDFiumPageObject.lineCap

lineJoin

Get Signature

get lineJoin(): LineJoinStyle

Defined in: src/document/page-object.ts:146

Get the line join style of this page object.

Returns

LineJoinStyle

Inherited from

PDFiumPageObject.lineJoin

markCount

Get Signature

get markCount(): number

Defined in: src/document/page-object.ts:238

Get the number of content marks on this page object.

Returns

number

Inherited from

PDFiumPageObject.markCount

marks

Get Signature

get marks(): PageObjectMark[]

Defined in: src/document/page-object.ts:263

Get all content marks from this page object.

Returns

PageObjectMark[]

Inherited from

PDFiumPageObject.marks

matrix

Get Signature

get matrix(): TransformMatrix | null

Defined in: src/document/page-object.ts:122

Get the transformation matrix of this page object.

Returns

TransformMatrix | null

Inherited from

PDFiumPageObject.matrix

renderMode

Get Signature

get renderMode(): TextRenderMode | null

Defined in: src/document/page-object.ts:373

Get the text render mode.

Returns

TextRenderMode | null

rotatedBounds

Get Signature

get rotatedBounds(): QuadPoints | null

Defined in: src/document/page-object.ts:188

Get the rotated bounding box of this page object as quad points.

Returns

QuadPoints | null

Inherited from

PDFiumPageObject.rotatedBounds

strokeColour

Get Signature

get strokeColour(): Colour | null

Defined in: src/document/page-object.ts:110

Get the stroke colour of this page object.

Returns

Colour | null

Inherited from

PDFiumPageObject.strokeColour

strokeWidth

Get Signature

get strokeWidth(): number | null

Defined in: src/document/page-object.ts:116

Get the stroke width of this page object.

Returns

number | null

Inherited from

PDFiumPageObject.strokeWidth

text

Get Signature

get text(): string

Defined in: src/document/page-object.ts:363

The text content.

Returns

string

type

Get Signature

get type(): PageObjectType

Defined in: src/document/page-object.ts:94

The type of this page object.

Returns

PageObjectType

Inherited from

PDFiumPageObject.type

Methods

addMark()

addMark(name): PageObjectMark | null

Defined in: src/document/page-object.ts:282

Add a content mark to this page object.

Parameters

Parameter	Type	Description
`name`	`string`	The mark name (e.g., ‘Artifact’, ‘Span’)

Returns

PageObjectMark | null

The mark data, or null if failed

Inherited from

PDFiumPageObject.addMark

destroy()

destroy(): void

Defined in: src/document/page-object.ts:227

Destroy this page object and free its underlying resources.

Page objects are borrowed views — they do not own the underlying handle and become invalid when the parent page is disposed.

Only call this for page objects that have NOT been inserted into a page. Once an object is added to a page via builder methods, it is owned by the page and must not be destroyed manually.

After calling destroy(), any further access to this object’s properties or methods will throw.