Scroll to navigation

PDF::API2::Lite(3) User Contributed Perl Documentation PDF::API2::Lite(3)


PDF::API2::Lite - (do not use)


    $pdf = PDF::API2::Lite->new;
    $img = $pdf->image('some.jpg');
    $font = $pdf->corefont('Times-Roman');
    $font = $pdf->ttfont('TimesNewRoman.ttf');


This class is unmaintained (since 2007) and should not be used in new code. It combines many of the methods from PDF::API2 and PDF::API2::Content into a single class but isn't otherwise any easier to use.

There have been many improvements and clarifications made to the rest of the distribution that aren't reflected here, so the term "Lite" no longer applies. It remains solely for compatibility with existing legacy code.


$pdf = PDF::API2::Lite->new
$pdf->page $width,$height
$pdf->page $llx, $lly, $urx, $ury
Opens a new page.
$pdf->mediabox $w, $h
$pdf->mediabox $llx, $lly, $urx, $ury
Sets the global mediabox.
$pdf->saveas $file
Saves the document (may not be modified later) and deallocates the pdf-structures.
$font = $pdf->corefont $fontname
Returns a new or existing adobe core font object.


    $font = $pdf->corefont('Times-Roman');
    $font = $pdf->corefont('Times-Bold');
    $font = $pdf->corefont('Helvetica');
    $font = $pdf->corefont('ZapfDingbats');
$font = $pdf->ttfont $ttfile
Returns a new or existing truetype font object.


    $font = $pdf->ttfont('TimesNewRoman.ttf');
    $font = $pdf->ttfont('/fonts/Univers-Bold.ttf');
    $font = $pdf->ttfont('../Democratica-SmallCaps.ttf');
$font = $pdf->psfont($ps_file, [%options])
Returns a new type1 font object.


    $font = $pdf->psfont('TimesRoman.pfa', -afmfile => 'TimesRoman.afm', -encode => 'latin1');
    $font = $pdf->psfont('/fonts/Univers.pfb', -pfmfile => '/fonts/Univers.pfm', -encode => 'latin2');
$egs = $pdf->create_egs
Returns a new extended-graphics-state object.


    $egs = $pdf->create_egs;
$img = $pdf->image_jpeg $file
Returns a new jpeg-image object.
$img = $pdf->image_png $file
Returns a new png-image object.
$img = $pdf->image_tiff $file
Returns a new tiff-image object.
$img = $pdf->image_pnm $file
Returns a new pnm-image object.
Saves the state of the page.
Restores the state of the page.
$pdf->egstate $egs
Sets extended-graphics-state.
$pdf->fillcolor $color
Sets fillcolor.
$pdf->strokecolor $color
Sets strokecolor.

Defined color-names are:

    aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond,
    blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue,
    cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgreen, darkgrey,
    darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon,
    darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet,
    deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen,
    fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew,
    hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon,
    lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgreen, lightgrey,
    lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey,
    lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine,
    mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen,
    mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite,
    navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen,
    paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple,
    red, rosybrown, royalblue, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna,
    silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal,
    thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

or the rgb-hex-notation:

    #rgb, #rrggbb, #rrrgggbbb and #rrrrggggbbbb

or the cmyk-hex-notation:

    %cmyk, %ccmmyykk, %cccmmmyyykkk and %ccccmmmmyyyykkkk

or the hsl-hex-notation:

    &hsl, &hhssll, &hhhssslll and &hhhhssssllll

and additionally the hsv-hex-notation:

    !hsv, !hhssvv, !hhhsssvvv and !hhhhssssvvvv
$pdf->linedash @dash
Sets linedash.
$pdf->linewidth $width
Sets linewidth.
$pdf->transform %opts
Sets transformations (eg. translate, rotate, scale, skew) in pdf-canonical order.


        -translate => [$x,$y],
        -rotate    => $rot,
        -scale     => [$sx,$sy],
        -skew      => [$sa,$sb],
$pdf->move $x, $y
$pdf->line $x, $y
$pdf->curve $x1, $y1, $x2, $y2, $x3, $y3
$pdf->arc $x, $y, $a, $b, $alfa, $beta, $move
$pdf->ellipse $x, $y, $a, $b
$pdf->circle $x, $y, $r
$pdf->rect $x,$y, $w,$h
$pdf->rectxy $x1,$y1, $x2,$y2
$pdf->poly $x1,$y1, ..., $xn,$yn
$pdf->image $imgobj, $x,$y, $w,$h
$pdf->image $imgobj, $x,$y, $scale
$pdf->image $imgobj, $x,$y
Please Note: The width/height or scale given is in user-space coordinates which is subject to transformations which may have been specified beforehand.

Per default this has a 72dpi resolution, so if you want an image to have a 150 or 300dpi resolution, you should specify a scale of 72/150 (or 72/300) or adjust width/height accordingly.

$pdf->textfont $fontobj,$size
$txt->textleading $leading
$pdf->text $string
Applies the given text.
$pdf->print $font, $size, $x, $y, $rot, $just, $text
Convenience wrapper for shortening the textstart..textend sequence.
2024-06-23 perl v5.40.0