A PDFKit egy Node.js könyvtár, amely megkönnyíti a fejlesztők számára a PDF-fájlok létrehozását és a velük való munkát. Egyszerű, de hatékony API-t kínál PDF-fájlok előállításához és különféle tartalom hozzáadásához, például szöveghez, képekhez és alakzatokhoz.
Ismerje meg, hogyan használhatja a PDF Kitet PDF-fájlok létrehozásához a Node.js-ben.
A PDFkit beállítása
Biztos van Node.js és npm (a Node.js csomagkezelő) telepítve van a gépére követni.
Győződjön meg arról, hogy ezek az eszközök telepítve vannak a következő terminálparancsok futtatásával:
csomópont -v
npm -v
A PDFKit Node.js projektben való használatának megkezdéséhez telepítse a következő npm parancs futtatásával:
npm pdfkit telepítése
Ez a parancs telepíti a PDFKit-et, és hozzáadja a projekt függőségeihez.
PDF-dokumentum létrehozása a PDFKit segítségével
PDF-dokumentum PDFKit segítségével történő létrehozásához szükséges a
pdfkit csomagot és a fs (fájlrendszer) modult a szkriptfájlban:const PDFDocument = igényelnek('pdfkit');
const fs = igényelnek("fs");
Ezután hozzon létre egy új példányt a PDFDocument osztály. Ez az osztály egy PDF fájlt képvisel:
const doki = új PDFDocument();
A létrehozott példány egy olvasható adatfolyam, ami azt jelenti, hogy használhatja a cső() módszerrel a tartalmát fájlba mentheti.
Ehhez cső a doc példánya által létrehozott írható adatfolyamba fs.createWriteStream:
doc.pipe (fs.createWriteStream("MyPDFDoc.pdf"));
A CreateWriteStream módszer elmenti a PDF-fájl tartalmát a helyi fájlrendszer meghatározott helyére.
A fenti kódblokk elmenti az eredményül kapott PDF-fájlt az aktuális munkakönyvtárba a névvel MyPDFDoc.pdf.
Fontos, hogy mindig fejezze be az adatfolyamot, miután tartalmat ad hozzá a PDF-hez. Ezt a következő paranccsal teheti meg:
doc.end();
Most futtassa a node parancsot csomópont [szkript neve] a PDF fájl létrehozásához MyPDFDoc.pdf az aktuális munkakönyvtárában.
Szöveg hozzáadása a PDFKit segítségével
Mielőtt elmentené a dokumentumot, különféle módosításokat hajthat végre. A PDFKit egyszerűvé teszi a szöveg hozzáadását a dokumentumokhoz, és számos lehetőséget kínál a kimenet megjelenítésének testreszabására.
Ha szöveget szeretne hozzáadni a dokumentumhoz, egyszerűen hívja a szöveg() metódust, és adja át argumentumként a hozzáadni kívánt szöveget:
doc.text("A kódolás egyszerű!")
Amikor a PDFKIT szöveget ad a dokumentumhoz, nyomon követi a szöveg aktuális X és Y pozícióját. Tehát, amikor meghívja a szöveges metódust, a PDFKit egy új sort fog hozzáadni az előzőhöz.
Ha azonban maga a szöveg után X és Y koordinátákat ad meg a szövegmódszernek, megváltoztathatja a pozícióját:
doc.text('A kódolás egyszerű!', 100, 100)
Ha egy sorral felfelé vagy lefelé szeretne lépni, hívja a mozgassa le vagy felfelé metódus a szövegnek mozgatandó sorok számával:
doc.moveDown(3);
doc.moveUp();
Alapértelmezés szerint, ha bármelyik metódust argumentum átadása nélkül hívja meg, az egyetlen sorral mozog.
A PDFKit támogatja a PDF formátum által meghatározott 14 szabványos betűtípus mindegyikét. A PDFKit szöveges dokumentáció tartalmazza ezeknek a szabványos betűtípusoknak a teljes listáját.
Használja a betűtípus() módszerrel megadhatja a kívánt betűtípust. Csak adja meg a megfelelő betűtípus nevét karakterláncként:
doc.font("Times-Roman")
.szöveg('A kódolás egyszerű!');A betűméretet és a szöveg színét a gombbal is módosíthatja betűméret() és a kitöltőszín() módszerek, ill.
Például:
// Ez pirosra változtatja a szöveg színét, és 8-as betűméretet ad
doc.fillColor('piros')
.betűméret(8)
.szöveg('A kódolás egyszerű!');
Képek hozzáadása PDFKit segítségével
A PDF-dokumentumban lévő képhez egyszerűen adja át az elérési utat a kép módszer a dokumentumpéldányon:
doc.image("útvonal/kép.jpeg")
A PDFKit lehetővé teszi képek hozzáadását bármelyikhez JPEG vagy PNG formátum.
Alapértelmezés szerint a PDFKit a képet eredeti méretében szúrja be. Módosíthatja a kép méreteit, ha kulcs-érték párokat tartalmazó objektumot ad meg argumentumként a kép() módszer. Megadhat szélességet, magasságot, valamint vízszintes és függőleges igazítást.
Például:
// Csak a szélesség megadása
doc.image("útvonal/kép.jpg", { szélesség: 300 });
// A szélesség és a magasság megadása
doc.image("útvonal/kép.jpg", { szélesség: 300, magasság:200 })
Oldalak hozzáadása PDFKit segítségével
Ha új oldalakat szeretne hozzáadni a PDF-dokumentumhoz, egyszerűen hívja a oldal hozzáadása módszer a dokumentumpéldányon:
doc.addPage()
Ha új oldal hozzáadásakor automatikusan hozzá szeretne adni tartalmat, használja a oldal Hozzáadva esemény a dokumentumpéldányon.
Például:
doc.on('oldal hozzáadva', () => doc.text("A kódolás egyszerű!"));
A PDFKit lehetővé teszi az oldalméretek megadását új dokumentum készítésekor vagy új oldal hozzáadásakor egy meglévőhöz. Számos előre meghatározott oldalméret létezik, amelyek a PDFKit papíralapú dokumentáció magyarázza.
Ezen előre meghatározott oldalméretek bármelyikének használatához adjon át egy objektumot a PDFDocument kivitelező vagy a oldal hozzáadása() módszer. A size tulajdonság segítségével adjon meg egy karakterláncot, amely a papírméret neve.
Például:
// konstruktor
const doki = új PDFDocument({ méret: "A5" });
// AddPage függvény
doc.addPage({ méret: "A7" });
Ezt az opciós objektumot átadva a PDFDocument konstruktor beállítja az alapértelmezett oldalméretet a teljes dokumentumra. Ezután felülírhatja ezt az alapértelmezett értéket, ha egy másik értéket ad át a oldal hozzáadása módszer.
Az oldalmargókat úgy állíthatja be, hogy átad egy objektumot a margók tulajdonságot oldalak hozzáadásakor.
A margók tulajdonság vesz egy tárgyat fent, lent, bal, és jobb minden margót képviselő tulajdonságok.
Például:
// Különböző margók hozzáadása mindkét oldalhoz
doc.addPage({
margók: {
tetejére: 72,
alsó: 72,
bal: 50,
jobb: 50
}
});
Ez a kód a felső és alsó margót 72 pontra, a bal és jobb margót pedig 50 pontra állítja be. Vegye figyelembe, hogy a PDFKit által létrehozott dokumentumok alapértelmezett margója minden oldalon 1 hüvelykes (72 pontos) margó.
Ha az összes felső, alsó, bal és jobb margót ugyanarra az értékre szeretné beállítani, egyszerűen adjon át egy objektumot a-val árrés tulajdon a oldal hozzáadása módszer:
doc.addPage({ árrés: 60 }) // adjunk hozzá 60 pontos margót mindkét oldalhoz
A PDF-ek létrehozásának előnyei a PDFKit segítségével a Node.js-ben
A PDFKit lehetővé teszi szabványos és támogatott dokumentumok előállítását a Node.js alkalmazásaiból. A PDFKit segítségével könnyedén kezelheti az összetett dokumentumokat. Ezenkívül megkönnyítheti a dokumentumoknak a felhasználókhoz való eljuttatását, valamint egyszerűbbé teheti azok megosztását és nyomtatását.
