NAME

SVG - Perl extension for generating Scalable Vector Graphics (SVG) documents

VERSION

Version 2.32, 10 october, 2004

Refer to the SVG::Manual manpage for the complete manual

DESCRIPTION

SVG is a 100% Perl module which generates a nested data structure containing the DOM representation of an SVG (Scalable Vector Graphics) image. Using SVG, you can generate SVG objects, embed other SVG instances into it, access the DOM object, create and access javascript, and generate SMIL animation content.

Refer to the SVG::Manual manpage for the complete manual.

AUTHOR

Ronan Oger, RO IT Systemms GmbH, ronan@roasp.com

CREDITS

I would like to thank the following people for contributing to this module with patches, testing, suggestions, and other nice tidbits: Peter Wainwright, Ian Hickson, Adam Schneider, Steve Lihn, Allen Day

EXAMPLES

http://www.roasp.com/index.shtml?svg.pod

Methods

SVG provides both explicit and generic element constructor methods. Explicit generators are generally (with a few exceptions) named for the element they generate. If a tag method is required for a tag containing hyphens, the method name replaces the hyphen with an underscore. ie: to generate tag <column-heading id=``new''> you would use method $svg->column_heading(id=>'new').

All element constructors take a hash of element attributes and options; element attributes such as 'id' or 'border' are passed by name, while options for the method (such as the type of an element that supports multiple alternate forms) are passed preceded by a hyphen, e.g '-type'. Both types may be freely intermixed; see the fe method and code examples througout the documentation for more examples.

new (constructor)

$svg = SVG->new(%attributes)

Creates a new SVG object. Attributes of the document SVG element be passed as an optional list of key value pairs. Additionally, SVG options (prefixed with a hyphen) may be set on a per object basis:

Example:

    my $svg1=new SVG;

    my $svg2=new SVG(id => 'document_element');

    my $svg3=new SVG(
        -printerror => 1,
        -raiseerror => 0,
        -indent     => '  ',
    -elsep      =>"\n",  # element line (vertical) separator
        -docroot => 'svg', #default document root element (SVG specification assumes svg). Defaults to 'svg' if undefined


        -xml_xlink => 'http://www.w3.org/1999/xlink', #required by Mozilla's embedded SVG engine
        -sysid      => 'abc', #optional system identifyer 
        -pubid      => "-//W3C//DTD SVG 1.0//EN", #public identifyer default value is "-//W3C//DTD SVG 1.0//EN" if undefined
        -namespace => 'mysvg',
        -inline   => 1
        id          => 'document_element',
        width       => 300,
        height      => 200,
    );

Default SVG options may also be set in the import list. See EXPORTS above for more on the available options.

Furthermore, the following options:

    -version
    -encoding
    -standalone
    -namespace
    -inline
    -pubid (formerly -identifier)
    -sysid (standalone)

may also be set in xmlify, overriding any corresponding values set in the SVG->new declaration

xmlify (alias: to_xml render, serialize, serialise)

$string = $svg->xmlify(%attributes);

Returns xml representation of svg document.

XML Declaration

    Name               Default Value
    -version           '1.0'               
    -encoding          'UTF-8'
    -standalone        'yes'
    -namespace         'svg' - namespace prefix for elements. 
                               Can also be used in any element method to over-ride
                               the current namespace prefix. Make sure to have
                               declared the prefix before using it.
    -inline            '0' - If '1', then this is an inline document.
    -pubid             '-//W3C//DTD SVG 1.0//EN';
    -sysid             'http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd'

perlify ()

return the perl code which generates the SVG document as it currently exists.

SVG - Perl extension for generating Scalable Vector Graphics documents