Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
PDF::API2::Annotation(User Contributed Perl DocumentatPDF::API2::Annotation(3)

NAME
       PDF::API2::Annotation - Add annotations to a PDF

METHODS
       $annotation = PDF::API2::Annotation->new()
	   Returns an annotation object	(called	from $page->annotation()).

       $annotation->link($page,	%options)
	   Link	the annotation to another page in this PDF.

	   Accepts options -rect, -border, and any of the options listed under
	   dest().

       $annotation->url($url, %options)
	   Launch $url when the	annotation is selected.

	   Accepts options -rect and -border.

       $annotation->file($filename, %options)
	   Open	$filename when the annotation is selected.

	   Accepts options -rect and -border.

       $annotation->pdf_file($filename,	$page_number, %options)
	   Open	the PDF	file located at	$filename to the specified page
	   number.

	   Accepts options -rect, -border, and any of the options listed under
	   dest().

       $annotation->text($text,	%options)
	   Define the annotation as a text note	with the specified content.

	   Accepts options -rect and -open.

       $annotation->movie($filename, $content_type, %options)
	   Embed and link to the movie located at $filename with the specified
	   MIME	type.

	   Accepts a -rect option.

       $annotation->rect($llx, $lly, $urx, $ury)
	   Define the rectangle	around the annotation.

       $annotation->border($horizontal_corner_radius, $vertical_corner_radius,
       $width)
	   Define the border style.  Defaults to 0, 0, 1.

       $annotation->content(@lines)
	   Define the text content of the annotation, if applicable.

       $annotation->open($boolean)
	   Display the annotation either open or closed, if applicable.

       $annotation->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.

       $annotation->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.

       $annotation->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.

       $annotation->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.

       $annotation->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.

       $annotation->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.

       $annotation->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.

       $annotation->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.

       $annotation->dest( $name	)
	   (PDF	1.2) Connect the Annotation to a "Named	Destination" defined
	   elsewhere.

perl v5.32.0			  2020-02-05	      PDF::API2::Annotation(3)

NAME | METHODS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=PDF::API2::Annotation&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help