1PDF::Builder::NamedDestUisneartiCoonn(t3r)ibuted Perl DoPcDuFm:e:nBtuaitlidoenr::NamedDestination(3)
2
6 PDF::Builder::NamedDestination - Add named destination shortcuts to a
7 PDF
8
10 $dest = PDF::Builder::NamedDestination->new($pdf)
11 Returns a named destination object.
12 Destination types
14 $dest->link($page, %opts)
15 $dest->link($page)
16 Defines the destination as launch-page with page $page and options
17 %opts for target page fit.
18 $dest->url($url, %opts)
20 $dest->url($url)
21 Defines the destination as launch-url with url $url and page-fit
22 options %opts.
23 $dest->file($file, %opts)
25 $dest->file($file)
26 Defines the destination as launch-file with filepath $file and
27 page-fit options %opts.
28 $dest->pdf_file($pdffile, $pagenum, %opts)
30 $dest->pdf_file($pdffile, $pagenum)
31 Defines the destination as a PDF-file with filepath $pdffile, on
32 page $pagenum, and options %opts (same as dest()).
33 $dest->dest($page, -fit => 1)
35 Display the page designated by $page, with its contents magnified
36 just enough to fit the entire page within the window both
37 horizontally and vertically. If the required horizontal and
38 vertical magnification factors are different, use the smaller of
39 the two, centering the page within the window in the other
40 dimension.
41 $dest->dest($page, -fith => $top)
43 Display the page designated by $page, with the vertical coordinate
44 $top positioned at the top edge of the window and the contents of
45 the page magnified just enough to fit the entire width of the page
46 within the window.
47 $dest->dest($page, -fitv => $left)
49 Display the page designated by $page, with the horizontal
50 coordinate $left positioned at the left edge of the window and the
51 contents of the page magnified just enough to fit the entire height
52 of the page within the window.
53 $dest->dest($page, -fitr => [$left, $bottom, $right, $top])
55 Display the page designated by $page, with its contents magnified
56 just enough to fit the rectangle specified by the coordinates
57 $left, $bottom, $right, and $top entirely within the window both
58 horizontally and vertically. If the required horizontal and
59 vertical magnification factors are different, use the smaller of
60 the two, centering the rectangle within the window in the other
61 dimension.
62 $dest->dest($page, -fitb => 1)
64 Display the page designated by $page, with its contents magnified
65 just enough to fit its bounding box entirely within the window both
66 horizontally and vertically. If the required horizontal and
67 vertical magnification factors are different, use the smaller of
68 the two, centering the bounding box within the window in the other
69 dimension.
70 $dest->dest($page, -fitbh => $top)
72 Display the page designated by $page, with the vertical coordinate
73 $top positioned at the top edge of the window and the contents of
74 the page magnified just enough to fit the entire width of its
75 bounding box within the window.
76 $dest->dest($page, -fitbv => $left)
78 Display the page designated by $page, with the horizontal
79 coordinate $left positioned at the left edge of the window and the
80 contents of the page magnified just enough to fit the entire height
81 of its bounding box within the window.
82 $dest->dest($page, -xyz => [$left, $top, $zoom])
84 Display the page designated by page, with the coordinates "[$left,
85 $top]" positioned at the top-left corner of the window and the
86 contents of the page magnified by the factor $zoom. A zero (0)
87 value for any of the parameters $left, $top, or $zoom specifies
88 that the current value of that parameter is to be retained
89 unchanged.
90 This is the default fit setting, with position (left and top) and
92 zoom the same as the calling page's.
93perl v5.34.0 2022-01-21 PDF::Builder::NamedDestination(3)