Úvod

Úvodní příspěvek stručně popisuje anotace: zvýraznění, podtržení, lepící poznámky a razítka, přidaná pomocí Page.AddHighlight(), Page.AddUnderline() a podobných metod. To je jen malý výsek toho, co Page skutečně podporuje — galerie anotací v této knihovně zahrnuje značkování, volné tvary, odkazy s reálnou navigací a akcemi odeslání formuláře a vyhledávání, vše dostupné přímo z Page.

Tento příspěvek prochází zbytek této oblasti: metody tvarových a volných anotací, co může akce anotace Link skutečně provést, a dva různé způsoby vyhledávání obsahu anotace v závislosti na tom, zda hledaný text je součástí vzhledu anotace nebo jejího /Contents komentáře.

Každá metoda anotace vrací typově definovaný handle vázaný na právě vytvořenou anotaci a každou anotaci na stránce lze následně číst pomocí page.Annotations.

Co je zahrnuto

Markup anotace

Page.AddHighlight(), Page.AddUnderline(), Page.AddSquiggly() a Page.AddStrikeOut() všechny přijímají stejný tvar možností — sadu čtyřúhelníkových bodů označujících oblast textu a volitelnou barvu — a všechny čtyři vrací MarkupAnnotation. Čtyřúhelníkové body jsou typicky odvozeny z vyhledávání textu nebo ze známého textového obdélníku.

const markup = (body: [number, number, number, number], sample: string,
  add: (quads: number[]) => void): void => {
  const yMid = (body[1] + body[3]) / 2 - 6;
  const textRect: [number, number, number, number] = [body[0] + 4, yMid, body[2] - 4, yMid + 16];
  page.AddText(sample, textRect[0], textRect[1], { fontSize: 12 });
  add(rectToQuads(textRect));
};

markup(cardBody, 'Highlight this phrase', (quads) =>
  page.AddHighlight({ quads, color: [1, 1, 0], contents: 'Yellow highlight' }));
markup(cardBody, 'Underline this phrase', (quads) =>
  page.AddUnderline({ quads, color: [0, 0, 1] }));
markup(cardBody, 'Squiggle this phrase', (quads) =>
  page.AddSquiggly({ quads, color: [1, 0.5, 0] }));
markup(cardBody, 'Strike this phrase out', (quads) =>
  page.AddStrikeOut({ quads, color: [1, 0, 0] }));

Poznámky a samostatný text

Page.AddTextNote() přidává klasickou ikonu poznámky typu sticky-note, která po kliknutí otevře vyskakovací okno s komentářem a vrací TextAnnotation. Page.AddFreeText() místo toho vykresluje svůj text přímo na stránce uvnitř ohraničené krabice, s vlastní velikostí písma, zarovnáním a barvou výplně — užitečné pro upozornění, která mají být viditelná bez otevírání čehokoliv.

page.AddTextNote({
  rect: [x, y, x + 20, y + 20], icon: 'Note', author: 'Reviewer',
  contents: 'This is a sticky-note annotation.',
});

page.AddFreeText({
  rect: [220, 60, 520, 96],
  contents: 'FreeText sample', fontSize: 10, align: 'center',
  fill: [1, 1, 0.8], width: 1,
});

Tvary a volná kresba

Page.AddSquare() a Page.AddCircle() kreslí ohraničený obdélník nebo elipsu, každou s volitelnou výplní uvnitř. Page.AddLine() kreslí přímou čáru mezi dvěma body, s nezávisle volitelnými styly šipek (startEnding/endEnding, např. 'OpenArrow'/'ClosedArrow') na každém konci. Page.AddPolygon() a Page.AddPolyline() kreslí uzavřené a otevřené vícebodové tvary ze seznamu souřadnic, a Page.AddInk() zaznamenává jeden nebo více volných tahů pera jako paths seznamů bodů.

page.AddSquare({ rect: [50, 400, 130, 435], color: [0.8, 0, 0], fill: [1, 1, 0.5], width: 2 });
page.AddCircle({ rect: [150, 400, 230, 435], color: [0, 0.5, 0], width: 2 });

page.AddLine({
  line: [260, 417, 420, 417],
  color: [0, 0, 0.7], width: 2,
  startEnding: 'OpenArrow', endEnding: 'ClosedArrow',
});

const stroke: number[] = [];
[-8, 6, -4, 10, -2, 8, -6].forEach((dy, i) => stroke.push(440 + i * 12, 417 + dy));
page.AddInk({ paths: [stroke], color: [0.6, 0, 0.6], width: 2 });

Odkazy a jejich akce

Page.AddLink() vrací LinkAnnotation, jehož action rozhoduje, co se stane po kliknutí: { type: 'uri', uri: '...' } otevře externí URL, { type: 'goto', page: N } přejde na stránku ve stejném dokumentu a { type: 'submit', url: '...', format: 'html' } odešle aktuální hodnoty polí formuláře na koncový bod. Číslo stránky goto mimo rozsah nebo špatně formátovaný akční objekt je při vytváření odmítnut místo tichého přijetí.

const uriLink = page.AddLink({
  rect: [10, 10, 100, 30], action: { type: 'uri', uri: 'https://example.com' },
});

const gotoLink = page.AddLink({
  rect: [10, 40, 100, 60], action: { type: 'goto', page: 2 },
});

const submitLink = page.AddLink({
  rect: [10, 70, 100, 90],
  action: { type: 'submit', url: 'https://example.com/post', format: 'html' },
});

// page.AddLink({ rect: [...], action: { type: 'goto', page: 99 } }) throws RangeError
// when 99 is out of range for the document.

Prohledávání obsahu anotací

Dvě různé metody prohledávají text anotace a jsou úmyslně nesouvislé: Page.SearchAnnotations() prohledává text, který je vlastní vzhled anotace vytahuje — viditelný štítek na FreeText nebo razítku, například — zatímco Page.SearchAnnotationText() prohledává text, který je v anotaci /Contents záznamu, například v těle komentáře lepicí poznámky. Shoda v jednom neznamená shodu v druhém.

page.SearchAnnotations('bravo');          // finds it if the annotation's drawn appearance contains it
page.SearchAnnotationText('bravo');       // finds it if the annotation's /Contents comment contains it

Anotace, které již nejsou potřeba, lze odstranit přímo pomocí Page.RemoveAnnotation(), přičemž se předá buď odkaz na anotaci, nebo její podkladový slovník.

Rychlý start

Nainstalujte balíček a poté přidejte zvýraznění, odkaz a lepkavou poznámku na existující stránku:

git clone https://github.com/aspose-pdf-foss/Aspose.PDF-FOSS-for-TypeScript.git
cd Aspose.PDF-FOSS-for-TypeScript
npm install
npm run build
import { Document } from '@asposefoss/pdf';

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

page.AddHighlight({ quads: [72, 700, 300, 700, 72, 715, 300, 715], color: [1, 1, 0] });

page.AddLink({
  rect: [72, 670, 200, 690], action: { type: 'uri', uri: 'https://example.com' },
});

page.AddTextNote({
  rect: [320, 670, 340, 690], icon: 'Note', author: 'Reviewer',
  contents: 'Please double-check this figure.',
});

doc.WriteTo('annotated.pdf');

Podporované formáty

FormátRozšířeníČístZapsat
PDFpdf✓✓
Markdownmd✓✓
SVGsvg✓✓
TIFFtiff✓✓
DOCXdocx—✓
HTMLhtml—✓
PNGpng—✓
EPUBepub—✓

Open source & licence

Aspose.PDF FOSS pro TypeScript je vydán pod licencí MIT, se zdrojovým kódem publikovaným na GitHub. Neexistuje žádný zkušební vodoznak, omezení používání ani samostatný licenční soubor k správě a knihovna může být používána v komerčních produktech bez licenčních poplatků.

Balíček je aktuálně ve verzi 0.1.0, což odráží aktivní vývoj v rané fázi. Node.js (>=22) je jediným požadavkem na runtime a balíček nemá žádné další externí závislosti.

Začínáme

Související zdroje