1PDF::API2::NamedDestinaUtsieorn(C3o)ntributed Perl DocumPeDnFt:a:tAiPoIn2::NamedDestination(3)
2
3
4

NAME

6       PDF::API2::NamedDestination - Add named destination shortcuts to a PDF
7

METHODS

9       $dest = PDF::API2::NamedDestination->new $pdf
10       $dest->link $page, %opts
11           Defines the destination as launch-page with page $page and options
12           %opts (-rect, -border or 'dest-options').
13
14       $dest->url $url, %opts
15           Defines the destination as launch-url with url $url and options
16           %opts (-rect and/or -border).
17
18       $dest->file $file, %opts
19           Defines the destination as launch-file with filepath $file and
20           options %opts (-rect and/or -border).
21
22       $dest->pdfile $pdfile, $pagenum, %opts
23           Defines the destination as pdf-file with filepath $pdfile, $pagenum
24           and options %opts (same as dest).
25
26       $dest->dest( $page, -fit => 1 )
27           Display the page designated by page, with its contents magnified
28           just enough to fit the entire page within the window both
29           horizontally and vertically. If the required horizontal and
30           vertical magnification factors are different, use the smaller of
31           the two, centering the page within the window in the other
32           dimension.
33
34       $dest->dest( $page, -fith => $top )
35           Display the page designated by page, with the vertical coordinate
36           top positioned at the top edge of the window and the contents of
37           the page magnified just enough to fit the entire width of the page
38           within the window.
39
40       $dest->dest( $page, -fitv => $left )
41           Display the page designated by page, with the horizontal coordinate
42           left positioned at the left edge of the window and the contents of
43           the page magnified just enough to fit the entire height of the page
44           within the window.
45
46       $dest->dest( $page, -fitr => [ $left, $bottom, $right, $top ] )
47           Display the page designated by page, with its contents magnified
48           just enough to fit the rectangle specified by the coordinates left,
49           bottom, right, and top entirely within the window both horizontally
50           and vertically. If the required horizontal and vertical
51           magnification factors are different, use the smaller of the two,
52           centering the rectangle within the window in the other dimension.
53
54       $dest->dest( $page, -fitb => 1 )
55           (PDF 1.1) Display the page designated by page, with its contents
56           magnified just enough to fit its bounding box entirely within the
57           window both horizontally and vertically. If the required horizontal
58           and vertical magnification factors are different, use the smaller
59           of the two, centering the bounding box within the window in the
60           other dimension.
61
62       $dest->dest( $page, -fitbh => $top )
63           (PDF 1.1) Display the page designated by page, with the vertical
64           coordinate top positioned at the top edge of the window and the
65           contents of the page magnified just enough to fit the entire width
66           of its bounding box within the window.
67
68       $dest->dest( $page, -fitbv => $left )
69           (PDF 1.1) Display the page designated by page, with the horizontal
70           coordinate left positioned at the left edge of the window and the
71           contents of the page magnified just enough to fit the entire height
72           of its bounding box within the window.
73
74       $dest->dest( $page, -xyz => [ $left, $top, $zoom ] )
75           Display the page designated by page, with the coordinates (left,
76           top) positioned at the top-left corner of the window and the
77           contents of the page magnified by the factor zoom. A zero (0) value
78           for any of the parameters left, top, or zoom specifies that the
79           current value of that parameter is to be retained unchanged.
80
81
82
83perl v5.32.1                      2021-04-14    PDF::API2::NamedDestination(3)
Impressum