Skip to content

Document the parameter list each destination type takes #1785

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
blikblum merged 1 commit into from
Aug 28, 2026
Merged

Document the parameter list each destination type takes #1785

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/destinations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,29 @@ Examples of creating anchor:
// Insert anchor for this text
doc.text('End of paragraph', { destination: 'ENDP' });

Each destination type takes a fixed, positional parameter list:

| type | parameters |
| --- | --- |
| `XYZ` | `left`, `top`, `zoom` |
| `Fit` | none |
| `FitH` | `top` |
| `FitV` | `left` |
| `FitR` | `left`, `bottom`, `right`, `top` |
| `FitB` | none |
| `FitBH` | `top` |
| `FitBV` | `left` |

`XYZ` is the only type whose vertical coordinate is converted: give its `top` measured
from the top of the page, as everywhere else in PDFKit. The others are written through
unchanged, so `FitH` and `FitBH`'s `top`, and `FitR`'s `bottom` and `top`, are measured
from the bottom of the page.

A destination carrying more parameters than its type takes is not valid; `FitR` must
carry all four, and `XYZ` at least `left` and `top`. For `XYZ`, `FitH`, `FitV`, `FitBH`
and `FitBV` a parameter may be `null`, which tells the reader to keep that aspect of its
current view. Called with no type at all, `addNamedDestination(name)` writes `XYZ` with
all three parameters `null`.

Examples of go to link to anchor:

Expand Down
Loading