1PDF::API2::Annotation(3U)ser Contributed Perl DocumentatiPoDnF::API2::Annotation(3)
2
6 PDF::API2::Annotation - Add annotations to a PDF
7
9 $ant = PDF::API2::Annotation->new
10 Returns an annotation object (called from $page->annotation).
11 $ant->link $page, %opts
13 Defines the annotation as launch-page with page $page and options
14 %opts (-rect, -border or 'dest-options').
15 $ant->url $url, %opts
17 Defines the annotation as launch-url with url $url and options
18 %opts (-rect and/or -border).
19 $ant->file $file, %opts
21 Defines the annotation as launch-file with filepath $file and
22 options %opts (-rect and/or -border).
23 $ant->pdfile $pdfile, $pagenum, %opts
25 Defines the annotation as pdf-file with filepath $pdfile, $pagenum
26 and options %opts (same as dest).
27 $ant->text $text, %opts
29 Defines the annotation as textnote with content $text and options
30 %opts (-rect and/or -open).
31 $ant->movie $file, $contentype, %opts
33 Defines the annotation as a movie from $file with $contentype and
34 options %opts (-rect).
35 $ant->rect $llx, $lly, $urx, $ury
37 Sets the rectangle of the annotation.
38 $ant->border @b
40 Sets the border-styles of the annotation, if applicable.
41 $ant->content @lines
43 Sets the text-content of the annotation, if applicable.
44 $ant->open $bool
46 Display the annotation either open or closed, if applicable.
47 $ant->dest( $page, -fit => 1 )
49 Display the page designated by page, with its contents magnified
50 just enough to fit the entire page within the window both
51 horizontally and vertically. If the required horizontal and
52 vertical magnification factors are different, use the smaller of
53 the two, centering the page within the window in the other
54 dimension.
55 $ant->dest( $page, -fith => $top )
57 Display the page designated by page, with the vertical coordinate
58 top positioned at the top edge of the window and the contents of
59 the page magnified just enough to fit the entire width of the page
60 within the window.
61 $ant->dest( $page, -fitv => $left )
63 Display the page designated by page, with the horizontal coordinate
64 left positioned at the left edge of the window and the contents of
65 the page magnified just enough to fit the entire height of the page
66 within the window.
67 $ant->dest( $page, -fitr => [ $left, $bottom, $right, $top ] )
69 Display the page designated by page, with its contents magnified
70 just enough to fit the rectangle specified by the coordinates left,
71 bottom, right, and top entirely within the window both horizontally
72 and vertically. If the required horizontal and vertical
73 magnification factors are different, use the smaller of the two,
74 centering the rectangle within the window in the other dimension.
75 $ant->dest( $page, -fitb => 1 )
77 (PDF 1.1) Display the page designated by page, with its contents
78 magnified just enough to fit its bounding box entirely within the
79 window both horizontally and vertically. If the required horizontal
80 and vertical magnification factors are different, use the smaller
81 of the two, centering the bounding box within the window in the
82 other dimension.
83 $ant->dest( $page, -fitbh => $top )
85 (PDF 1.1) Display the page designated by page, with the vertical
86 coordinate top positioned at the top edge of the window and the
87 contents of the page magnified just enough to fit the entire width
88 of its bounding box within the window.
89 $ant->dest( $page, -fitbv => $left )
91 (PDF 1.1) Display the page designated by page, with the horizontal
92 coordinate left positioned at the left edge of the window and the
93 contents of the page magnified just enough to fit the entire height
94 of its bounding box within the window.
95 $ant->dest( $page, -xyz => [ $left, $top, $zoom ] )
97 Display the page designated by page, with the coordinates (left,
98 top) positioned at the top-left corner of the window and the
99 contents of the page magnified by the factor zoom. A zero (0) value
100 for any of the parameters left, top, or zoom specifies that the
101 current value of that parameter is to be retained unchanged.
102 $ant->dest( $name )
104 (PDF 1.2) Connect the Annotation to a "Named Destination" defined
105 elsewhere.
106perl v5.28.1 2017-07-07 PDF::API2::Annotation(3)