PDF Web SDK Documentation

Comprehensive Guide for Developers: UI & SDK Integration, Configuration, and API Reference

Interface IPdfContentBlock

A paragraph-level block of text with its role.

interface IPdfContentBlock {
    bbox: PdfBBox;
    id: string;
    level?: 1 | 2 | 3 | 4 | 5 | 6;
    lines?: IPdfContentLine[];
    listMarker?: string;
    ordered?: boolean;
    role: PdfContentRole;
    text: string;
}

Index

Properties

bbox id level? lines? listMarker? ordered? role text

Properties

bbox

id

id: string

p{pageNumber}-b{n}, stable within one export (use it for citations).

`Optional`level

level?: 1 | 2 | 3 | 4 | 5 | 6

Heading level, set for heading blocks.

`Optional`lines

lines?: IPdfContentLine[]

Present when PdfContentKind.Layout is included.

`Optional`listMarker

listMarker?: string

Source list marker (e.g. •, 1.), set for listItem blocks.

`Optional`ordered

ordered?: boolean

Whether the list item is numbered/lettered, set for listItem blocks.

role

role: PdfContentRole

text

text: string