PDFKit für JavaScript (Node.js): Komplettguide mit Beispielen

Was ist PDFKit und wofür wird es verwendet?

PDFKit ist eine leistungsstarke und flexible Bibliothek für JavaScript (Node.js), die speziell für die programmatische Erstellung von PDF-Dokumenten "on the fly" entwickelt wurde. Sie ermöglicht Entwicklern, komplexe, mehrseitige PDF-Dateien mit umfangreichen Inhalten zu generieren: Text, Bilder, Tabellen, Vektorgrafiken, Anmerkungen und Formulare. Im Gegensatz zu vielen anderen Bibliotheken arbeitet PDFKit auf einer niedrigen Ebene und bietet die vollständige Kontrolle über jeden Aspekt des Dokuments – von den Koordinaten der Elemente bis hin zur Einbettung von Schriftarten.

Die wichtigsten Anwendungsfälle für PDFKit:

• Erstellung von Berichten und Rechnungen: Dynamische PDF-Dokumente basierend auf Daten aus einer Datenbank oder API generieren.
• Erstellung von Lieferscheinen und Quittungen: Automatische Dokumentengenerierung für Online-Shops und Buchhaltungssysteme.
• Ausstellung von Zertifikaten und Diplomen: Generierung personalisierter Dokumente mit einzigartigen Daten für jeden Empfänger.
• Datenexport: Konvertierung von Webseiten, Tabellen oder Diagrammen in das PDF-Format für Druck oder Archivierung.
• Erstellung von E-Books und Handbüchern: Programmatisches Layout von mehrseitigen Dokumenten mit Inhaltsverzeichnis und Lesezeichen.

PDFKit ist die Wahl für Entwickler, die Leistung, Flexibilität und vollständige Kontrolle benötigen – ohne externe Abhängigkeiten (z. B. ohne Installation von LibreOffice oder wkhtmltopdf).

Installation von PDFKit

PDFKit wird über den Paketmanager npm verteilt. Führen Sie zur Installation den folgenden Befehl im Terminal im Stammverzeichnis Ihres Projekts aus:

npm install pdfkit

Nach der Installation ist die Bibliothek für den Import in Ihrem Code verfügbar. Es sind keine zusätzlichen Abhängigkeiten erforderlich.

Schnellstart: Ihr erstes PDF-Dokument erstellen

Lassen Sie uns eine einfache PDF-Datei mit dem Text „Hallo, Welt!“ erstellen.

const PDFDocument = require('pdfkit');
const fs = require('fs');

// Neues PDF-Dokument erstellen
const doc = new PDFDocument();

// Ausgabestream für die Datei festlegen
doc.pipe(fs.createWriteStream('hallo_welt.pdf'));

// Text auf die Seite hinzufügen
doc.fontSize(25)
   .text('Hallo, Welt!', 100, 100);

// Dokument finalisieren und Stream schließen
doc.end();

console.log('PDF-Datei "hallo_welt.pdf" erfolgreich erstellt!');

Nach dem Ausführen dieses Codes erscheint im selben Ordner die Datei hallo_welt.pdf mit dem Text „Hallo, Welt!“.

Wichtige Methoden und Funktionen von PDFKit

PDFKit bietet eine umfangreiche API. Nachfolgend finden Sie 10 wichtige Methoden mit detaillierten Beschreibungen und Beispielen.

1. text(text, x, y, options)

Beschreibung: Fügt Text in das Dokument ein. Dies ist die Hauptmethode für die Textarbeit. Sie unterstützt Zeilenumbrüche, Ausrichtung, Einzüge und Styling.

Parameter:

• text (String) — Der hinzuzufügende Text.
• x (Number, optional) — X-Koordinate. Wenn nicht angegeben, wird der Text ab der aktuellen Position fortgesetzt.
• y (Number, optional) — Y-Koordinate. Wenn nicht angegeben, wird der Text ab der aktuellen Position fortgesetzt.
• options (Object, optional) — Objekt mit Einstellungen:
  • align (String) — Ausrichtung: 'left', 'center', 'right', 'justify'.
  • indent (Number) — Einzug der ersten Zeile.
  • paragraphGap (Number) — Abstand zwischen Absätzen.
  • lineGap (Number) — Zeilenabstand.
  • width (Number) — Breite des Textblocks (für Zeilenumbrüche).
  • height (Number) — Höhe des Textblocks.
  • underline (Boolean) — Unterstreichung.