1PDF::Builder::Outline(3U)ser Contributed Perl DocumentatiPoDnF::Builder::Outline(3)
2
3
4

NAME

6       PDF::Builder::Outline - Manage PDF outlines (a.k.a. bookmarks)
7

METHODS

9       $outline = PDF::Builder::Outline->new($api, $parent, $prev)
10           Returns a new outline object (called from $outlines->outline()).
11
12       $outline->title($text)
13           Set the title of the outline.
14
15       $outline->closed()
16           Set the status of the outline to closed (i.e., collapsed).
17
18       $outline->open()
19           Set the status of the outline to open (i.e., expanded).
20
21       $child_outline = $parent_outline->outline()
22           Returns a new sub-outline (nested outline).
23
24       $outline->dest($page_object, %position)
25       $outline->dest($page_object)
26           Sets the destination page and optional position of the outline.
27
28           %position can be any of the following:
29
30           -fit => 1
31               Display the page designated by $page, with its contents
32               magnified just enough to fit the entire page within the window
33               both horizontally and vertically. If the required horizontal
34               and vertical magnification factors are different, use the
35               smaller of the two, centering the page within the window in the
36               other dimension.
37
38           -fith => $top
39               Display the page designated by $page, with the vertical
40               coordinate $top positioned at the top edge of the window and
41               the contents of the page magnified just enough to fit the
42               entire width of the page within the window.
43
44           -fitv => $left
45               Display the page designated by $page, with the horizontal
46               coordinate $left positioned at the left edge of the window and
47               the contents of the page magnified just enough to fit the
48               entire height of the page within the window.
49
50           -fitr => [$left, $bottom, $right, $top]
51               Display the page designated by $page, with its contents
52               magnified just enough to fit the rectangle specified by the
53               coordinates $left, $bottom, $right, and $top entirely within
54               the window both horizontally and vertically. If the required
55               horizontal and vertical magnification factors are different,
56               use the smaller of the two, centering the rectangle within the
57               window in the other dimension.
58
59           -fitb => 1
60               Display the page designated by $page, with its contents
61               magnified just enough to fit its bounding box entirely within
62               the window both horizontally and vertically. If the required
63               horizontal and vertical magnification factors are different,
64               use the smaller of the two, centering the bounding box within
65               the window in the other dimension.
66
67           -fitbh => $top
68               Display the page designated by $page, with the vertical
69               coordinate $top positioned at the top edge of the window and
70               the contents of the page magnified just enough to fit the
71               entire width of its bounding box within the window.
72
73           -fitbv => $left
74               Display the page designated by $page, with the horizontal
75               coordinate $left positioned at the left edge of the window and
76               the contents of the page magnified just enough to fit the
77               entire height of its bounding box within the window.
78
79           -xyz => [$left, $top, $zoom]
80               Display the page designated by $page, with the coordinates
81               "[$left, $top]" positioned at the top-left corner of the window
82               and the contents of the page magnified by the factor $zoom. A
83               zero (0) value for any of the parameters $left, $top, or $zoom
84               specifies that the current value of that parameter is to be
85               retained unchanged.
86
87               This is the default fit setting, with position (left and top)
88               and zoom the same as the calling page's.
89
90       $outline->dest($name, %position)
91       $outline->dest($name)
92           Connect the Outline to a "Named Destination" defined elsewhere, and
93           optional positioning as described above.
94
95       $outline->url($url)
96           Defines the outline as launch-url with url $url.
97
98       $outline->file($file)
99           Defines the outline as launch-file with filepath $file.
100
101       $outline->pdf_file($pdffile, $page_number, %position)
102       $outline->pdf_file($pdffile, $page_number)
103           Defines the destination of the outline as a PDF-file with filepath
104           $pdffile, on page $pagenum (default 0), and position %position
105           (same as dest()).
106
107
108
109perl v5.34.0                      2021-07-22          PDF::Builder::Outline(3)
Impressum