Skip to content
PDF Oxide

Page-API-Referenz

Seit v0.3.34 stellt jedes Binding ein Page-Objekt bereit. Sie iterieren ein Dokument und rufen Extraktionsmethoden direkt auf der Seite auf, statt bei jedem Aufruf einen page_index mitzuschleppen. Der Typ heißt einheitlich Page in Python, Node.js, C# und Go; Rust exponiert dieselbe Form unter PdfPage.

Kurzbeispiel

Python

from pdf_oxide import PdfDocument

with PdfDocument("paper.pdf") as doc:
    for page in doc:                       # len(doc), doc[i], doc[-1] funktionieren ebenfalls
        print(page.text[:80])
        md = page.markdown(detect_headings=True)

Rust

use pdf_oxide::api::Pdf;

let mut doc = Pdf::open("paper.pdf")?;
for i in 0..doc.page_count()? {
    let page = doc.page(i)?;
    println!("{}", &page.text()?[..80]);
}

JavaScript / TypeScript (Node)

const { PdfDocument } = require("pdf-oxide");

const doc = new PdfDocument("paper.pdf");
for (const page of doc) {
  console.log(page.extractText().slice(0, 80));
}
doc.close();

Go

package main

import (
    "fmt"
    "log"
    pdfoxide "github.com/yfedoseev/pdf_oxide/go"
)

func main() {
    doc, err := pdfoxide.Open("paper.pdf")
    if err != nil { log.Fatal(err) }
    defer doc.Close()

    pages, _ := doc.Pages()
    for _, page := range pages {
        text, _ := page.ExtractText()
        fmt.Println(text[:80])
    }
}

C#

using PdfOxide;

using var doc = PdfDocument.Open("paper.pdf");
foreach (var page in doc.Pages)
{
    Console.WriteLine(page.ExtractText()[..Math.Min(80, page.ExtractText().Length)]);
}

Python — Page

Lazy-Property-Oberfläche — Inhalte werden beim ersten Zugriff geparst und auf der Page gecacht.

Member Rückgabe Beschreibung
page.text str Extrahierter Text (spaltenbewusst)
page.chars list[Char] Zeichen-Datensätze mit Bounding Box und Schrift
page.words list[Word] Wort-Datensätze mit Bounding Box
page.lines list[TextLine] Textzeilen mit Bounding Box
page.spans list[Span] Stilisierte Spans (Schrift, Größe, Strichstärke)
page.tables list[Table] Strukturierte Tabellenzeilen inkl. Zell-Bounding-Boxes
page.images list[Image] Bild-Metadaten
page.paths list[Path] Vektorpfad-Datensätze
page.annotations list[Annotation] Annotationen auf dieser Seite
page.markdown(detect_headings=True) str Markdown-Konvertierung
page.plain_text() str Reintext (ohne Layout-Hinweise)
page.html() str HTML-Konvertierung
page.render(format="png") bytes Seite als PNG / JPEG rendern
page.search(term, case_sensitive=False) list[SearchResult] Text auf dieser Seite finden
page.region(rect) PageRegion Begrenzte Extraktion innerhalb eines Rechtecks 
with PdfDocument("paper.pdf") as doc:
    page = doc[0]                 # oder doc.page(0)
    for word in page.words:       # erster Zugriff parst; spätere Aufrufe nutzen den Cache
        print(word.text, word.bbox)

    # Begrenzte Extraktion
    header = page.region((0, 700, 612, 92)).extract_text()

Die bereits vorhandene Editor-Klasse PdfPage (zum Schreiben) bleibt unverändert; die neue Page ist strikt lesend.

Rust — PdfPage

use pdf_oxide::api::Pdf;

let mut doc = Pdf::open("paper.pdf")?;
let page = doc.page(0)?;

let text = page.text()?;
let words = page.extract_words()?;
let tables = page.extract_tables()?;
let md = page.to_markdown(true)?;

Auf PdfPage verfügbare Methoden:

  • text(), plain_text(), to_markdown(detect_headings), to_html()
  • extract_chars(), extract_words(), extract_lines(), extract_spans()
  • extract_tables(), extract_paths(), extract_images()
  • annotations(), render(format)
  • search(term) — begrenzte Suche
  • find_text_containing(substring) — Trefferliste auf DOM-Ebene inkl. IDs

Node.js — Page

const { PdfDocument } = require("pdf-oxide");

const doc = new PdfDocument("paper.pdf");
const page = doc.page(0);

console.log(page.width, page.height, page.rotation);  // gecacht
console.log(page.extractText());
const words = page.extractWords();
const tables = page.extractTables();
const md = page.toMarkdown();

PdfDocument unterstützt for..of via Symbol.iterator, dazu doc.page(i) und doc.pageCount().

Sechs bislang nur nativ verfügbare Methoden stehen nun sowohl auf Page als auch auf PdfDocument über die TS-Schicht zur Verfügung:

  • extractWords
  • extractTextLines
  • extractTables
  • extractPaths
  • getEmbeddedImages
  • ocrExtractText

Zu jeder Methode gibt es eine Async-Entsprechung — extractTextAsync, toMarkdownAsync usw.

Go — Page

doc, _ := pdfoxide.Open("paper.pdf")
defer doc.Close()

page, _ := doc.Page(0)
text, _ := page.ExtractText()
md, _   := page.ToMarkdown()
tables, _ := page.ExtractTables()

// Über alle Seiten iterieren
all, _ := doc.Pages()
for i, p := range all {
    t, _ := p.ExtractText()
    fmt.Printf("Seite %d: %d Zeichen\n", i, len(t))
}

Das Page-Struct in Go besitzt die volle Methodenoberfläche: ExtractText, ToMarkdown, ToHtml, ToPlainText, ExtractWords, ExtractTextLines, ExtractTables, ExtractChars, ExtractPaths, Annotations, Images, Fonts, RenderPage, Search.

C# — Page

using PdfOxide;

using var doc = PdfDocument.Open("paper.pdf");

Page page = doc[0];                            // oder doc.Pages[0] bzw. doc.Page(0)
string text = page.ExtractText();
string md   = page.ToMarkdown();
Table[] tables = page.ExtractTables();

// Async-Varianten
string textAsync = await page.ExtractTextAsync();
string mdAsync   = await page.ToMarkdownAsync();

doc.Pages ist vom Typ IReadOnlyList<Page>. Zu jeder synchronen Methode existiert ein async Task<T>-Pendant mit CancellationToken-Unterstützung.

Struktur des Table-Typs

extract_tables() (verfügbar auf PdfDocument und Page) liefert einen einheitlichen Table-Typ über alle Sprachen:

Sprache Typ Zellzugriff
Rust Table iterieren mit rows[i].cells[j]
Python dict row["cells"][i]["text"]
Go Table table.CellText(row, col)
C# Table table.CellText(row, col)
Node.js Table-Interface table.cells[row][col]

Jede Zelle trägt Text plus eine Bounding Box — so lässt sich die Extraktion auf Koordinaten der Seite zurückführen.

Migration von doc.extract_*(page_index)

Alt (weiterhin unterstützt):

doc = PdfDocument("paper.pdf")
for i in range(doc.page_count()):
    print(doc.extract_text(i))
    print(doc.to_markdown(i, detect_headings=True))
    print(doc.extract_tables(i))

Neu (ab v0.3.34):

with PdfDocument("paper.pdf") as doc:
    for page in doc:
        print(page.text)
        print(page.markdown(detect_headings=True))
        print(page.tables)

Beide Stile bleiben unterstützt; der Page-Stil liest sich für seitenweise Pipelines besser und erspart die wiederholte Index-Buchführung.

Verwandte Seiten