Annotations
Anmärkningar
Den här sidan täcker att skapa, läsa, söka och platta till PDF-anmärkningar. Page exponerar en Add*() metod per anmärkingssubtyp, var och en returnerar ett levande Annotation handtag; basklassen Annotation och dess subtyper (TextAnnotation, StampAnnotation, MarkupAnnotation och andra) exponerar anmärkningens egenskaper för läsning och redigering.
Skapa markup-, antecknings- och länkanmärkningar
De fyra text-markup-metoderna — Page.AddHighlight(), Page.AddUnderline(), Page.AddSquiggly() och Page.AddStrikeOut() — tar en quads-array (/QuadPoints) och returnerar en MarkupAnnotation. Page.AddLink() skapar ett klickbart område med en URI eller intern åtgärd, och Page.AddTextNote() lägger till en klistermärkesikon som öppnar en popup med contents-text, och returnerar en 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 exponerar också form- och frihandsmetoder — AddSquare(), AddCircle(), AddLine(), AddPolygon(), AddPolyline(), AddInk(), AddFreeText(), AddCaret() och AddStamp() — var och en returnerar det motsvarande anmärkingshandtaget för den subtypen, och genererar dess /AP-utseende automatiskt.
Läsa och lista anmärkningar
page.Annotations är en array av varje Annotation på sidan. Varje anmärkning, oavsett subtyp, exponerar Subtype, Rect, Color, Contents, Name, Layer, ModDate, Flags, Print, Hidden och Opacity; subtyper lägger till sina egna fält, såsom StampAnnotation.StampName eller MarkupAnnotation.QuadPoints.
const freeText = page.Annotations.find((a) => a.Subtype === 'FreeText');
if (freeText) {
freeText.Contents = 'Updated note text';
}Sökning av annoteringstext
Page.SearchAnnotationText() and Page.SearchAnnotations() är avsiktligt fristående. SearchAnnotationText() hittar matchningar i texten en annotation carries snarare än ritar — en nots /Contents, dess författare (/T), eller dess ämne (/Subj) — och returnerar AnnotationTextMatch[] ({ annot, key, value, text }). SearchAnnotations() hittar matchningar i texten en annotation draws, såsom en FreeText’s synliga ord, och returnerar 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');Platta till annoteringar
Annotation.Flatten() inbäddar en annoterings /AP utseende direkt i sidans innehållsström vid dess /Rect, och tar sedan bort den från /Annots. Resultatet blir permanent, statiskt innehåll — inte längre en separat annotering som en betraktare kan klicka på, redigera eller dölja.
const note = page.AddTextNote({
rect: [72, 660, 92, 680], icon: 'Comment', contents: 'Reviewed and approved.',
});
note.Flatten();Tips och bästa praxis
- Anropa
Flatten()på det objekt som returneras direkt avAdd*()-anropet — en annotering som hämtas genom att läsa ompage.Annotationsi efterhand är en annan objektreferens. SearchAnnotationText()ochSearchAnnotations()täcker olika text: kör båda om du behöver hitta en fras oavsett om den skrevs in i en notering eller ritades på sidan.- De fyra markup-metoderna (
AddHighlight,AddUnderline,AddSquiggly,AddStrikeOut) genererar deras/APutseende automatiskt — ingen manuell innehållsströmritning krävs. - Kryptering överlever en rundresa: annotationer som lagts till före
Document.Save()med ettencrypt-alternativ förblir giltiga efter att dokumentet har öppnats igen och dekrypterats.
Vanliga problem
| Problem | Orsak | Lösning |
|---|---|---|
page.Annotations.find() returnerar undefined för en annotation du just lagt till | Söker i en föråldrad array som fångades innan annoteringen lades till | Läs om page.Annotations efter Add*()-anropet, eller använd handtaget som anropet returnerade direkt |
SearchAnnotationText() hittar inget för text som är synlig på sidan | Texten ritas av annoteringen (t.ex. en FreeTexts kropp), inte bärs i /Contents | Använd SearchAnnotations() istället — det matchar den ritade texten |
Annoteringen visas fortfarande redigerbar efter Flatten() | Flatten() anropades på en kopia snarare än på handtaget Add*() returnerade | Anropa Flatten() på det objekt som returneras direkt av skapandemetoden |
FAQ
Vad är skillnaden mellan SearchAnnotationText och SearchAnnotations?
SearchAnnotationText() matchar text en annotering carries — /Contents, /T (författare), eller /Subj — såsom en klisterlapps kropp. SearchAnnotations() matchar text en annotation draws på sidan, till exempel en FreeText’s synliga ord. De två är disjunkta: en matchning i den ena kommer inte att visas i den andra.
Hur gör jag en annotation permanent och icke-interaktiv?
Anropa Flatten() på Annotation-handtaget som returneras av Add*()-metoden som skapade den. Detta inbakar dess utseende i sidans innehållsström och tar bort den från /Annots.
Vilka annotation-subtyper stöds?
Page exponerar skapandemetoder för textmarkering (AddHighlight, AddUnderline, AddSquiggly, AddStrikeOut), anteckningar och anmärkningar (AddTextNote, AddFreeText, AddCaret), länkar (AddLink), former (AddSquare, AddCircle, AddLine, AddPolygon, AddPolyline), frihandsbläck (AddInk), stämplar (AddStamp), och filbilagor (AddFileAttachment).
Hur listar jag alla annotationer som redan finns på en sida?
Läs page.Annotations, en array av Annotation handtag. Varje exponerar Subtype, Rect, Color, Contents, och de andra gemensamma egenskaperna, så att du kan filtrera eller inspektera dem med standardarraymetoder.
API Reference Sammanfattning
| Klass/Metod | Beskrivning |
|---|---|
Annotation | Bas hanterar alla annotationer; exponerar Subtype, Rect, Color, Contents, Name, Flags, Print, Hidden, Opacity |
Annotation.Flatten() | Baka annotationens utseende i statiskt sidinnehåll |
TextAnnotation | En /Text klisterlapp-handtag; lägger till Icon, Open, Author |
StampAnnotation | Ett /Stamp gummistämpel-handtag; lägger till StampName |
MarkupAnnotation | Ett textformaterings-handtag (Highlight/Underline/StrikeOut/Squiggly); lägger till MarkupType, QuadPoints |
Page.AddHighlight() / Page.AddUnderline() / Page.AddStrikeOut() / Page.AddSquiggly() | Skapa en textformaterings-annotation över /QuadPoints |
Page.AddTextNote() | Skapa en klisterlappsanteckning |
Page.AddLink() | Skapa en klickbar länk med en URI eller intern åtgärd |
Page.Annotations | Varje Annotation på sidan, som en array |
Page.SearchAnnotationText() | Hitta text som en annotation bär (/Contents, /T, /Subj) |
Page.SearchAnnotations() | Hitta text som en annotation ritar på sidan |