Aller au contenu principal

Configuration de page

L'objet pageSetup contrôle la disposition physique de chaque page de votre PDF. Toutes les propriétés sont facultatives et se rabattent sur des valeurs sensées lorsqu'elles sont omises.

Propriétés

PropriétéTypeDéfautDescription
sizestring"A4"Taille de page nommée
orientationstring"portrait"Orientation de la page
marginsnumber[][36, 36, 36, 36]Marges en points : [haut, droit, bas, gauche]
backgroundColorstring | string[]Arrière-plan de la page. Chaîne hex unique pour une couleur, tableau pour banding par page (boucles lorsqu'il y a moins d'entrées que de pages).
borderTopstringBordure de page supérieure — raccourci CSS "<width> <style> <color>" (ex. "1pt solid #000", "none").
borderRightstringBordure de page droite (raccourci CSS).
borderBottomstringBordure de page inférieure (raccourci CSS).
borderLeftstringBordure de page gauche (raccourci CSS).

Tailles de page

DocPayload prend en charge toutes les tailles de page ISO et nord-américaines standard :

Série ISO A

TailleDimensions (mm)
A0841 x 1189
A1594 x 841
A2420 x 594
A3297 x 420
A4210 x 297
A5148 x 210
A6105 x 148
A774 x 105
A852 x 74
A937 x 52
A1026 x 37

Série ISO B

TailleDimensions (mm)
B1707 x 1000
B2500 x 707
B3353 x 500
B4250 x 353
B5176 x 250
B6125 x 176
B788 x 125
B862 x 88
B944 x 62
B1031 x 44

Tailles nord-américaines

TailleDimensions (po)
LETTER8.5 x 11
LEGAL8.5 x 14
TABLOID11 x 17
LEDGER17 x 11
EXECUTIVE7.25 x 10.5

Omettez size pour se rabattre sur la valeur par défaut du moteur (A4).

Orientation

ValeurDescription
portraitPlus haut que large (défaut)
landscapePlus large que haut

Lorsque landscape est défini, les dimensions de la page sont inversées. Par exemple, A4 en paysage produit une page 297 x 210 mm.

Marges

Les marges sont spécifiées comme un tableau de quatre éléments en points (1 point = 1/72 pouce) :

[haut, droit, bas, gauche]

À titre de référence :

  • 72 points = 1 pouce = 25.4 mm
  • 50 points équivaut à environ 17.6 mm ou 0.69 pouces

Exemples

A4 portrait avec marges par défaut

{
"document": {
"pageSetup": {
"size": "A4",
"orientation": "portrait",
"margins": [50, 40, 50, 40]
},
"content": [
{ "p": "Document A4 standard." }
]
}
}

Lettre américaine paysage avec larges marges

{
"document": {
"pageSetup": {
"size": "LETTER",
"orientation": "landscape",
"margins": [72, 72, 72, 72]
},
"content": [
{ "p": "Lettre en paysage avec marges de 1 pouce sur tous les côtés." }
]
}
}

Légal portrait avec marges latérales étroites

{
"document": {
"pageSetup": {
"size": "LEGAL",
"orientation": "portrait",
"margins": [60, 30, 60, 30]
},
"content": [
{ "p": "Document de taille légale avec marges latérales étroites pour une largeur de contenu maximale." }
]
}
}

Tabloid pour les rapports grand format

{
"document": {
"pageSetup": {
"size": "TABLOID",
"orientation": "portrait",
"margins": [50, 50, 50, 50]
},
"content": [
{ "p": "Document de taille tabloid pour les graphiques et diagrammes volumineux." }
]
}
}

Couleurs d'arrière-plan de page

Appliquez différentes couleurs d'arrière-plan aux pages successives. Les couleurs se réutilisent s'il y a plus de pages que d'entrées.

{
"document": {
"pageSetup": {
"size": "A4",
"margins": [
50,
40,
50,
40
],
"backgroundColor": [
"#FAFAFA",
"#F0F4FF"
]
},
"content": [
{
"p": "La page 1 a un arrière-plan gris clair."
},
{
"break": "page"
},
{
"p": "La page 2 a un arrière-plan bleu clair."
},
{
"break": "page"
},
{
"p": "La page 3 revient au gris clair."
}
]
}
}
remarque

backgroundColor s'affiche actuellement au-dessus du contenu dans certaines configurations. Utilisez des couleurs claires et subtiles et testez votre sortie pour assurer la lisibilité.

Bordures de page

Ajoutez des règles de bordure à chaque page. Chaque côté est sa propre propriété — borderTop, borderRight, borderBottom, borderLeft — en utilisant le raccourci CSS "<width> <style> <color>". Les composants sont indépendamment facultatifs et peuvent apparaître dans n'importe quel ordre ; "none" supprime le côté. Les côtés sont indépendants : définir borderTop ne réinitialise pas les autres.

{
"document": {
"pageSetup": {
"size": "A4",
"margins": [50, 40, 50, 40],
"borderTop": "0.5pt solid #CCCCCC",
"borderBottom": "0.5pt solid #CCCCCC"
},
"content": [
{ "p": "Ce document a des règles grises fines en haut et en bas de chaque page." }
]
}
}

Combinez les quatre côtés pour un cadre de page complet :

"pageSetup": {
"borderTop": "1pt solid #1A1A2E",
"borderRight": "1pt solid #1A1A2E",
"borderBottom": "1pt solid #1A1A2E",
"borderLeft": "1pt solid #1A1A2E"
}

Remplacements par section

La pageSetup à la racine du document est la valeur par défaut pour chaque page. Pour modifier la configuration de la page en cours de route — un appendice en paysage, une taille de page différente pour une insertion, des marges plus étroites pour un chapitre — partitionnez le document avec une rupture de section qui porte sa propre pageSetup en ligne.

{
"document": {
"pageSetup": {
"size": "LETTER",
"orientation": "portrait",
"margins": [50, 50, 50, 50]
},
"content": [
{ "h1": "Corps principal" },
{ "p": "S'affiche avec la pageSetup de la racine du document (LETTER portrait)." },

{ "break": "section",
"pageSetup": {
"size": "TABLOID",
"orientation": "landscape",
"margins": [30, 30, 30, 30],
"backgroundColor": "#FAFAFA"
}
},

{ "h1": "Appendice" },
{ "p": "S'affiche TABLOID en paysage avec la pageSetup de l'appendice appliquée à chaque page de cette section." }
]
}
}

La pageSetup en ligne sur la rupture accepte chaque clé que le pageSetup de la racine du document accepte — size, orientation, margins, backgroundColor, borderTop/borderRight/borderBottom/borderLeft. Chaque propriété est indépendante : omettez une clé pour l'hériter de la racine du document. La rupture accepte également header / footer en ligne pour le chromage par section (consultez En-têtes et pieds de page).

pageSetup est uniquement pour la configuration au niveau de la page — il n'accepte pas les clés de formatage de contenu comme fontSize ou color. Celles-ci appartiennent à styles et s'appliquent aux éléments de texte, pas aux pages.

Une rupture de section commence une nouvelle page lorsque la configuration de page résolue diffère de celle de la section précédente. Les sections partageant une configuration identique peuvent s'afficher sur la même page physique.