Skip to contents

Hit-test for a link annotation, returning its annotation index

Source: R/annot_probes.R
pdf_link_annot_at_point.Rd

Companion to pdf_link_at_point() (which surfaces the link's action / destination / URI) — this one returns the page-scoped annotation index of the underlying link annotation so the caller can hand it to pdf_annot_dict_value() / pdf_annot_appearance() / pdf_annotations() for the full structural readout. Wraps FPDFLink_GetLinkAtPoint + FPDFLink_GetAnnot.

Usage

pdf_link_annot_at_point(page, x, y, page_num = 1L)

Arguments

page

A pdfium_page from pdf_page_load(), or a pdfium_doc (the page given by page_num will be loaded and closed internally).

x, y

Point coordinates in PDF user-space points.

page_num

One-based page index. Only used when page is a pdfium_doc. Ignored otherwise.

Value

A list with three fields:

  • found (logical) — TRUE when a link is under the point.

  • annotation_index (integer) — 1-based same-page annotation index of the underlying link annotation; NA when no link is found.

  • z_order (integer) — the link's Z-order on the page; NA when no link is found.

See also

pdf_link_at_point(), pdf_annotations().