PDF::API2::Annotation - Add annotations to a PDF
- $ant = PDF::API2::Annotation->new
- Returns an annotation object (called from
$page->annotation).
- $ant->link $page, %opts
- Defines the annotation as launch-page with page
$page and options %opts
(-rect, -border or 'dest-options').
- $ant->url $url, %opts
- Defines the annotation as launch-url with url $url
and options %opts (-rect and/or -border).
- $ant->file $file, %opts
- Defines the annotation as launch-file with filepath
$file and options %opts
(-rect and/or -border).
- $ant->pdfile $pdfile, $pagenum, %opts
- Defines the annotation as pdf-file with filepath
$pdfile, $pagenum and
options %opts (same as dest).
- $ant->text $text, %opts
- Defines the annotation as textnote with content
$text and options %opts
(-rect and/or -open).
- $ant->movie $file, $contentype, %opts
- Defines the annotation as a movie from $file with
$contentype and options
%opts (-rect).
- $ant->rect $llx, $lly, $urx, $ury
- Sets the rectangle of the annotation.
- $ant->border @b
- Sets the border-styles of the annotation, if applicable.
- $ant->content @lines
- Sets the text-content of the annotation, if applicable.
- $ant->open $bool
- Display the annotation either open or closed, if applicable.
- $ant->dest( $page, -fit => 1 )
- Display the page designated by page, with its contents magnified just
enough to fit the entire page within the window both horizontally and
vertically. If the required horizontal and vertical magnification factors
are different, use the smaller of the two, centering the page within the
window in the other dimension.
- $ant->dest( $page, -fith => $top )
- Display the page designated by page, with the vertical coordinate top
positioned at the top edge of the window and the contents of the page
magnified just enough to fit the entire width of the page within the
window.
- $ant->dest( $page, -fitv => $left )
- Display the page designated by page, with the horizontal coordinate left
positioned at the left edge of the window and the contents of the page
magnified just enough to fit the entire height of the page within the
window.
- $ant->dest( $page, -fitr => [ $left, $bottom, $right, $top ] )
- Display the page designated by page, with its contents magnified just
enough to fit the rectangle specified by the coordinates left, bottom,
right, and top entirely within the window both horizontally and
vertically. If the required horizontal and vertical magnification factors
are different, use the smaller of the two, centering the rectangle within
the window in the other dimension.
- $ant->dest( $page, -fitb => 1 )
- (PDF 1.1) Display the page designated by page, with its contents magnified
just enough to fit its bounding box entirely within the window both
horizontally and vertically. If the required horizontal and vertical
magnification factors are different, use the smaller of the two, centering
the bounding box within the window in the other dimension.
- $ant->dest( $page, -fitbh => $top )
- (PDF 1.1) Display the page designated by page, with the vertical
coordinate top positioned at the top edge of the window and the contents
of the page magnified just enough to fit the entire width of its bounding
box within the window.
- $ant->dest( $page, -fitbv => $left )
- (PDF 1.1) Display the page designated by page, with the horizontal
coordinate left positioned at the left edge of the window and the contents
of the page magnified just enough to fit the entire height of its bounding
box within the window.
- $ant->dest( $page, -xyz => [ $left, $top, $zoom ] )
- Display the page designated by page, with the coordinates (left, top)
positioned at the top-left corner of the window and the contents of the
page magnified by the factor zoom. A zero (0) value for any of the
parameters left, top, or zoom specifies that the current value of that
parameter is to be retained unchanged.
- $ant->dest( $name )
- (PDF 1.2) Connect the Annotation to a "Named Destination"
defined elsewhere.