Noyau API

API principale

Ce guide montre comment ouvrir, modifier, assembler et enregistrer des documents PDF avec les classes Document et Page — les points d’entrée pour chaque opération dans Aspose.PDF FOSS pour TypeScript. Document charge, crée, assemble et enregistre des fichiers PDF complets; Page, accessible via doc.Pages, expose les opérations de texte, d’image, d’annotation et de flux de contenu par page.


Cycle de vie du document

Document.OpenFile() ouvre un PDF à partir d’un chemin de fichier; Document.Open() accepte un Uint8Array en mémoire. Les pages peuvent être inspectées et modifiées sur place, et Document.WriteTo() écrit le résultat en sortie — éventuellement avec compression de xref-stream et d’objet-stream.

import { Document } from '@asposefoss/pdf';

// Open from disk (or Document.Open(uint8array) for in-memory data)
const doc = Document.OpenFile('input.pdf');

// Inspect and edit pages
const pages = doc.Pages;
console.log(pages.length);
pages[0].Rotate = 90;
doc.RemovePage(2);                 // 1-based page number
doc.Reorder([3, 1, 2]);

// Metadata
doc.SetMetadata({ title: 'Report', author: 'Jane', custom: { Dept: 'R&D' } });

// Save
doc.WriteTo('output.pdf');         // or: const bytes = doc.Save();
doc.WriteTo('small.pdf', { compressed: true }); // xref stream + object streams

Fractionnement, fusion et extraction de pages

Document.Split() renvoie un Document par page. Document.ExtractPages() prend une liste de pages indexée à partir de 1, autorisant les répétitions, et renvoie un nouveau Document contenant uniquement ces pages. Document.Append() et Document.InsertPage() copient des pages entre documents, et Document.Merge() combine plusieurs documents en un seul.

const parts = doc.Split();                       // one Document per page
const chapter = doc.ExtractPages([3, 4, 5]);     // subset (1-based, repeats allowed) as a new Document

docA.Append(docB);                               // copy all of docB's pages onto docA
docA.InsertPage(1, docB.Pages[0]);               // copy a single page across documents

Création d’un nouveau document

Document.New() démarre un document vierge à un PageFormat donné. Page.AddText() place du texte positionné, et Document.AddPage() ajoute d’autres pages, y compris un format tourné comme PageFormat.A4.landscape().

import { Document, PageFormat } from '@asposefoss/pdf';
const doc = Document.New(PageFormat.A4);          // one blank A4 page
doc.Pages[0].AddText('Hello', 72, 720, { fontSize: 14 });
doc.AddPage(PageFormat.A4.landscape());           // append more as you go
doc.WriteTo('scratch.pdf');

Filigranes et numéros de page

Page.AddText() prend également en charge la rotation, la couleur et l’opacité, ce qui suffit pour rendre un numéro de page et un filigrane diagonal sans classes supplémentaires.

const doc = Document.OpenFile('in.pdf');
const page = doc.Pages[0];

// Page number, right-aligned near the bottom-right corner.
const w = page.Rect[2] - page.Rect[0];
page.AddText(`Page ${page.Number}`, w - 40, 20, { fontSize: 10, align: 'right' });

// Semi-transparent diagonal watermark, centered on the page.
page.AddText('DRAFT', page.Rect[2] / 2, page.Rect[3] / 2, {
  font: 'Times-Bold', fontSize: 64, color: [0.7, 0.7, 0.7], opacity: 0.4, rotate: 45, align: 'center',
});

doc.WriteTo('out.pdf');

Introspection du flux de contenu

parseContentStream() décode le flux brut /Contents d’une page en une liste de paires opérateur/opérande, et serializeContentStream() convertit une liste d’opérateurs modifiée en octets.

import { parseContentStream, serializeContentStream } from '@asposefoss/pdf';

const ops = parseContentStream(doc.Pages[0].Contents);
// ops: { operator: string, operands: PdfObject[], inlineImage?: {...} }[]
for (const op of ops) {
  if (op.operator === 'Tj') console.log('text op:', op.operands);
}
const bytes = serializeContentStream(ops);       // round-trips operators + operands

Flux de texte multicolonnes

Page.AddTextBlock() fait couler une longue chaîne de texte dans une région rectangulaire et renvoie tout texte qui n’a pas pu tenir, lequel peut être utilisé dans un second appel pour poursuivre le flux dans une autre colonne.

const rest = page.AddTextBlock(longText, [72, 600, 200, 150], {
  font: 'Times-Roman', fontSize: 11, align: 'justify', valign: 'top', leading: 14,
});
if (rest) page.AddTextBlock(rest, [300, 600, 200, 150]); // continue into a 2nd column

Conseils et bonnes pratiques

  • Utilisez Document.OpenFile() pour les chemins de fichiers et Document.Open() pour les données Uint8Array en mémoire.
  • Les numéros de page transmis aux méthodes comme RemovePage() et ExtractPages() sont basés sur 1, tandis que doc.Pages est un tableau basé sur 0.
  • Passez { compressed: true } à Document.WriteTo() pour activer la compression xref-stream et object-stream sur la sortie.
  • Document.ExtractPages() accepte des numéros de page répétés, de sorte que la même page source peut apparaître plusieurs fois dans le résultat.
  • Lisez page.Rect pour calculer les positions relatives à la largeur et à la hauteur réelles de la page plutôt que de coder en dur les coordonnées.

Problèmes courants

ProblèmeCauseCorrection
Document.Open() / OpenFile() lance InvalidPasswordErrorLe PDF est protégé par mot de passe et aucun mot de passe (ou le mauvais) n’a été fourniPasse { password: '...' } à Document.OpenFile() / Document.Open()
RemovePage() supprime la mauvaise pageLes numéros de page passés à RemovePage() sont basés sur 1, pas sur 0Passez un numéro de page à base 1, distinct de l’indexation du tableau doc.Pages
La sortie de WriteTo() est plus grande que prévuL’enregistrement par défaut n’utilise pas la compression xref/object-streamPassez { compressed: true } à Document.WriteTo()

FAQ

Document.Open() accepte-t-il à la fois les chemins de fichiers et les données en mémoire?

Document.OpenFile() s’ouvre à partir d’un chemin de fichier; Document.Open() accepte un Uint8Array d’octets en mémoire.

La numérotation des pages est-elle basée sur 0 ou sur 1?

Les deux, selon le API: doc.Pages est un tableau simple à indice 0, mais les méthodes telles que RemovePage() et ExtractPages() utilisent des numéros de page à indice 1.

Puis-je chiffrer un document lors de son enregistrement?

Oui — passez une option encrypt à WriteTo() / Save() avec algorithm: 'aes256' | 'aes128' | 'rc4' et les mots de passe utilisateur/propriétaire facultatifs.

Comment réduire la taille du fichier de sortie?

Passez { compressed: true } à Document.WriteTo() pour activer la compression des flux xref et des flux d’objets.

Puis-je examiner les opérateurs bruts du flux de contenu d’une page?

Oui — parseContentStream(doc.Pages[0].Contents) renvoie la liste des opérateurs, et serializeContentStream() convertit une liste modifiée en octets.


API Reference Résumé

Classe / MéthodeDescription
DocumentPoint d’entrée central pour créer, charger et enregistrer des documents PDF
Document.OpenFile() / Document.Open()Charger un PDF à partir d’un chemin de fichier ou d’octets en mémoire
Document.New()Créer un document vierge avec un PageFormat donné
Document.WriteTo() / Document.Save()Écrire le document dans un chemin de fichier ou retourner des octets
Document.Split() / Document.Merge() / Document.ExtractPages()Diviser, fusionner et extraire des pages entre documents
Document.Append() / Document.InsertPage()Copier des pages d’un document dans un autre
PageUne seule page PDF ; expose les méthodes texte, image, annotation et content-stream
Page.AddText() / Page.AddTextBlock()Ajouter du texte positionné ou en flux à une page
parseContentStream() / serializeContentStream()Analyser et re-sérialiser les opérateurs bruts du content-stream d’une page

Voir aussi

 Français