PDFKit ist eine Node.js-Bibliothek, die es Entwicklern erleichtert, PDF-Dateien zu erstellen und mit ihnen zu arbeiten. Es bietet eine unkomplizierte, aber effektive API zum Erstellen von PDFs und zum Hinzufügen verschiedener Arten von Inhalten wie Text, Bildern und Formen.
Erfahren Sie, wie Sie mit PDF Kit PDFs in Node.js erstellen.
PDFkit einrichten
Du musst haben Node.js und npm (der Node.js-Paketmanager) auf Ihrem Computer installiert mitzumachen.
Stellen Sie sicher, dass Sie diese Tools installiert haben, indem Sie die folgenden Terminalbefehle ausführen:
Knoten -v
npm-v
Um PDFKit in Ihrem Node.js-Projekt zu verwenden, installieren Sie es, indem Sie den folgenden npm-Befehl ausführen:
npm installiert pdfkit
Dieser Befehl installiert PDFKit und fügt es den Abhängigkeiten Ihres Projekts hinzu.
Erstellen eines PDF-Dokuments mit PDFKit
Um ein PDF-Dokument mit PDFKit zu erstellen, benötigen Sie die pdfkit Paket und die fs (Dateisystem) Modul in Ihrer Skriptdatei:
konst PDFDokument = erfordern('pdfkit');
konst fs = erfordern('fs');
Erstellen Sie als Nächstes eine neue Instanz der PDFDokument Klasse. Diese Klasse repräsentiert eine PDF-Datei:
konst doc = neu PDFDokument();
Die erstellte Instanz ist ein lesbarer Stream, was bedeutet, dass Sie die verwenden können Rohr() Methode, um seinen Inhalt in einer Datei zu speichern.
Verrohren Sie dazu die Dok Instanz in einen beschreibbaren Stream erstellt von fs.createWriteStream:
doc.pipe (fs.createWriteStream('MeinPDFDoc.pdf'));
Der createWriteStream -Methode speichert den Inhalt einer PDF-Datei an einem angegebenen Speicherort im lokalen Dateisystem.
Der obige Codeblock speichert die resultierende PDF-Datei unter dem Namen in Ihrem aktuellen Arbeitsverzeichnis MeinPDFDoc.pdf.
Es ist wichtig, den Stream nach dem Hinzufügen von Inhalten zum PDF immer zu beenden. Sie können das mit diesem Befehl tun:
doc.end();
Führen Sie nun den Node-Befehl aus Knoten [Skriptname] um die PDF-Datei zu erstellen MeinPDFDoc.pdf in Ihrem aktuellen Arbeitsverzeichnis.
Hinzufügen von Text mit PDFKit
Bevor Sie Ihr Dokument zum Speichern weiterleiten, können Sie verschiedene Änderungen vornehmen. PDFKit macht das Hinzufügen von Text zu Dokumenten einfach und enthält viele Optionen zum Anpassen der Anzeige der Ausgabe.
Um dem Dokument Text hinzuzufügen, rufen Sie einfach die auf Text() -Methode und übergeben Sie den Text, den Sie hinzufügen möchten, als Argument:
doc.text("Codieren ist einfach!")
Wenn PDFKIT dem Dokument Text hinzufügt, verfolgt es die aktuellen X- und Y-Positionen dieses Textes. Wenn Sie also die Textmethode aufrufen, fügt PDFKit eine neue Zeile unter der vorherigen hinzu.
Indem Sie der Textmethode nach dem Text selbst X- und Y-Koordinaten bereitstellen, können Sie jedoch seine Position ändern:
doc.text('Codieren ist einfach!', 100, 100)
Um sich in einer Zeile nach oben oder unten zu bewegen, rufen Sie die an sich abwärts bewegen oder nach oben bewegen Methode mit der Anzahl der Zeilen, die der Text verschieben soll:
doc.moveDown(3);
doc.moveUp();
Standardmäßig führt der Aufruf einer der beiden Methoden ohne Übergabe eines Arguments dazu, dass sie sich nur um eine einzige Zeile bewegt.
PDFKit unterstützt jede der 14 Standardschriftarten, die durch das PDF-Format definiert sind. Der PDFKit-Textdokumentation hat eine vollständige Liste dieser Standardschriften.
Verwenden Sie die Schriftart() -Methode, um die erforderliche Schriftart anzugeben. Übergeben Sie einfach den entsprechenden Schriftartnamen als Zeichenfolge:
doc.font('Times-Roman')
.Text('Codieren ist einfach!');Sie können die Schriftgröße und Textfarbe auch mit ändern Schriftgröße() und das Füllfarbe() Methoden bzw.
Zum Beispiel:
// Dies ändert die Textfarbe auf Rot und gibt ihm eine Schriftgröße von 8
doc.fillColor('Rot')
.Schriftgröße(8)
.Text('Codieren ist einfach!');
Bilder mit PDFKit hinzufügen
Um ein Bild in Ihr PDF-Dokument aufzunehmen, übergeben Sie einfach dessen Pfad an die Bild Methode auf der Dokumentinstanz:
doc.image('Pfad/zu/Bild.jpeg')
Mit PDFKit können Sie Bilder in beiden hinzufügen JPEG- oder PNG-Format.
Standardmäßig fügt PDFKit das Bild in seiner ursprünglichen Größe ein. Sie können die Abmessungen eines Bildes ändern, indem Sie ein Objekt mit Schlüssel-Wert-Paaren als Argument für die bereitstellen Bild() Methode. Sie können eine Breite, Höhe sowie eine horizontale und vertikale Ausrichtung angeben.
Zum Beispiel:
// Nur die Breite angeben
doc.image('pfad/zu/bild.jpg', { Breite: 300 });
// Breite und Höhe angeben
doc.image('pfad/zu/bild.jpg', { Breite: 300, Höhe:200 })
Seiten mit PDFKit hinzufügen
Um dem PDF-Dokument neue Seiten hinzuzufügen, rufen Sie einfach die auf Seite hinzufügen Methode auf der Dokumentinstanz:
doc.addPage()
Um jedes Mal, wenn Sie eine neue Seite hinzufügen, automatisch Inhalte hinzuzufügen, verwenden Sie die SeiteHinzugefügt Ereignis für die Dokumentinstanz.
Zum Beispiel:
doc.on('SeiteHinzugefügt', () => doc.text("Codieren ist einfach!"));
Mit PDFKit können Sie die Seitenabmessungen angeben, wenn Sie ein neues Dokument erstellen oder eine neue Seite zu einem vorhandenen hinzufügen. Es gibt mehrere vordefinierte Seitengrößen, die die PDFKit Papierdokumentation erklärt.
Um eine dieser vordefinierten Seitengrößen zu verwenden, übergeben Sie ein Objekt an entweder die PDFDokument Konstrukteur oder der Seite hinzufügen() Methode. Verwenden Sie die size-Eigenschaft, um eine Zeichenfolge anzugeben, die der Name der Papiergröße ist.
Zum Beispiel:
// Konstrukteur
konst doc = neu PDFDokument({ Größe: 'A5' });
// addPage-Funktion
doc.addPage({ Größe: 'A7' });
Übergeben Sie dieses Optionsobjekt an die PDFDokument Der Konstruktor legt die Standardseitengröße für das gesamte Dokument fest. Sie können diese Voreinstellung dann überschreiben, indem Sie einen anderen Wert an übergeben Seite hinzufügen Methode.
Sie können Seitenränder festlegen, indem Sie ein Objekt an übergeben Ränder -Eigenschaft beim Hinzufügen von Seiten.
Der Ränder Eigenschaft nimmt ein Objekt mit oben, unten, links, Und Rechts Eigenschaften, die jeden Rand darstellen.
Zum Beispiel:
// Fügen Sie auf jeder Seite unterschiedliche Ränder hinzu
doc.addPage({
Ränder: {
Spitze: 72,
Unterseite: 72,
links: 50,
Rechts: 50
}
});
Dieser Code legt den oberen und unteren Rand auf 72 Punkt und den linken und rechten Rand auf 50 Punkt fest. Beachten Sie, dass der Standardrand für mit PDFKit erstellte Dokumente ein Rand von 1 Zoll (72 Punkt) auf allen Seiten ist.
Um alle oberen, unteren, linken und rechten Ränder auf denselben Wert einzustellen, übergeben Sie einfach ein Objekt mit a Rand Eigentum an die Seite hinzufügen Methode:
doc.addPage({ Rand: 60 }) // Fügen Sie jeder Seite einen Rand von 60 Punkt hinzu
Die Vorteile der Erstellung von PDFs mit PDFKit in Node.js
Mit PDFKit können Sie Standard- und unterstützte Dokumente aus Ihren Node.js-Anwendungen erstellen. Mit PDFKit können Sie komplexe Dokumente einfach handhaben. Darüber hinaus kann es die Bereitstellung von Dokumenten für Benutzer erleichtern und deren Freigabe und Druck vereinfachen.
