PDFKit est une bibliothèque Node.js qui permet aux développeurs de créer et de travailler facilement avec des fichiers PDF. Il offre une API simple mais efficace pour produire des PDF et leur ajouter différents types de contenu, tels que du texte, des images et des formes.
Apprenez à utiliser PDF Kit pour créer des PDF dans Node.js.
Configuration de PDFkit
Vous devez avoir Node.js et npm (le gestionnaire de packages Node.js) installés sur votre machine à suivre.
Assurez-vous que ces outils sont installés en exécutant les commandes de terminal suivantes :
nœud -v
npm-v
Pour commencer à utiliser PDFKit dans votre projet Node.js, installez-le en exécutant la commande npm suivante :
npm installer pdfkit
Cette commande installera PDFKit et l'ajoutera aux dépendances de votre projet.
Créer un document PDF avec PDFKit
Pour créer un document PDF à l'aide de PDFKit, vous avez besoin du
pdfkit paquet et le fs module (système de fichiers) dans votre fichier de script :constante Document PDF = exiger('pdfkit');
constante fs = exiger('fs');
Ensuite, créez une nouvelle instance de Document PDF classe. Cette classe représente un fichier PDF :
constante doc = nouveau DocumentPDF();
L'instance créée est un flux lisible, ce qui signifie que vous pouvez utiliser le tuyau() méthode pour enregistrer son contenu dans un fichier.
Pour ce faire, pipez le doc instance dans un flux accessible en écriture créé par fs.createWriteStream:
doc.pipe (fs.createWriteStream('MonDocPDF.pdf'));
Le createWriteStream La méthode enregistre le contenu d'un fichier PDF à un emplacement spécifié sur le système de fichiers local.
Le bloc de code ci-dessus enregistrera le fichier PDF résultant dans votre répertoire de travail actuel, avec le nom MyPDFDoc.pdf.
Il est important de toujours mettre fin au flux après avoir ajouté du contenu au PDF. Vous pouvez le faire en utilisant cette commande :
doc.end();
Exécutez maintenant la commande node noeud [nom du script] pour créer le fichier PDF MyPDFDoc.pdf dans votre répertoire de travail actuel.
Ajouter du texte avec PDFKit
Avant de diriger votre document pour l'enregistrer, vous pouvez apporter diverses modifications. PDFKit simplifie l'ajout de texte aux documents et inclut de nombreuses options pour personnaliser l'affichage de la sortie.
Pour ajouter du texte au document, appelez simplement le texte() méthode et passez le texte que vous souhaitez ajouter comme argument :
doc.text("Le codage est facile!")
Lorsque PDFKIT ajoute du texte au document, il garde une trace des positions X et Y actuelles de ce texte. Ainsi, chaque fois que vous appelez la méthode de texte, PDFKit ajoutera une nouvelle ligne sous la précédente.
Cependant, en fournissant les coordonnées X et Y à la méthode de texte après le texte lui-même, vous pouvez modifier sa position :
doc.text("Le codage est facile !", 100, 100)
Pour monter ou descendre d'une ligne, appelez le déplacer vers le bas ou déplacer vers le haut méthode avec le nombre de lignes que le texte doit déplacer :
doc.moveDown(3);
doc.moveUp();
Par défaut, appeler l'une ou l'autre méthode sans passer d'argument la fera se déplacer d'une seule ligne.
PDFKit prend en charge chacune des 14 polices standard définies par le format PDF. Le Documentation textuelle PDFKit a une liste complète de ces polices standard.
Utilisez le Police de caractère() méthode pour spécifier la police requise. Transmettez simplement le nom de la police correspondante sous forme de chaîne :
doc.font('Times-romain')
.texte("Le codage est facile !");Vous pouvez également modifier la taille de la police et la couleur du texte à l'aide de la taille de police() et le la couleur de remplissage() méthodes, respectivement.
Par exemple:
// Cela change la couleur du texte en rouge et lui donne une taille de police de 8
doc.fillColor('rouge')
.taille de police(8)
.texte("Le codage est facile !");
Ajout d'images avec PDFKit
Pour ajouter une image à votre document PDF, passez simplement son chemin à la image méthode sur l'instance de document :
doc.image('chemin/vers/image.jpeg')
PDFKit vous permet d'ajouter des images dans Format JPEG ou PNG.
Par défaut, PDFKit insère l'image à sa taille native. Vous pouvez modifier les dimensions d'une image en fournissant un objet contenant des paires clé-valeur comme argument de la image() méthode. Vous pouvez spécifier une largeur, une hauteur et un alignement horizontal et vertical.
Par exemple:
// Spécification de la largeur seule
doc.image('chemin/vers/image.jpg', { largeur: 300 });
// Spécifier à la fois la largeur et la hauteur
doc.image('chemin/vers/image.jpg', { largeur: 300, hauteur:200 })
Ajouter des pages avec PDFKit
Pour ajouter de nouvelles pages au document PDF, appelez simplement le ajouter une page méthode sur l'instance de document :
doc.addPage()
Pour ajouter automatiquement du contenu chaque fois que vous ajoutez une nouvelle page, utilisez le pageAjouté événement sur l'instance de document.
Par exemple:
doc.sur('page ajoutée', () => doc.texte("Le codage est facile!"));
PDFKit vous permet de spécifier les dimensions de la page lors de la création d'un nouveau document ou de l'ajout d'une nouvelle page à une page existante. Il existe plusieurs tailles de page prédéfinies que le Documentation papier PDFKit explique.
Pour utiliser l'une de ces tailles de page prédéfinies, transmettez un objet soit au Document PDF constructeur ou le ajouter une page() méthode. Utilisez la propriété size pour spécifier une chaîne qui est le nom de la taille du papier.
Par exemple:
// constructeur
constante doc = nouveau Document PDF({ taille: 'A5' });
// fonction addPage
doc.addPage({ taille: 'A7' });
Passer cet objet d'options au Document PDF constructeur définit la taille de page par défaut pour l'ensemble du document. Vous pouvez ensuite écraser cette valeur par défaut en transmettant une valeur différente au ajouter une page méthode.
Vous pouvez définir des marges de page en transmettant un objet au marges propriété lors de l'ajout de pages.
Le marges propriété prend un objet avec haut, bas, gauche, et droite propriétés représentant chaque marge.
Par exemple:
// Ajouter des marges différentes de chaque côté
doc.addPage({
marges: {
haut: 72,
bas: 72,
gauche: 50,
droite: 50
}
});
Ce code définit les marges supérieure et inférieure à 72 points et les marges gauche et droite à 50 points. Notez que la marge par défaut pour les documents créés avec PDFKit est une marge de 1 pouce (72 points) sur tous les côtés.
Pour définir toutes les marges du haut, du bas, de gauche et de droite sur la même valeur, passez simplement un objet avec un marge propriété à la ajouter une page méthode:
doc.addPage({ marge: 60 }) // ajoute une marge de 60 points de chaque côté
Les avantages de créer des PDF avec PDFKit dans Node.js
PDFKit vous permet de produire des documents standards et pris en charge à partir de vos applications Node.js. Avec PDFKit, vous pouvez facilement gérer des documents complexes. De plus, cela peut faciliter la livraison de documents aux utilisateurs et les rendre plus simples à partager et à imprimer.