תיעוד מלא: fpdf.FPDF API doc
[TOC]
נתחיל בדוגמא קלאסית:
{% include "../tutorial/tuto1.py" %}אחרי שכללנו את קובץ הספריה, יצרנו אובייקט FPDF.
הבנאי של FPDF משתמש כאן בערכים דיפולטיביים:
דפים בפורמט A4 לאורך והמידות במילימטרים. ניתן לציין זאת במפורש באמצעות:
pdf = FPDF(orientation="P", unit="mm", format="A4")ניתן להגדיר את הPDF לרוחב (L) או להשתמש בתבניות שונות (כמו Letter או Legal) ומידות שונות (כמו pt, cm, in).
כרגע אין עמודים, נצטרך להוסיף אחד בעזרת add_page. המקור הוא בפינה השמאלית עליונה והפוזיציה הנוכחית בברירת המחדל היא סנטימטר אחד מהגבולות; ניתן לשנות את השוליים על ידי set_margins.
לפני שנוכל להדפיס טקסט, חובה לבחור גופן בעזרת set_font, אחרת המסמך לא יהיה תקין. אנחנו בוחרים בגופן helvetica מודגש בגודל 16:
pdf.set_font('helvetica', 'B', 16)יכולנו לבחור הטייה עם I, קו תחתון עם U, או גופן רגיל עם מחרוזת ריקה (או כל שילוב של הנ"ל). שימו לב שגודל הגופן הוא בנקודות ולא מילימטרים או כל יחידת מידה אחרת. זה יוצא הדופן היחיד. הגופנים המובנים האחרים הם Times, Courier, Symbol, ZapfDingbats.
כעת נוכל להדפיס תא עם cell. תא הוא איזור מלבני, אולי ממוסגר, שמכיל טקסט. נוצר בפוזיציה הנוכחית. אנחנו מציינים את המידות שלו, טקסט (ממורכז או מיושר), האם לצייר גבולות, ולאן תזוז הפוזיציה הנוכחית לאחר התא (מימין, למטה או בתחילת השורה הבאה). כדי להוסיף מסגרת, נריץ:
pdf.cell(40, 10, 'Hello World!', 1)כדי להוסיף ליד התא הקודם תא עם טקסט ממורכז ואז ללכת לשורה הבאה, נריץ:
pdf.cell(60, 10, 'Powered by FPDF.', new_x="LMARGIN", new_y="NEXT", align='C')הערה: אפשר ליצור שורה רווח גם בעזרת ln. השיטה הזו מאפשרת גם לציין את גובה הרווח.
לבסוף, הקובץ נסגר ונשמר תחת הכתובת שסופקה באמצעות output.
ללא פרמטרים נוספים, ()output מחזיר את הבאפר bytearray של הPDF.
דוגמא בעלת שני עמודים עם כותרת עליונה, כותרת תחתונה ולוגו:
{% include "../tutorial/tuto2.py" %}הדוגמא משתמשת במתודות header וfooter על מנת לעבד כותרות עמוד. הן נקראות אוטומטית. הן כבר קיימות במחלקה FPDF ולא עושות כלום, לכן נצטרך להרחיב את המחלקה ולדרוס אותן.
הלוגו מודפס עם מתודת הimage ע"י ציון הנקודה השמאלית-עליונה ואת הרוחב. הגובה מחושב אוטומטית לפי מידות התמונה.
על מנת להדפיס את מספר העמוד, ניתן להעביר ערך null כרוחב התא. כך התא יתרחב עד השול הימני של העמוד; זה שימושי כאשר צריך למרכז את הטקסט. מספר העמוד הנוכחי חוזר ממתודת הpage_no; לגבי מספר העמודים הכולל, ניתן להשיג נתון זה מהערך המיוחד {nb} שיוחלף בסגירת המסמך (ניתן לשנות ערך זה ע"י שימוש ב()alias_nb_pages).
שימו לב למתודה set_y שמאפשרת להגדיר פוזיציה אבסולוטית בדף, מראש או תחתית העמוד.
נעשה גם שימוש בפיצ'ר נוסף כאן: מעבר עמוד אוטומטי. ברגע שתא יחרוג מגבולות הדף (בברירת מחדל 2 סנטימטר מהסוף), מתתבצע מעבר עמוד והגופן חוזר להיות מה שהוגדר עבור גוף העמוד. למרות שהכותרת העליונה והתחתונה משתמשות בגופן (helvetica), גוף העמוד ממשיך עם Times. המנגנון הזה תקף גם לגבי צבע ורוחב שורה. הגבול שמפעיל את מעבר העמוד האוטומטי ניתן לשינוי באמצעות set_auto_page_break.
נמשיך עם דוגמא שמדפיסה פסקאות ומדגימה שימוש בצבעים.
{% include "../tutorial/tuto3.py" %}מתודת הget_string_width מאפשרת לקבוע אורך מחרוזת בגופן הנוכחי, שבדוגמא זו משמש כדי לחשב את הפוזיציה והרוחב של המסגרת המקיפה את הכותרת. לאחר מכן מוגדרים צבעים (באמצעות set_draw_color, set_fill_color ו set_text_color) ועובי השורה מוגדר למילימטר (בניגוד ל0.2 מילימטר כברירת מחדל) באמצעות set_line_width. לבסוף אנחנו מדפיסים את התא (הפרמטר האחרון true מעיד שהרקע צריך להיות מלא).
המתודה בה משתמשים להדפסת הפסקא היא multi_cell. טקסט נחתך אוטומטית בסוף השורה כברירת מחדל. בכל פעם ששורה מגיעה לקצה הימני של התא או שנמצא התו (n\), נוצרת שורה חדשה בתא חדש מתחת לנוכחי. הפסקת שורה אוטומטית נוצרת במיקום של הרווח הקרוב או תו בלתי-נראה (u00ad\) לפני סוף השורה. התו יוחלף במקף אם הופעלה הפסקת שורה.
שתי תכונות מסמך הוגדרו: שם המסמך (set_title) ויוצר (set_author). ניתן לצפות בתכונות בשני אופנים: אופציה ראשונה היא לפתוח את המסמך בAdobe Reader ישירות, ואז ב'תפריט' לבחור 'תכונות מסמך'. אופציה שניה, זמינה גם באמצעות תוסף, זה לחצן ימני ואז לבחור תכונות מסמך.
הדוגמא הזו דומה לקודמת ומראה איך לפרוס טקסט על פני מספר עמודות.
{% include "../tutorial/tuto4.py" %}ההבדל העיקרי בין דוגמא זו לקודמת הוא השימוש במתודות accept_page_break וset_col
ע"י שימוש במתודה accept_page_break, ברגע שתא חורג מהגבול התחתון של הדף, המתודה בודקת את מספר העמודה הנוכחי. אם הוא קטן מ2 (בחרנו לחלק את הדף ל3 עמודות) תיקרא המתודה set_col, שמגדילה את מספר העמודה ומשנה את הפוזיציה של העמודה הבאה כך שהטקסט ימשיך בה.
ברגע שהגענו לגבול התחתון של העמודה השלישית, המתודה accept_page_break תאותחל, תחזור לעמודה הראשונה ותיצור מעבר עמוד.
{% include "../tutorial/tuto5.py" %}This section has changed a lot and requires a new translation: #267
English versions:
דוגמא זו מציגה מספר דרכים להוסיף קישורים למסמך וקישורים חיצוניים. בנוסף הדוגמא ממחישה שימוש בסגנונות שונים של עיצוב טקסט (מודגש, נטוי, קו תחתון) באותו טקסט.
{% include "../tutorial/tuto6.py" %}
המתודה החדשה שמשומשת כאן כדי להדפיס טקסט היא ()write. דומה מאוד ל()multi_cell, כאשר ההבדלים העיקריים הם:
- סוף השורה הוא בגבול הימני והשורה הבאה מתחילה בגבול השמאלי
- הפוזיציה הנוכחית זזה לסוף שורת הטקסט
לפיכך המתודה מאפשרת לנו לכתוב קטע טקסט, לשנות את סגנון הגופן, ולהמשיך מאותו מקום שעצרנו. מצד שני, החסרון העיקרי הוא שלא ניתן ליישר את הטקסט כמו ב()multi_cell.
בעמוד הראשון של הדוגמא השתמשנו ()write למטרה זו. תחילת המשפט נכתב בסגנון טקסט רגיל ואז על ידי שימוש במתודה ()set_font החלפנו לטקסט עם קו תחתון לסיום המשפט.
כדי להוסיף קישור פנימי שמוביל לעמוד השני השתמשנו במתודה ()add_link שוצרת איזור ניתן להקלקה שנתנו לו את השם "קישור" שמוביל לאיזור אחר באותו המסמך.
על מנת ליצור קישור חיצני באמצעות תמונה, השתמשנו במתודה ()image. למתודה יש אופציה לקבל קישור כאחד הפרמטרים שלה. הקישור יכול להיות פנימי או חיצוני.
ניתן גם להשתמש במתודה ()write_html כדי לשנות סגנונות גופן ולהוסיף קישורים. זהו פארסר של html, שמאפשר להוסיף טקסט, לשנות את הסגנון ולהוסיף קישורים באמצעות html.