Une page d'un PDF fourni, posée sur la page
Reprendre une page d'un PDF envoyé avec la requête et la poser dans un cadre, à ses proportions, au milieu des autres éléments.
Demandé avec
"type": "pdf_page"
En mots de tous les jours
Écrit pour tout le monde. Il dit ce que cela pose sur une feuille de papier, et ne vous demande rien de plus.
Vous avez déjà un document en PDF : un bon de garantie, un plan, un reçu. Plutôt que de le refaire, vous l'envoyez tel quel et vous demandez qu'une de ses pages vienne se poser dans un cadre de votre nouvelle feuille. La page gardera sa forme : elle grandit jusqu'à toucher le bord le plus proche et se centre dans ce qui reste, sans être écrasée. Autour d'elle, vous continuez à écrire, à dessiner et à mettre des tableaux comme d'habitude.
Pour un développeur
Écrit pour celui qui écrit le programme appelant : le modèle, les unités, et les réglages qui portent le poids.
Les octets du PDF source voyagent avec la requête, dans une partie nommée ; la clé pdf reprend ce nom, et c'est le même vivier que les gabarits, donc un même fichier fourni sert de fond de page et d'article posé. Le numéro de page compte à partir de 1. La page importée garde ses proportions : elle est mise à l'échelle jusqu'à rencontrer la largeur ou la hauteur du cadre, puis centrée dans le reste. À la différence d'un gabarit, qui tapisse toute la page en dessous du contenu, cet article est un élément parmi les autres, placé dans une boîte, et donc combinable avec du texte à côté.
Chaque clé, avec son défaut
La référence : quelles clés sont obligatoires, lesquelles sont facultatives, ce que vaut chacune par défaut et quelles combinaisons le serveur décline.
Clés obligatoires : pdf, chaîne, le nom de la partie fournie ; rect. Facultatives : page, entier en base 1, défaut 1 ; pages, tableau d'entiers en base 1, défaut vide pour toutes les pages du document produit ; transform, six nombres ; rotate, degrés dans le sens trigonométrique autour du centre de la boîte ; layer, nom d'un calque déclaré. Refus croisé : transform et rotate ensemble. Le rendu conserve les proportions de la page importée : la clé d'ajustement des images n'a pas d'équivalent ici.
Une requête entière qui le dessine
Envoyez ceci tel quel et un PDF revient. Rien n'en a été retiré.
{
"items": [
{
"type": "pdf_page",
"pdf": "receipt.pdf",
"page": 1,
"rect": {"llx": 72, "lly": 480, "urx": 523, "ury": 780}
}
]
}Images et pages importées
Où aller ensuite
Chaque clé d'une requête, en une page Les vingt autres choses que l'on peut dessiner
Glossaire
- octet
- L'unité dans laquelle se compte le poids d'un fichier, comme un colis se compte en grammes. Mille octets font un kilo-octet, un million font un méga-octet — la taille d'une photo prise avec un téléphone. Un PDF d'une page pèse ici entre six mille et cent vingt mille, donc cent PDF tiennent dans la place de cinq photos.
- requête
- Un appel au service : vous envoyez ce que le document doit dire, et vous recevez le document. Votre facture compte ces appels, un par document. Le nombre de pages d'un document n'est jamais compté.
- calque
- Un groupe nommé de choses dessinées sur une page, que le lecteur peut afficher ou masquer, comme un calque posé sur un plan. Un plan peut garder ses cotes sur l'un et ses notes sur l'autre, et un calque peut être réglé pour s'afficher à l'écran et rester hors de l'impression.