PDFKit היא ספריית Node.js שמקלה על מפתחים ליצור ולעבוד עם קובצי PDF. הוא מציע ממשק API פשוט אך יעיל להפקת קובצי PDF והוספת סוגים שונים של תוכן אליהם, כגון טקסט, תמונות וצורות.
למד כיצד להשתמש בערכת PDF ליצירת קובצי PDF ב-Node.js.
הגדרת PDFkit
אתה חייב שיהיה לך Node.js ו-npm (מנהל החבילות של Node.js) מותקנים במחשב שלך לעקוב.
ודא שהכלים האלה מותקנים על ידי הפעלת פקודות הטרמינל הבאות:
node -v
npm -v
כדי להתחיל להשתמש ב-PDFKit בפרויקט Node.js שלך, התקן אותו על ידי הפעלת הפקודה npm הבאה:
npm להתקין pdfkit
פקודה זו תתקין את PDFKit ותוסיף אותו לתלות של הפרויקט שלך.
יצירת מסמך PDF עם PDFKit
כדי ליצור מסמך PDF באמצעות PDFKit, דרשו את ה pdfkit החבילה ואת fs מודול (מערכת קבצים) בקובץ הסקריפט שלך:
const PDFDocument = לִדרוֹשׁ('pdfkit');
const fs = לִדרוֹשׁ('fs');
לאחר מכן, צור מופע חדש של PDFDocument מעמד. מחלקה זו מייצגת קובץ PDF:
const דוק = חָדָשׁ PDFDocument();
המופע שנוצר הוא זרם קריא, מה שאומר שאתה יכול להשתמש ב- צינור() שיטה לשמור את תוכנו בקובץ.
כדי לעשות זאת, צינור את דוק מופע לתוך זרם ניתן לכתיבה שנוצר על ידי fs.createWriteStream:
doc.pipe (fs.createWriteStream('MyPDFDoc.pdf'));
ה createWriteStream השיטה שומרת את התוכן של קובץ PDF למיקום מוגדר במערכת הקבצים המקומית.
בלוק הקוד לעיל ישמור את קובץ ה-PDF שיתקבל בספריית העבודה הנוכחית שלך, עם השם MyPDFDoc.pdf.
חשוב תמיד לסיים את הזרם לאחר הוספת תוכן ל-PDF. אתה יכול לעשות זאת באמצעות הפקודה הזו:
doc.end();
כעת הפעל את פקודת הצומת צומת [שם סקריפט] כדי ליצור את קובץ ה-PDF MyPDFDoc.pdf בספריית העבודה הנוכחית שלך.
הוספת טקסט עם PDFKit
לפני שתעביר את המסמך שלך כדי לשמור אותו, תוכל לבצע שינויים שונים. PDFKit הופכת הוספת טקסט למסמכים לפשוטה וכוללת אפשרויות רבות להתאמה אישית של תצוגת הפלט.
כדי להוסיף טקסט למסמך, פשוט התקשר ל- טֶקסט() שיטה והעבירו את הטקסט שברצונכם להוסיף כארגומנט:
doc.text("קידוד קל!")
כאשר PDFKIT מוסיף טקסט למסמך, הוא עוקב אחר מיקומי ה-X וה-Y הנוכחיים של הטקסט. אז בכל פעם שאתה קורא לשיטת הטקסט, PDFKit יוסיף שורה חדשה מתחת לקודמתה.
עם זאת, על ידי מתן קואורדינטות X ו-Y לשיטת הטקסט לאחר הטקסט עצמו, תוכל לשנות את מיקומו:
doc.text('קידוד קל!', 100, 100)
כדי לנוע למעלה או למטה בקו, התקשר ל- לרדת אוֹ moveUp שיטה עם מספר השורות שהטקסט צריך להזיז:
doc.moveDown(3);
doc.moveUp();
כברירת מחדל, קריאה לאחת מהשיטות מבלי להעביר ארגומנט תגרום לה לזוז בשורה בודדת בלבד.
PDFKit תומך בכל אחד מ-14 הגופנים הסטנדרטיים המוגדרים על ידי פורמט PDF. ה תיעוד טקסט PDFKit יש רשימה מלאה של גופנים סטנדרטיים אלה.
להשתמש ב גוֹפָן() שיטה לציון הגופן הנדרש. פשוט תעביר את שם הגופן המתאים כמחרוזת:
doc.font('טיימס-רומן')
.טֶקסט('קידוד קל!');
אתה יכול גם לשנות את גודל הגופן וצבע הטקסט באמצעות גודל גופן() וה צבע מילוי() שיטות, בהתאמה.
לדוגמה:
// זה משנה את צבע הטקסט לאדום ונותן לו גודל גופן של 8
doc.fillColor('אָדוֹם')
.גודל גופן(8)
.טֶקסט('קידוד קל!');
הוספת תמונות עם PDFKit
לתמונה למסמך ה-PDF שלך, פשוט העבר את הנתיב שלה אל תמונה שיטה על מופע המסמך:
doc.image('path/to/image.jpeg')
PDFKit מאפשר לך להוסיף תמונות בכל אחת מהן פורמט JPEG או PNG.
כברירת מחדל, PDFKit יוסיף את התמונה בגודלה המקורי. אתה יכול לשנות את מידות התמונה על ידי מתן אובייקט המכיל צמדי מפתח-ערך כארגומנט ל- תמונה() שיטה. ניתן לציין רוחב, גובה ויישור אופקי ואנכי.
לדוגמה:
// ציון הרוחב בלבד
doc.image('path/to/image.jpg', { רוֹחַב: 300 });
// ציון הן את הרוחב והן את הגובה
doc.image('path/to/image.jpg', { רוֹחַב: 300, גוֹבַה:200 })
הוספת דפים עם PDFKit
כדי להוסיף דפים חדשים למסמך PDF, פשוט התקשר ל- הוסף עמוד שיטה על מופע המסמך:
doc.addPage()
כדי להוסיף תוכן אוטומטית בכל פעם שאתה מוסיף דף חדש, השתמש ב- עמוד נוסף אירוע במופע המסמך.
לדוגמה:
doc.on('דף נוסף', () => doc.text("קידוד קל!"));
PDFKit מאפשר לך לציין את מידות העמוד בעת יצירת מסמך חדש או הוספת עמוד חדש לקיים. ישנם מספר גדלים מוגדרים מראש של עמודים תיעוד נייר PDFKit מסביר.
כדי להשתמש בכל אחד מגדלי העמודים המוגדרים מראש, העבר אובייקט לאחד מה- PDFDocument קונסטרוקטור או ה הוסף עמוד() שיטה. השתמש במאפיין size כדי לציין מחרוזת שהיא השם של גודל הנייר.
לדוגמה:
// קונסטרוקטור
const דוק = חָדָשׁ PDFDocument({ גודל: 'A5' });
// פונקציית addPage
doc.addPage({ גודל: 'A7' });
העברת אובייקט אופציות זה ל- PDFDocument הבנאי מגדיר את גודל העמוד המוגדר כברירת מחדל עבור המסמך כולו. לאחר מכן תוכל להחליף ברירת מחדל זו על ידי העברת ערך אחר ל- הוסף עמוד שיטה.
אתה יכול להגדיר שולי עמוד על ידי העברת אובייקט אל שוליים נכס בעת הוספת דפים.
ה שוליים מאפיין לוקח אובייקט עם למעלה, למטה, שמאל, ו ימין מאפיינים המייצגים כל שוליים.
לדוגמה:
// הוסף שוליים שונים בכל צד
doc.addPage({
שוליים: {
חלק עליון: 72,
תַחתִית: 72,
שמאלה: 50,
ימין: 50
}
});
קוד זה קובע את השוליים העליונים והתחתונים ל-72 נקודות, ואת השוליים השמאלי והימני ל-50 נקודות. שים לב ששוליים המוגדרים כברירת מחדל עבור מסמכים שנוצרו ב-PDFKit הם שוליים של 1 אינץ' (72 נקודות) מכל הצדדים.
כדי להגדיר את כל השוליים העליונים, התחתונים, השמאליים והימניים לאותו ערך, פשוט העבר אובייקט עם a שולים רכוש ל הוסף עמוד שיטה:
doc.addPage({ שולים: 60 }) // הוסף שוליים של 60 נקודות לכל צד
היתרונות של יצירת קובצי PDF עם PDFKit ב-Node.js
PDFKit מאפשר לך לייצר מסמכים סטנדרטיים ונתמכים מיישומי Node.js שלך. עם PDFKit, אתה יכול לטפל במסמכים מורכבים בקלות. בנוסף, זה יכול להקל על מסירת מסמכים למשתמשים ולהפוך אותם לפשוטים יותר לשיתוף והדפסה.