Annotations
Annotációk
Ez az oldal a PDF-annotációk létrehozását, olvasását, keresését és laposítását tárgyalja. Page egy Add*() metódust tesz közzé annotáció al-típusonként, mindegyik egy élő Annotation kezelőt ad vissza; a Annotation alaposztály és annak altípusai (TextAnnotation, StampAnnotation, MarkupAnnotation, és mások) elérhetővé teszik az annotáció tulajdonságait olvasásra és szerkesztésre.
Markup, Jegyzet és Link Annotációk Létrehozása
A négy szöveg-jelölő módszer — Page.AddHighlight(), Page.AddUnderline(), Page.AddSquiggly() és Page.AddStrikeOut() — egy quads tömböt (/QuadPoints) vesz fel, és egy MarkupAnnotation-ot ad vissza. Page.AddLink() létrehoz egy kattintható területet egy URI-val vagy belső művelettel, és Page.AddTextNote() egy ragadós jegyzet ikont ad hozzá, amely egy felugró ablakot nyit meg contents szöveggel, és egy TextAnnotation-t ad vissza.
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 továbbá elérhetővé teszi a forma és szabadkézi módszereket — AddSquare(), AddCircle(), AddLine(), AddPolygon(), AddPolyline(), AddInk(), AddFreeText(), AddCaret() és AddStamp() — mindegyik a megfelelő annotáció kezelőt adja vissza az adott altípushoz, automatikusan előállítva a /AP megjelenését.
Annotációk Olvasása és Listázása
page.Annotations egy tömb, amely minden Annotation-t tartalmaz az oldalon. Minden annotáció, altípusától függetlenül, elérhetővé teszi a Subtype, Rect, Color, Contents, Name, Layer, ModDate, Flags, Print, Hidden és Opacity mezőket; az altípusok saját mezőket adnak hozzá, például StampAnnotation.StampName vagy MarkupAnnotation.QuadPoints.
const freeText = page.Annotations.find((a) => a.Subtype === 'FreeText');
if (freeText) {
freeText.Contents = 'Updated note text';
}Megjegyzés szöveg keresése
Page.SearchAnnotationText() and Page.SearchAnnotations() szándékosan szétválasztottak. SearchAnnotationText() keres egyezéseket a szövegben egy annotáció carries ahelyett, hogy rajzolna — egy jegyzet /Contents, annak szerzője (/T), vagy annak tárgya (/Subj) — és visszaad AnnotationTextMatch[] ({ annot, key, value, text }). SearchAnnotations() keres egyezéseket a szövegben egy annotáció draws, például egy FreeText’s látható szavakat, és visszaadja 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');Megjegyzések laposítása
Annotation.Flatten() közvetlenül a lap tartalomfolyamába /Rect helyen beégeti egy megjegyzés /AP megjelenését, majd eltávolítja azt a /Annots-ból. Az eredmény állandó, statikus tartalom — már nem egy különálló megjegyzés, amelyre a néző kattinthat, szerkeszthet vagy elrejthet.
const note = page.AddTextNote({
rect: [72, 660, 92, 680], icon: 'Comment', contents: 'Reviewed and approved.',
});
note.Flatten();Tippek és bevált gyakorlatok
- Hívja a
Flatten()függvényt azon az objektumon, amelyet közvetlenül aAdd*()hívás ad vissza — egy megjegyzés, amelyet később apage.Annotationsújraolvasásával kap, más objektumreferencia. SearchAnnotationText()ésSearchAnnotations()különböző szöveget fed le: futtassa mindkettőt, ha egy kifejezést kell megtalálni függetlenül attól, hogy egy jegyzetbe gépelték vagy a lapon rajzolták.- A négy jelölő módszer (
AddHighlight,AddUnderline,AddSquiggly,AddStrikeOut) automatikusan előállítja a/APmegjelenését — manuális tartalomfolyam-rajzolás nem szükséges. - A titkosítás túlél egy körutat: a
Document.Save()előtt hozzáadott annotációk egyencryptbeállítással érvényesek maradnak, miután a dokumentumot újra megnyitják és visszafejtik.
Gyakori problémák
| Probléma | Oka | Javítás |
|---|---|---|
page.Annotations.find() visszaad undefined egy frissen hozzáadott annotációhoz | Elavult tömb keresése, amelyet az annotáció hozzáadása előtt rögzítettek | Olvasd be újra a page.Annotations értéket a Add*() hívás után, vagy használd közvetlenül a hívás által visszaadott kezelőt |
SearchAnnotationText() semmit sem talál a lapon látható szövegre | A szöveget az annotáció rajzolja (pl. egy FreeText testje), nem /Contents-ben tárolódik. | Használd helyette a SearchAnnotations()-t — ez egyezik a rajzolt szöveggel. |
Az annotáció továbbra is szerkeszthetőnek jelenik meg Flatten() után. | A Flatten() egy másolaton lett meghívva, nem pedig a Add*() által visszaadott kezelőn. | Hívd meg a Flatten()-t a létrehozó metódus által közvetlenül visszaadott objektumon. |
FAQ
Mi a különbség a SearchAnnotationText és a SearchAnnotations között?
SearchAnnotationText() egyezik egy annotáció szövegével carries — /Contents, /T (szerző), vagy /Subj — például egy ragadós jegyzet testje. SearchAnnotations() illeszti a szöveget egy annotációval draws az oldalon, például egy FreeText’s látható szavak. A kettő diszjunkt: egy egyezés az egyikben nem jelenik meg a másikban.
Hogyan tehetem az annotációt állandóvá és nem interaktívvá?
Hívja meg a Flatten() függvényt a Add*() metódus által visszaadott Annotation kezelőn. Ez beágyazza a megjelenését az oldal tartalomfolyamába, és eltávolítja a /Annots-ből.
Mely annotáció altípusok támogatottak?
Page kínál létrehozási módszereket a szövegjelöléshez (AddHighlight, AddUnderline, AddSquiggly, AddStrikeOut), jegyzetekhez és felhívásokhoz (AddTextNote, AddFreeText, AddCaret), linkekhez (AddLink), alakzatokhoz (AddSquare, AddCircle, AddLine, AddPolygon, AddPolyline), szabadkézi tintához (AddInk), bélyegekhez (AddStamp), és fájlmellékletekhez (AddFileAttachment).
Hogyan listázhatom az oldalon már meglévő összes annotációt?
Olvassa el a(z) page.Annotations-t, egy Annotation kezelők tömbjét. Minden egyes elem a(z) Subtype, Rect, Color, Contents és a többi közös tulajdonságot kínálja, így szűrheti vagy vizsgálhatja őket a szokásos tömbmetódusokkal.
API Reference összefoglaló
| Osztály/Módszer | Leírás |
|---|---|
Annotation | Alap kezelő bármely annotációhoz; elérhetővé teszi a(z) Subtype, Rect, Color, Contents, Name, Flags, Print, Hidden, Opacity |
Annotation.Flatten() | Beágyazza az annotáció megjelenését a statikus oldal tartalmába |
TextAnnotation | A /Text ragadós jegyzet kezelő; hozzáadja a Icon, Open, Author |
StampAnnotation | A /Stamp guminyomat kezelő; hozzáadja a StampName |
MarkupAnnotation | Egy szövegformázó kezelő (Highlight/Underline/StrikeOut/Squiggly); hozzáadja a MarkupType, QuadPoints |
Page.AddHighlight() / Page.AddUnderline() / Page.AddStrikeOut() / Page.AddSquiggly() | Hozzon létre egy szövegformázó annotációt a /QuadPoints felett |
Page.AddTextNote() | Ragadós cetli annotáció létrehozása |
Page.AddLink() | Kattintható hivatkozás létrehozása URI-val vagy belső művelettel |
Page.Annotations | Minden Annotation az oldalon, tömbként |
Page.SearchAnnotationText() | Keresse meg a szöveget, amelyet egy annotáció tartalmaz (/Contents, /T, /Subj) |
Page.SearchAnnotations() | Keresse meg a szöveget, amelyet egy annotáció a lapon rajzol |