Annotations
Anotace
Tato stránka se zabývá vytvářením, čtením, vyhledáváním a zplošťováním PDF anotací. Page poskytuje jednu Add*() metodu pro každý podtyp anotace, každá vrací živý Annotation handle; bázová třída Annotation a její podtypy (TextAnnotation, StampAnnotation, MarkupAnnotation a další) zpřístupňují vlastnosti anotace pro čtení a úpravy.
Vytváření značkovacích, poznámkových a odkazových anotací
Čtyři metody pro textové značkování — Page.AddHighlight(), Page.AddUnderline(), Page.AddSquiggly() a Page.AddStrikeOut() — přijímají pole quads (/QuadPoints) a vrací MarkupAnnotation. Page.AddLink() vytváří klikací oblast s URI nebo vnitřní akcí a Page.AddTextNote() přidává ikonu lepicí poznámky, která otevírá vyskakovací okno s contents textem, vracející TextAnnotation.
page.AddHighlight({ quads, color: [1, 1, 0], contents: 'Yellow highlight' });
page.AddUnderline({ quads, color: [0, 0, 1] });
page.AddStrikeOut({ quads, color: [1, 0, 0] });
page.AddLink({
rect: [100, 700, 220, 716],
action: { type: 'uri', uri: 'https://example.com' },
border: 0,
});
page.AddTextNote({
rect: [x, y, x + 20, y + 20], icon: 'Note', author: 'Reviewer',
contents: 'This is a sticky-note annotation.',
});Page také poskytuje metody pro tvary a volnou ruku — AddSquare(), AddCircle(), AddLine(), AddPolygon(), AddPolyline(), AddInk(), AddFreeText(), AddCaret() a AddStamp() — každá vrací odpovídající handle anotace pro daný podtyp a automaticky generuje její /AP vzhled.
Čtení a výpis anotací
page.Annotations je pole všech Annotation na stránce. Každá anotace, bez ohledu na podtyp, zpřístupňuje Subtype, Rect, Color, Contents, Name, Layer, ModDate, Flags, Print, Hidden a Opacity; podtypy přidávají své vlastní pole, například StampAnnotation.StampName nebo MarkupAnnotation.QuadPoints.
const freeText = page.Annotations.find((a) => a.Subtype === 'FreeText');
if (freeText) {
freeText.Contents = 'Updated note text';
}Hledání textu anotace
Page.SearchAnnotationText() and Page.SearchAnnotations() jsou úmyslně oddělené. SearchAnnotationText() najde shody v textu anotaci carries spíše než kreslí — poznámky /Contents, její autor (/T), nebo její předmět (/Subj) — a vrací AnnotationTextMatch[] ({ annot, key, value, text }). SearchAnnotations() najde shody v textu anotaci draws, například a FreeText’s viditelná slova a vrací AnnotationMatch[] ({ annot, text, quads }).
// A sticky note's /Contents text — found by SearchAnnotationText, not SearchAnnotations.
const textHits = page.SearchAnnotationText('body secret');
console.log(textHits[0].key, textHits[0].value); // 'Contents' 'body secret'
// A FreeText's rendered words — found by SearchAnnotations, not SearchAnnotationText.
const drawnHits = page.SearchAnnotations('bravo');Zploštění anotací
Annotation.Flatten() zapéká vzhled /AP anotace přímo do content streamu stránky na jeho /Rect, pak ho odstraní z /Annots. Výsledek je trvalý, statický obsah — již to není samostatná anotace, kterou by divák mohl kliknout, upravit nebo skrýt.
const note = page.AddTextNote({
rect: [72, 660, 92, 680], icon: 'Comment', contents: 'Reviewed and approved.',
});
note.Flatten();Tipy a osvědčené postupy
- Zavolejte
Flatten()na objekt, který je vrácen přímo volánímAdd*()— anotace získaná opětovným načtenímpage.Annotationspozději je jiný odkaz na objekt. SearchAnnotationText()aSearchAnnotations()pokrývají odlišný text: spusťte oba, pokud potřebujete najít frázi bez ohledu na to, zda byla napsána do poznámky nebo nakreslena na stránce.- Čtyři metody značkování (
AddHighlight,AddUnderline,AddSquiggly,AddStrikeOut) generují jejich/APvzhled automaticky — není vyžadováno ruční kreslení v content streamu. - Šifrování přežije celý cyklus: anotace přidané před
Document.Save()s volbouencryptzůstávají platné po opětovném otevření a dešifrování dokumentu.
Časté problémy
| Problém | Příčina | Oprava |
|---|---|---|
page.Annotations.find() vrací undefined pro anotaci, kterou jste právě přidali | Vyhledávání zastaralého pole zachyceného před přidáním anotace | Přečtěte page.Annotations znovu po volání Add*(), nebo použijte přímo identifikátor, který volání vrátilo |
SearchAnnotationText() nenajde nic pro text viditelný na stránce | Text je vytvořen anotací (např. tělo FreeText), nikoli přenášen v /Contents | Použijte SearchAnnotations() místo toho — odpovídá vykreslenému textu |
Anotace se stále zobrazuje jako editovatelná po Flatten() | Flatten() byl zavolán na kopii místo rukojeti, kterou vrátil Add*() | Zavolejte Flatten() na objektu vráceném přímo metodou vytvářející |
FAQ
Jaký je rozdíl mezi SearchAnnotationText a SearchAnnotations?
SearchAnnotationText() odpovídá textu anotace carries — /Contents, /T (autor), nebo /Subj — například tělo lepicí poznámky. SearchAnnotations() odpovídá textu anotace draws na stránce, například FreeText’s viditelná slova. Tyto dva jsou disjunktní: shoda v jednom se v druhém neobjeví.
Jak mohu učinit anotaci trvalou a neinteraktivní?
Zavolejte Flatten() na objekt Annotation, který vrací metoda Add*() vytvořila. Tím se vzhled zakomponuje do obsahového proudu stránky a odstraní se z /Annots.
Které podtypy anotací jsou podporovány?
Page poskytuje metody pro vytváření textových značek (AddHighlight, AddUnderline, AddSquiggly, AddStrikeOut), poznámek a výzvů (AddTextNote, AddFreeText, AddCaret), odkazů (AddLink), tvarů (AddSquare, AddCircle, AddLine, AddPolygon, AddPolyline), volného kreslení inkoustem (AddInk), razítek (AddStamp) a příloh souborů (AddFileAttachment).
Jak mohu vypsat všechny anotace, které jsou již na stránce?
Přečtěte page.Annotations, pole Annotation manipulátorů. Každý z nich poskytuje Subtype, Rect, Color, Contents a další sdílené vlastnosti, takže je můžete filtrovat nebo prozkoumávat pomocí standardních metod pole.
API Reference Shrnutí
| Třída/Metoda | Popis: |
|---|---|
Annotation | Základní obsluha nad libovolnou anotací; vystavuje Subtype, Rect, Color, Contents, Name, Flags, Print, Hidden, Opacity |
Annotation.Flatten() | Zapracujte vzhled anotace do statického obsahu stránky |
TextAnnotation | A /Text sticky-note handle; přidává Icon, Open, Author |
StampAnnotation | Rukojeť /Stamp gumového razítka; přidává StampName |
MarkupAnnotation | Rukojeť pro textové značkování (Highlight/Underline/StrikeOut/Squiggly); přidává MarkupType, QuadPoints |
Page.AddHighlight() / Page.AddUnderline() / Page.AddStrikeOut() / Page.AddSquiggly() | Vytvořte anotaci textového značkování nad /QuadPoints |
Page.AddTextNote() | Vytvořte anotaci lepicí poznámky |
Page.AddLink() | Vytvořte klikací odkaz s URI nebo interní akcí |
Page.Annotations | Každý Annotation na stránce, jako pole |
Page.SearchAnnotationText() | Najděte text, který anotace nese (/Contents, /T, /Subj) |
Page.SearchAnnotations() | Najděte text, který anotace vykresluje na stránce |