PDFKit je knižnica Node.js, ktorá vývojárom uľahčuje vytváranie súborov PDF a prácu s nimi. Ponúka jednoduché, ale efektívne rozhranie API na vytváranie súborov PDF a pridávanie rôznych druhov obsahu do nich, ako je text, obrázky a tvary.
Naučte sa používať PDF Kit na vytváranie PDF v Node.js.
Nastavenie súpravy PDF
Musíš mať Node.js a npm (správca balíkov Node.js) nainštalované na vašom počítači nasledovať.
Uistite sa, že máte nainštalované tieto nástroje spustením nasledujúcich príkazov terminálu:
uzol -v
npm -v
Ak chcete začať používať súbor PDFKit vo svojom projekte Node.js, nainštalujte ho spustením nasledujúceho príkazu npm:
npm nainštalovať pdfkit
Tento príkaz nainštaluje PDFKit a pridá ho do závislostí vášho projektu.
Vytvorenie dokumentu PDF pomocou súpravy PDFKit
Ak chcete vytvoriť dokument PDF pomocou súpravy PDFKit, musíte mať pdfkit balík a fs (súborový systém) modul v súbore skriptu:
konšt PDFDocument = vyžadovať('pdfkit');
konšt fs = vyžadovať('fs');
Ďalej vytvorte novú inštanciu súboru PDFDocument trieda. Táto trieda predstavuje súbor PDF:
konšt doc = Nový PDFDocument();
Vytvorená inštancia je čitateľný prúd, čo znamená, že môžete použiť súbor rúra() spôsob uloženia jeho obsahu do súboru.
Ak to chcete urobiť, potrubie doc inštanciu do zapisovateľného prúdu vytvoreného fs.createWriteStream:
doc.pipe (fs.createWriteStream('MyPDFDoc.pdf'));
The createWriteStream metóda uloží obsah súboru PDF na určené miesto v lokálnom systéme súborov.
Vyššie uvedený blok kódu uloží výsledný súbor PDF do vášho aktuálneho pracovného adresára s názvom MyPDFDoc.pdf.
Po pridaní obsahu do PDF je dôležité vždy stream ukončiť. Môžete to urobiť pomocou tohto príkazu:
doc.end();
Teraz spustite príkaz uzla uzol [názov skriptu] na vytvorenie súboru PDF MyPDFDoc.pdf vo vašom aktuálnom pracovnom adresári.
Pridávanie textu pomocou súpravy PDFKit
Pred uložením dokumentu pomocou kanála môžete vykonať rôzne zmeny. PDFKit zjednodušuje pridávanie textu do dokumentov a obsahuje veľa možností na prispôsobenie zobrazenia výstupu.
Ak chcete do dokumentu pridať text, jednoducho zavolajte na text() metódu a odovzdajte text, ktorý chcete pridať ako argument:
doc.text("Kódovanie je jednoduché!")
Keď PDFKIT pridáva text do dokumentu, sleduje aktuálnu polohu X a Y tohto textu. Takže vždy, keď zavoláte textovú metódu, PDFKit pridá nový riadok pod predchádzajúci.
Avšak zadaním súradníc X a Y metóde textu po samotnom texte môžete zmeniť jej polohu:
doc.text('Kódovanie je jednoduché!', 100, 100)
Ak sa chcete posunúť o riadok nahor alebo nadol, zavolajte na číslo posunúť nadol alebo moveUp metóda s počtom riadkov, o ktoré sa má text presunúť:
doc.moveDown(3);
doc.moveUp();
V predvolenom nastavení volanie ktorejkoľvek metódy bez zadania argumentu spôsobí, že sa presunie len o jeden riadok.
PDFKit podporuje každé zo 14 štandardných písiem definovaných formátom PDF. The Textová dokumentácia PDFKit má úplný zoznam týchto štandardných písiem.
Použi font() spôsob určenia požadovaného písma. Stačí zadať zodpovedajúci názov písma ako reťazec:
doc.font(„Times-Roman“)
.text('Kódovanie je jednoduché!');Môžete tiež zmeniť veľkosť písma a farbu textu pomocou veľkosť písma() a fillColor() metódy, resp.
Napríklad:
// Toto zmení farbu textu na červenú a priradí mu veľkosť písma 8
doc.fillColor('červená')
.veľkosť písma(8)
.text('Kódovanie je jednoduché!');
Pridávanie obrázkov pomocou súpravy PDFKit
K obrázku do dokumentu PDF jednoducho odovzdajte jeho cestu do obrázok metóda na inštancii dokumentu:
doc.image('cesta/k/obrázku.jpeg')
PDFKit vám umožňuje pridávať obrázky do oboch Formát JPEG alebo PNG.
Štandardne PDFKit vloží obrázok v jeho pôvodnej veľkosti. Rozmery obrázka môžete zmeniť poskytnutím objektu obsahujúceho páry kľúč – hodnota ako argument pre obrázok() metóda. Môžete určiť šírku, výšku a horizontálne a vertikálne zarovnanie.
Napríklad:
// Určenie samotnej šírky
doc.image('cesta/k/obrázku.jpg', { šírka: 300 });
// Zadanie šírky aj výšky
doc.image('cesta/k/obrázku.jpg', { šírka: 300, výška:200 })
Pridávanie stránok pomocou súpravy PDFKit
Ak chcete do dokumentu PDF pridať nové strany, jednoducho zavolajte na addPage metóda na inštancii dokumentu:
doc.addPage()
Ak chcete automaticky pridať obsah vždy, keď pridáte novú stránku, použite stránkaPridaná udalosť na inštancii dokumentu.
Napríklad:
doc.on('pageAdded', () => doc.text("Kódovanie je jednoduché!"));
PDFKit vám umožňuje určiť rozmery strany pri vytváraní nového dokumentu alebo pridávaní novej strany k existujúcemu. Existuje niekoľko preddefinovaných veľkostí strán Papierová dokumentácia PDFKit vysvetľuje.
Ak chcete použiť ktorúkoľvek z týchto preddefinovaných veľkostí strany, odovzdajte objekt do ktorejkoľvek z týchto preddefinovaných veľkostí PDFDocument konštruktér alebo addPage() metóda. Pomocou vlastnosti size zadajte reťazec, ktorý je názvom veľkosti papiera.
Napríklad:
// konštruktor
konšt doc = Nový PDFDocument({ veľkosť: 'A5' });
// funkcia addPage
doc.addPage({ veľkosť: 'A7' });
Odovzdanie objektu tejto možnosti PDFDocument Konštruktor nastaví predvolenú veľkosť strany pre celý dokument. Toto predvolené nastavenie potom môžete prepísať odovzdaním inej hodnoty do addPage metóda.
Okraje stránky môžete nastaviť odovzdaním objektu do marže vlastnosť pri pridávaní stránok.
The marže vlastnosť berie predmet s hore, dole, vľavo, a správny vlastnosti reprezentujúce každý okraj.
Napríklad:
// Na každú stranu pridajte iné okraje
doc.addPage({
okraje: {
hore: 72,
dole: 72,
vľavo: 50,
správny: 50
}
});
Tento kód nastavuje horný a dolný okraj na 72 bodov a ľavý a pravý okraj na 50 bodov. Všimnite si, že predvolený okraj pre dokumenty vytvorené PDFKit je 1-palcový (72-bodový) okraj na všetkých stranách.
Ak chcete nastaviť všetky horné, spodné, ľavé a pravé okraje na rovnakú hodnotu, jednoducho prejdite objekt s a marža majetok k addPage metóda:
doc.addPage({ marža: 60 }) // pridajte okraj 60 bodov na každú stranu
Výhody vytvárania PDF s PDFKit v Node.js
PDFKit vám umožňuje vytvárať štandardné a podporované dokumenty z vašich aplikácií Node.js. S PDFKit môžete ľahko spracovávať zložité dokumenty. Okrem toho môže uľahčiť doručovanie dokumentov používateľom a zjednodušiť ich zdieľanie a tlač.