|
|
| |
PDF::Builder::NamedDestination(3) |
User Contributed Perl Documentation |
PDF::Builder::NamedDestination(3) |
PDF::Builder::NamedDestination - Add named destination shortcuts to a PDF
- $dest = PDF::Builder::NamedDestination->new($pdf)
- Returns a named destination object.
- $dest->link($page, %opts)
- $dest->link($page)
- Defines the destination as launch-page with page
$page and options %opts
for target page fit.
- $dest->url($url, %opts)
- $dest->url($url)
- Defines the destination as launch-url with url
$url and page-fit options
%opts.
- $dest->file($file, %opts)
- $dest->file($file)
- Defines the destination as launch-file with filepath
$file and page-fit options
%opts.
- $dest->pdf_file($pdffile, $pagenum, %opts)
- $dest->pdf_file($pdffile, $pagenum)
- Defines the destination as a PDF-file with filepath
$pdffile, on page
$pagenum, and options
%opts (same as dest()).
- $dest->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.
- $dest->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.
- $dest->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.
- $dest->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.
- $dest->dest($page, -fitb => 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.
- $dest->dest($page, -fitbh => $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 its bounding box within the window.
- $dest->dest($page, -fitbv => $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 its bounding box within the window.
- $dest->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.
This is the default fit setting, with position (left
and top) and zoom the same as the calling page's.
Visit the GSP FreeBSD Man Page Interface. Output converted with ManDoc. |