Function: pdf-info-pagelinks

pdf-info-pagelinks is a natively compiled function defined in pdf-info.el.

Signature

(pdf-info-pagelinks PAGE &optional FILE-OR-BUFFER)

Documentation

Return a list of links on PAGE in document FILE-OR-BUFFER.

This function returns a list of alists with the following keys. EDGES represents the relative bounding-box of the link , TYPE is the type of the action, TITLE is a, possibly empty, name for this action.

TYPE may be one of

goto-dest -- This is a internal link to some page. Each element contains additional keys PAGE and TOP, where PAGE is the page of the link and TOP its vertical position.

goto-remote -- This a external link to some document. Same as goto-dest, with an additional FILENAME of the external PDF.

uri -- A link in form of some URI. Alist contains additional key URI.

In the first two cases, PAGE may be 0 and TOP nil, which means these data is unspecified.

Source Code

;; Defined in /nix/store/63h5z2vmzn0mfavcxi2idi23g5xcgkbl-emacs-packages-deps/share/emacs/site-lisp/elpa/pdf-tools-20260102.1101/pdf-info.el
(defun pdf-info-pagelinks (page &optional file-or-buffer)
  "Return a list of links on PAGE in document FILE-OR-BUFFER.

This function returns a list of alists with the following keys.
EDGES represents the relative bounding-box of the link , TYPE is
the type of the action, TITLE is a, possibly empty, name for this
action.

TYPE may be one of

goto-dest -- This is a internal link to some page.  Each element
contains additional keys PAGE and TOP, where PAGE is the page of
the link and TOP its vertical position.

goto-remote -- This a external link to some document.  Same as
goto-dest, with an additional FILENAME of the external PDF.

uri -- A link in form of some URI. Alist contains additional key
URI.

In the first two cases, PAGE may be 0 and TOP nil, which means
these data is unspecified."
  (cl-check-type page natnum)
  (pdf-info-query
   'pagelinks
   (pdf-info--normalize-file-or-buffer file-or-buffer)
   page))