1PDF::API2::Outline(3) User Contributed Perl DocumentationPDF::API2::Outline(3)
2
6 PDF::API2::Outline - Manage PDF outlines (aka bookmarks)
7
9 $otl = PDF::API2::Outline->new $api,$parent,$prev
10 Returns a new outline object (called from $otls->outline).
11 $otl->title $text
13 Set the title of the outline.
14 $otl->closed
16 Set the status of the outline to closed.
17 $otl->open
19 Set the status of the outline to open.
20 $sotl=$otl->outline
22 Returns a new sub-outline.
23 $otl->dest $pageobj [, %opts]
25 Sets the destination page of the outline.
26 $otl->dest( $page, -fit => 1 )
28 Display the page designated by page, with its contents magnified
29 just enough to fit the entire page within the window both
30 horizontally and vertically. If the required horizontal and
31 vertical magnification factors are different, use the smaller of
32 the two, centering the page within the window in the other
33 dimension.
34 $otl->dest( $page, -fith => $top )
36 Display the page designated by page, with the vertical coordinate
37 top positioned at the top edge of the window and the contents of
38 the page magnified just enough to fit the entire width of the page
39 within the window.
40 $otl->dest( $page, -fitv => $left )
42 Display the page designated by page, with the horizontal coordinate
43 left positioned at the left edge of the window and the contents of
44 the page magnified just enough to fit the entire height of the page
45 within the window.
46 $otl->dest( $page, -fitr => [ $left, $bottom, $right, $top ] )
48 Display the page designated by page, with its contents magnified
49 just enough to fit the rectangle specified by the coordinates left,
50 bottom, right, and top entirely within the window both horizontally
51 and vertically. If the required horizontal and vertical
52 magnification factors are different, use the smaller of the two,
53 centering the rectangle within the window in the other dimension.
54 $otl->dest( $page, -fitb => 1 )
56 Display the page designated by page, with its contents magnified
57 just enough to fit its bounding box 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 bounding box within the window in the other
61 dimension.
62 $otl->dest( $page, -fitbh => $top )
64 Display the page designated by page, with the vertical coordinate
65 top positioned at the top edge of the window and the contents of
66 the page magnified just enough to fit the entire width of its
67 bounding box within the window.
68 $otl->dest( $page, -fitbv => $left )
70 Display the page designated by page, with the horizontal coordinate
71 left positioned at the left edge of the window and the contents of
72 the page magnified just enough to fit the entire height of its
73 bounding box within the window.
74 $otl->dest( $page, -xyz => [ $left, $top, $zoom ] )
76 Display the page designated by page, with the coordinates (left,
77 top) positioned at the top-left corner of the window and the
78 contents of the page magnified by the factor zoom. A zero (0) value
79 for any of the parameters left, top, or zoom specifies that the
80 current value of that parameter is to be retained unchanged.
81 $otl->dest( $name )
83 (PDF 1.2) Connect the Outline to a "Named Destination" defined
84 elsewhere.
85 $otl->url $url, %opts
87 Defines the outline as launch-url with url $url.
88 $otl->file $file, %opts
90 Defines the outline as launch-file with filepath $file.
91 $otl->pdfile $pdfile, $pagenum, %opts
93 Defines the destination of the outline as pdf-file with filepath
94 $pdfile, $pagenum and options %opts (same as dest).
95perl v5.28.0 2017-07-07 PDF::API2::Outline(3)