addAnnotRef(): clickable rectangle annotations. * - setBookmark(): outline entries that drive the bookmark panel. * * @since 2026-05-01 * @category Library * @package Pdf * @author Nicola Asuni * @copyright 2002-2026 Nicola Asuni - Tecnick.com LTD * @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE) * @link https://github.com/tecnickcom/tc-lib-pdf * * This file is part of tc-lib-pdf software library. */ // NOTE: local file reads (images, fonts, attachments) are restricted to an allowlist of // trusted paths that covers this package tree, so run the examples in place. To read assets // from other locations, list them in the 'allowedPaths' entry of the fileOptions constructor // parameter (see E047_remote_resources_security.php). // NOTE: run make fonts in the project root to generate the dependencies and example fonts. require __DIR__ . '/../vendor/autoload.php'; define('K_PATH_FONTS', (string) realpath(__DIR__ . '/../vendor/tecnickcom/tc-lib-pdf-font/target/fonts')); $pdf = new \Com\Tecnick\Pdf\Tcpdf( unit: \Com\Tecnick\Pdf\Page\Unit::Millimeter, isunicode: true, subsetfont: false, compress: true, mode: \Com\Tecnick\Pdf\PdfConformance::None, objEncrypt: null, ); $pdf->setCreator('tc-lib-pdf'); $pdf->setAuthor('Nicola Asuni'); $pdf->setSubject('tc-lib-pdf example: 051'); $pdf->setTitle('Viewer Preferences & Navigation'); $pdf->setKeywords('TCPDF tc-lib-pdf viewer preferences navigation bookmarks named destinations links'); $pdf->setPDFFilename('051_viewer_preferences_navigation.pdf'); // ---------- // Viewer preferences // The viewer will open the document in single-page layout with outline panel // visible. The window is centered on screen and the document title shown in // the title bar. $pdf->setViewerPreferences([ 'DisplayDocTitle' => true, 'CenterWindow' => true, 'FitWindow' => false, 'HideToolbar' => false, 'HideMenubar' => false, 'Duplex' => 'DuplexFlipLongEdge', 'PrintScaling' => 'none', 'NumCopies' => 1, 'PrintPageRange' => [1, 4], 'NonFullScreenPageMode' => 'UseOutlines', ]); // Display mode: open at full width, single-page layout, with outlines panel. $pdf->setDisplayMode( zoom: \Com\Tecnick\Pdf\DisplayZoom::FullWidth, layout: \Com\Tecnick\Pdf\Page\PageLayout::SinglePage, mode: \Com\Tecnick\Pdf\Page\PageDisplayMode::UseOutlines, ); $pdf->enableDefaultPageContent(); // ---------- $headFont = $pdf->font->insert($pdf->pon, 'helvetica', 'B', 16); $subFont = $pdf->font->insert($pdf->pon, 'helvetica', 'B', 11); $bodyFont = $pdf->font->insert($pdf->pon, 'helvetica', '', 10); // ===| Page 1 – Cover |====================================================== $page1 = $pdf->addPage(['format' => 'A4']); // Register a named destination at the top of page 1. External documents or // bookmark links can jump here via '#cover'. $pdf->setNamedDestination(name: 'cover', page: $page1['pid'], posx: 0, posy: 0); $pdf->setBookmark( name: 'Cover', link: '#cover', level: 0, page: $page1['pid'], posx: 0, posy: 0, fstyle: 'B', color: 'darkblue', ); $coverHtml = '

Viewer Preferences & Navigation Demo

tc-lib-pdf · Example 051

This document demonstrates:

Viewer preferences — initial layout, duplex, print scaling, and window behavior.
Display mode — zoom, page layout, and panel visibility on open.
Named destinations — stable jump targets for cross-document links.
Internal link annotations — clickable regions mapped to page positions.
Bookmarks / outlines — hierarchical navigation panel entries.

The navigation buttons on page 4 use setLink and addInternalLink to create clickable rectangles that jump to each chapter page.

'; $pdf->addHTMLCell(html: $coverHtml, posx: 15, posy: 20, width: 170); // ===| Page 2 – Chapter 1 |================================================== $page2 = $pdf->addPage(['format' => 'A4']); $destChapter1 = $pdf->setNamedDestination(name: 'chapter-1', page: $page2['pid'], posx: 0, posy: 0); $pdf->setBookmark( name: 'Chapter 1 — Overview', link: $destChapter1, level: 0, page: $page2['pid'], posx: 0, posy: 0, fstyle: 'B', color: 'darkgreen', ); $pdf->setBookmark(name: '1.1 Introduction', link: '', level: 1, page: $page2['pid'], posx: 0, posy: 25); $ch1Html = '

Chapter 1 — Overview

This chapter is the target of the named destination chapter-1. Clicking the button on the navigation page jumps here via an internal link annotation.

1.1 Introduction

The setNamedDestination() method registers a jump target that can be referenced from bookmarks (using the # prefix), from link annotations, or from external documents pointing to this file.

Named destinations are stored in the PDF /Dests dictionary and are independent of page numbering — they remain stable even if pages are reordered.

'; $pdf->addHTMLCell(html: $ch1Html, posx: 15, posy: 20, width: 170); // ===| Page 3 – Chapter 2 |================================================== $page3 = $pdf->addPage(['format' => 'A4']); $destChapter2 = $pdf->setNamedDestination(name: 'chapter-2', page: $page3['pid'], posx: 0, posy: 0); $pdf->setBookmark( name: 'Chapter 2 — Viewer Preferences', link: $destChapter2, level: 0, page: $page3['pid'], posx: 0, posy: 0, fstyle: 'B', color: 'darkred', ); $pdf->setBookmark(name: '2.1 Preference Keys', link: '', level: 1, page: $page3['pid'], posx: 0, posy: 25); $prefTable = '

Chapter 2 — Viewer Preferences

The setViewerPreferences() method populates the /ViewerPreferences dictionary in the PDF catalog. The following preferences are active in this document:

Key	Value	Effect
DisplayDocTitle	true	Show PDF title in window title bar.
CenterWindow	true	Center the viewer window on screen.
Duplex	DuplexFlipLongEdge	Default duplex setting for print dialog.
PrintScaling	none	Disable auto-scaling in print dialog.
NumCopies	1	Default copy count in print dialog.
PrintPageRange	1–4	Default page range in print dialog.
NonFullScreenPageMode	UseOutlines	Show outline panel when exiting full screen.

'; $pdf->addHTMLCell(html: $prefTable, posx: 15, posy: 20, width: 170); // ===| Page 4 – Navigation Map |============================================= $page4 = $pdf->addPage(['format' => 'A4']); $pdf->setBookmark( name: 'Navigation Map', link: '', level: 0, page: $page4['pid'], posx: 0, posy: 0, fstyle: '', color: 'gray', ); $navHtml = '

Navigation Map

Each button below is a clickable link annotation (setLink + addAnnotRef) that uses addInternalLink() to jump to the start of a specific page.

Alternatively, the bookmark panel (outline) on the left provides the same navigation via the bookmarks registered with setBookmark().

'; $pdf->addHTMLCell(html: $navHtml, posx: 15, posy: 20, width: 170); // Define style for button boxes $btnFill = ['all' => ['lineWidth' => 0.3, 'lineColor' => '#333366', 'fillColor' => '#e8eef8']]; $btnFont = $pdf->font->insert($pdf->pon, 'helvetica', 'B', 11); $pdf->page->addContent($btnFont['out']); // Helper to draw a navigation button and attach a link annotation $drawNavButton = static function ( \Com\Tecnick\Pdf\Tcpdf $pdf, float $bx, float $by, float $bw, float $bh, string $label, int $targetPage, array $btnFill, ) use ($page4): void { $pdf->page->addContent($pdf->graph->getRect($bx, $by, $bw, $bh, 'DF', $btnFill)); // Reset fill color to dark text after the rect draw, which left the fill color // set to the button background color, making the label text invisible. $pdf->page->addContent($pdf->color->getPdfColor('#333366')); $pdf->page->addContent($pdf->getTextCell( txt: $label, posx: $bx, posy: $by + 3, width: $bw, height: $bh - 3, offset: 0, linespace: 1, valign: \Com\Tecnick\Pdf\TextVAlign::Top, halign: \Com\Tecnick\Pdf\TextHAlign::Center, )); $lnkid = $pdf->addInternalLink($targetPage, 0); $annid = $pdf->setLink(posx: $bx, posy: $by, width: $bw, height: $bh, link: $lnkid); $pdf->page->addAnnotRef($annid); }; $drawNavButton($pdf, 25, 80, 70, 14, 'Go to Cover (page 1)', $page1['pid'], $btnFill); $drawNavButton($pdf, 25, 100, 70, 14, 'Go to Chapter 1 (page 2)', $page2['pid'], $btnFill); $drawNavButton($pdf, 25, 120, 70, 14, 'Go to Chapter 2 (page 3)', $page3['pid'], $btnFill); // Restore the plain body font in the internal font stack before addHTMLCell; // font->insert with 'B' above left the stack on the bold variant and would // cause addHTMLCell to capture/restore 'helveticabB' → undefined key warning. $pdf->font->insert($pdf->pon, 'helvetica', '', 10); // Show named destination links using '#name' notation in bookmarks $namedNoteHtml = '

The bookmark entries above the buttons use setNamedDestination() targets (#cover, #chapter-1, #chapter-2). Named destinations survive page renumbering and can be referenced from external documents.

'; $pdf->addHTMLCell(html: $namedNoteHtml, posx: 15, posy: 145, width: 170); // ---------- $rawpdf = $pdf->getOutPDFString(); $pdf->renderPDF(rawpdf: $rawpdf);