PDFKit este o bibliotecă Node.js care facilitează crearea și lucrul cu fișiere PDF pentru dezvoltatori. Oferă un API simplu, dar eficient pentru a produce PDF-uri și pentru a adăuga diferite tipuri de conținut, cum ar fi text, imagini și forme.
Aflați cum să utilizați PDF Kit pentru a crea PDF-uri în Node.js.
Configurarea PDFkit
Trebuie să ai Node.js și npm (managerul de pachete Node.js) instalate pe computer să urmeze.
Asigurați-vă că aveți aceste instrumente instalate rulând următoarele comenzi de terminal:
nodul -v
npm -v
Pentru a începe să utilizați PDFKit în proiectul dvs. Node.js, instalați-l rulând următoarea comandă npm:
npm instalează pdfkit
Această comandă va instala PDFKit și îl va adăuga la dependențele proiectului dvs.
Crearea unui document PDF cu PDFKit
Pentru a crea un document PDF folosind PDFKit, solicitați pdfkit pachetul și fs modulul (sistem de fișiere) din fișierul script:
const PDFDocument = cere(„pdfkit”);
const fs = cere(„fs”);
Apoi, creați o nouă instanță a PDFDocument clasă. Această clasă reprezintă un fișier PDF:
const doc = nou PDFDocument();
Instanța creată este un flux care poate fi citit, ceea ce înseamnă că puteți utiliza teava() metodă de a-și salva conținutul într-un fișier.
Pentru a face acest lucru, conductați doc instanță într-un flux care poate fi scris creat de fs.createWriteStream:
doc.pipe (fs.createWriteStream(„MyPDFDoc.pdf”));
The createWriteStream salvează conținutul unui fișier PDF într-o locație specificată în sistemul de fișiere local.
Blocul de cod de mai sus va salva fișierul PDF rezultat în directorul de lucru curent, cu numele MyPDFDoc.pdf.
Este important să încheiați întotdeauna fluxul după ce adăugați conținut în PDF. Puteți face asta folosind această comandă:
doc.end();
Acum rulați comanda node nod [nume script] pentru a crea fișierul PDF MyPDFDoc.pdf în directorul de lucru actual.
Adăugarea de text cu PDFKit
Înainte de a vă canaliza documentul pentru a-l salva, puteți face diverse modificări. PDFKit simplifică adăugarea de text la documente și include multe opțiuni pentru a personaliza afișarea rezultatelor.
Pentru a adăuga text în document, sunați pur și simplu la text() metoda și transmiteți textul pe care doriți să-l adăugați ca argument:
doc.text(„Codarea este ușoară!”)
Pe măsură ce PDFKIT adaugă text în document, ține evidența pozițiilor X și Y curente ale textului respectiv. Deci, ori de câte ori apelați metoda text, PDFKit va adăuga o nouă linie sub cea anterioară.
Cu toate acestea, furnizând coordonate X și Y metodei text după textul însuși, îi puteți schimba poziția:
doc.text(„Codarea este ușoară!”, 100, 100)
Pentru a vă deplasa în sus sau în jos pe o linie, apelați muta în jos sau deplasare în sus metoda cu numărul de linii pe care textul ar trebui să se mute:
doc.moveDown(3);
doc.moveUp();
În mod implicit, apelarea oricărei metode fără a trece un argument va face ca aceasta să se miște doar cu o singură linie.
PDFKit acceptă fiecare dintre cele 14 fonturi standard definite de formatul PDF. The Documentație text PDFKit are o listă completă a acestor fonturi standard.
Folosește font() metoda de a specifica fontul dorit. Doar introduceți numele fontului corespunzător ca șir:
doc.font("Times-Roman")
.text(„Codarea este ușoară!”);De asemenea, puteți modifica dimensiunea fontului și culoarea textului folosind marimea fontului() si fillColor() metode, respectiv.
De exemplu:
// Aceasta schimbă culoarea textului în roșu și îi dă o dimensiune a fontului de 8
doc.fillColor('roșu')
.marimea fontului(8)
.text(„Codarea este ușoară!”);
Adăugarea de imagini cu PDFKit
La o imagine în documentul dumneavoastră PDF, treceți pur și simplu calea acesteia către imagine metoda pe instanța documentului:
doc.image(„cale/spre/image.jpeg”)
PDFKit vă permite să adăugați imagini în oricare dintre acestea Format JPEG sau PNG.
În mod implicit, PDFKit va insera imaginea la dimensiunea sa nativă. Puteți modifica dimensiunile unei imagini furnizând un obiect care conține perechi cheie-valoare ca argument pentru imagine() metodă. Puteți specifica o lățime, înălțime și o aliniere orizontală și verticală.
De exemplu:
// Specificând numai lățimea
doc.image(„cale/spre/image.jpg”, { lăţime: 300 });
// Specificând atât lățimea, cât și înălțimea
doc.image(„cale/spre/image.jpg”, { lăţime: 300, înălţime:200 })
Adăugarea de pagini cu PDFKit
Pentru a adăuga pagini noi în documentul PDF, sunați pur și simplu la adauga pagina metoda pe instanța documentului:
doc.addPage()
Pentru a adăuga automat conținut de fiecare dată când adăugați o pagină nouă, utilizați paginăAdăugat eveniment pe instanța documentului.
De exemplu:
doc.on(„pagină adăugată”, () => doc.text(„Codarea este ușoară!”));
PDFKit vă permite să specificați dimensiunile paginii atunci când creați un document nou sau adăugați o pagină nouă la una existentă. Există mai multe dimensiuni de pagină predefinite pe care Documentație pe hârtie PDFKit explică.
Pentru a utiliza oricare dintre aceste dimensiuni de pagină predefinite, transmiteți un obiect fie către PDFDocument constructorul sau adauga pagina() metodă. Utilizați proprietatea size pentru a specifica un șir care este numele dimensiunii hârtiei.
De exemplu:
// constructor
const doc = nou Document PDF({ mărimea: „A5” });
// funcția addPage
doc.addPage({ mărimea: „A7” });
Transmiterea acestui obiect de opțiuni către PDFDocument constructorul setează dimensiunea implicită a paginii pentru întregul document. Puteți apoi să suprascrieți această valoare implicită trecând o valoare diferită adauga pagina metodă.
Puteți seta marginile paginii trecând un obiect către marginile proprietate la adăugarea paginilor.
The marginile proprietatea ia un obiect cu sus, jos, stânga, și dreapta proprietăți reprezentând fiecare marjă.
De exemplu:
// Adăugați diferite margini pe fiecare parte
doc.addPage({
margini: {
top: 72,
fund: 72,
stânga: 50,
dreapta: 50
}
});
Acest cod setează marginile de sus și de jos la 72 de puncte, iar marginile din stânga și din dreapta la 50 de puncte. Rețineți că marja implicită pentru documentele create de PDFKit este o marjă de 1 inch (72 de puncte) pe toate părțile.
Pentru a seta toate marginile de sus, de jos, din stânga și din dreapta la aceeași valoare, treceți pur și simplu un obiect cu a marginea proprietate către adauga pagina metodă:
doc.addPage({ marginea: 60 }) // adăugați o marjă de 60 de puncte pe fiecare parte
Avantajele creării PDF-urilor cu PDFKit în Node.js
PDFKit vă permite să produceți documente standard și acceptate din aplicațiile dvs. Node.js. Cu PDFKit, puteți gestiona cu ușurință documente complexe. În plus, poate facilita livrarea documentelor către utilizatori și le poate face mai ușor de partajat și de imprimat.
