Il est possible de passer à l'API les options suivantes :

Option Description Valeur par défaut
header_html Une chaîne HTML pour l'en-tête de page
header_spacing La largeur de l'espacement entre l'entête de page et le corps du document (nombre réel sans unité, par ex. 4) 0
footer_html Une chaîne HTML pour le pied de page
footer_spacing La largeur de l'espacement entre le pied de page et le corps du document (nombre réel sans unité, par ex. 2.5) 0
header_footer_exclude_pages Une chaîne contenant la liste des pages (séparées par des virgules) dans lesquelles le header et le footer ne doivent pas apparaître. Les nombres négatifs représentent les pages avant la dernière page (par ex. -1 pour la dernière, -2 pour l'avant-dernière, etc.).
Note: Ne fonctionne qu'avec les header et footer HTML. Par exemple, passer la chaîne '1,3,5' fera que les pages 1, 3 et 5 n'auront pas de header ni de footer.
header_text_left Une chaîne pour la partie de gauche de l'entête de page
header_text_center Une chaîne pour la partie centrale de l'entête de page
header_text_right Une chaîne pour la partie de droite de l'entête de page
footer_text_left Une chaîne pour la partie de gauche du pied de page
footer_text_center Une chaîne pour la partie centrale du pied de page
footer_text_right Une chaîne pour la partie de droite du pied de page
width La dimension de largeur de page du document, avec l'unité (par ex. 210mm)
height La dimension de hauteur de page du document, avec l'unité (par ex. 297mm)
margin_top La dimension de la marge du haut, avec l'unité (ex. 20mm) 10mm
margin_right La dimension de la marge de droite, avec l'unité (ex. 20mm) 10mm
margin_bottom La dimension de la marge du bas, avec l'unité (ex. 20mm) 10mm
margin_left La dimension de la marge de gauche, avec l'unité (ex. 20mm) 10mm
page_size Le nom de la taille de page à utiliser (par ex. A3)
Voir la liste complète
A4
orientation Le nom de l'orientation de page choisie pour le document. Peut être landscapeou portrait portrait

Le HTML ou le texte fourni pour créer les header et footer peut comporter des mots entourés de doubles-accolades (par ex. {{page}}) qui seront remplacées par des informations relatives au rendu du document.
Les informations qui seront remplacées sont les suivantes :

  • {{page}} : Remplacé par le numéro de la page en cours d'impression
  • {{frompage}} : Remplacé par le numéro de la première page imprimée
  • {{topage}} : Remplacé par le numéro de la dernière page à imprimer
  • {{webpage}} : Remplacé par l'URL de la page en cours d'impression
  • {{section}} : Remplacé par le nom de la section (titre, chapitre...) de la page courante
  • {{subsection}} : Remplacé par le nom de la sous-section de la page courante
  • {{date}} : Remplacé par la date courante
  • {{time}} : Remplacé par l'heure courante

Notez que c'est applicable à toutes les options suivantes : header_html, footer_html, header_text_left, header_text_center, header_text_right, footer_text_left, footer_text_center et footer_text_right.

Attention cependant, la date et l'heure sont affichées au format défini par le système du serveur de pdf.kiwi.

Exemple d'utilisation d'une option de header

Par exemple, pour un document qui fera 5 pages, en passant la chaîne suivante à l'option header_html :

"Page {{page}} sur {{topage}}"

Nous obtiendrons, dans l'entête de page : Page 1 sur 5.

Note

Si les options header_text_* et l'option header_html sont présentes en même temps, pdf.kiwi fera le rendu des deux au même endroit (ici, dans l'entête de page). Cela peut être autant pratique que gênant (surtout si les deux se superposent). Même chose avec les options footer_text_* et l'option footer_html pour le pied de page.

résultats pour ""

    Aucun résultat pour ""