.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
.\" ========================================================================
.de Sh \" Subsection heading
.de Sp \" Vertical space (when we can't use .PP)
.de Vb \" Begin verbatim text
.de Ve \" End verbatim text
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
. tm Index:\\$1\t\\n%\t"\\$2"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. \" simple accents for nroff and troff
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
.\" ========================================================================
.IX Title "SVG::Element 3"
.TH SVG::Element 3 "2003-11-02" "perl v5.8.0" "User Contributed Perl Documentation"
SVG::Element \- Generate the element bits for SVG.pm
Ronan Oger, ronan@roasp.com
\&\fIperl\fR\|(1),\s-1SVG\s0,\s-1SVG::XML\s0,SVG::Element,SVG::Parser, SVG::Manual
http://www.roitsystems.com/
http://www.w3c.org/Graphics/SVG/
.Sh "tag (alias: element)"
.IX Subsection "tag (alias: element)"
$tag = \f(CW$SVG\fR\->tag($name, \f(CW%attributes\fR)
Generic element generator. Creates the element named \f(CW$name\fR with the attributes
specified in \f(CW%attributes\fR. This method is the basis of most of the explicit
\& my $tag = $SVG->tag('g', transform=>'rotate(-45)');
$tag = \f(CW$SVG\fR\->anchor(%attributes)
Generate an anchor element. Anchors are put around objects to make them
\&'live' (i.e. clickable). It therefore requires a drawn object or group element
\& -href=>'http://here.com/some/simpler/SVG.SVG'
\& # add a circle to the anchor. The circle can be clicked on.
\& $tag->circle(cx=>10,cy=>10,r=>1);
\& # more complex anchor with both URL and target
\& -href => 'http://somewhere.org/some/other/page.html',
\& -target => 'new_window'
$tag = \f(CW$SVG\fR\->circle(%attributes)
Draw a circle at (cx,cy) with radius r.
\& my $tag = $SVG->circlecx=>4, cy=>2, r=>1);
$tag = \f(CW$SVG\fR\->ellipse(%attributes)
Draw an ellipse at (cx,cy) with radii rx,ry.
\& my $tag = $SVG->ellipse(
\& 'stroke-opacity'=>'0.5',
.Sh "rectangle (alias: rect)"
.IX Subsection "rectangle (alias: rect)"
$tag = \f(CW$SVG\fR\->rectangle(%attributes)
Draw a rectangle at (x,y) with width 'width' and height 'height' and side radii
\& $tag = $SVG->rectangle(
\& $tag = $SVG->image(%attributes)
Draw an image at (x,y) with width 'width' and height 'height' linked to image
resource '\-href'. See also \*(L"use\*(R".
\& width=>300, height=>200,
\& '-href'=>"image.png", #may also embed SVG, e.g. "image.SVG"
\& <image xlink:href="image.png" x="100" y="100" width="300" height="200"/>
$tag = \f(CW$SVG\fR\->use(%attributes)
Retrieve the content from an entity within an \s-1SVG\s0 document and apply it at
(x,y) with width 'width' and height 'height' linked to image resource '\-href'.
\& width=>300, height=>200,
\& '-href'=>"pic.SVG#image_1",
\& <use xlink:href="pic.SVG#image_1" x="100" y="100" width="300" height="200"/>
According to the \s-1SVG\s0 specification, the 'use' element in \s-1SVG\s0 can point to a
single element within an external \s-1SVG\s0 file.
$tag = \f(CW$SVG\fR\->polygon(%attributes)
Draw an n\-sided polygon with vertices at points defined by a string of the form
\&'x1,y1,x2,y2,x3,y3,... xy,yn'. The \*(L"get_path\*(R" method is provided as a
convenience to generate a suitable string from coordinate data.
\& # a five-sided polygon
\& $points = $a->get_path(
\& style=>\e%polygon_style
\&\s-1SEE\s0 \s-1ALSO:\s0
\&\*(L"polyline\*(R", \*(L"path\*(R", \*(L"get_path\*(R".
.IX Subsection "polyline"
$tag = \f(CW$SVG\fR\->polyline(%attributes)
Draw an n\-point polyline with points defined by a string of the form
\&'x1,y1,x2,y2,x3,y3,... xy,yn'. The \*(L"get_path\*(R" method is provided as a
convenience to generate a suitable string from coordinate data.
\& # a 10-pointsaw-tooth pattern
\& my $xv = [0,1,2,3,4,5,6,7,8,9];
\& my $yv = [0,1,0,1,0,1,0,1,0,1];
\& $points = $a->get_path(
\& -closed=>'true' #specify that the polyline is closed.
\& my $tag = $a->polyline (
\& 'stroke-color'=>'rgb(250,123,23)'
$tag = \f(CW$SVG\fR\->line(%attributes)
Draw a straight line between two points (x1,y1) and (x2,y2).
To draw multiple connected lines, use \*(L"polyline\*(R".
$text = \f(CW$SVG\fR\->text(%attributes)\->\fIcdata()\fR;
$text_path = \f(CW$SVG\fR\->text(\-type=>'path');
\&\f(CW$text_span\fR = \f(CW$text_path\fR\->text(\-type=>'span')\->cdata('A');
\&\f(CW$text_span\fR = \f(CW$text_path\fR\->text(\-type=>'span')\->cdata('B');
\&\f(CW$text_span\fR = \f(CW$text_path\fR\->text(\-type=>'span')\->cdata('C');
define the container for a text string to be drawn in the image.
\-type = path type (path | polyline | polygon)
\-type = text element type (path | span | normal [default])
\& my $text1 = $SVG->text(
\& id=>'l1', x=>10, y=>10
\& )->cdata('hello, world');
\& my $text2 = $SVG->text(
\& id=>'l1', x=>10, y=>10, -cdata=>'hello, world');
\& my $text = $SVG->text(
\& id=>'tp', x=>10, y=>10 -type=>path)
\& ->text(id=>'ts' -type=>'span')
\& ->cdata('hello, world');
\&\s-1SEE\s0 \s-1ALSO:\s0
\& L<"desc">, L<"cdata">.
$tag = \f(CW$SVG\fR\->title(%attributes)
Generate the title of the image.
\& my $tag = $SVG->title(id=>'document-title')->cdata('This is the title');
$tag = \f(CW$SVG\fR\->desc(%attributes)
Generate the description of the image.
\& my $tag = $SVG->desc(id=>'document-desc')->cdata('This is a description');
$tag = \f(CW$SVG\fR\->comment(@comments)
Generate the description of the image.
\& my $tag = $SVG->comment('comment 1','comment 2','comment 3');
$tag = \f(CW$SVG\fR\->pi(@pi)
Generate a set of processing instructions
\& my $tag = $SVG->pi('instruction one','instruction two','instruction three');
\& <lt>?instruction one?<gt>
\& <lt>?instruction two?<gt>
\& <lt>?instruction three?<gt>
$tag = \f(CW$SVG\fR\->script(%attributes)
Generate a script container for dynamic (client\-side) scripting using
ECMAscript, Javascript or other compatible scripting language.
\& my $tag = $SVG->script(-type=>"text/ecmascript");
\& # populate the script tag with cdata
\& # be careful to manage the javascript line ends.
\& # qq|text| or qqยงtextยง where text is the script
\& # works well for this.
\& $tag->cdata(qq|function d(){
\& //simple display function
\& for(cnt = 0; cnt < d.length; cnt++)
\& document.write(d[cnt]);//end for loop
\& document.write("<BR>");//write a line break
$tag = \f(CW$SVG\fR\->path(%attributes)
Draw a path element. The path vertices may be imputed as a parameter or
calculated usingthe \*(L"get_path\*(R" method.
\& # a 10-pointsaw-tooth pattern drawn with a path definition
\& my $xv = [0,1,2,3,4,5,6,7,8,9];
\& my $yv = [0,1,0,1,0,1,0,1,0,1];
\& $points = $a->get_path(
\& -closed => 'true' #specify that the polyline is closed
\& 'fill-color' => 'green',
\& 'stroke-color' => 'rgb(250,123,23)'
\&\s-1SEE\s0 \s-1ALSO:\s0
.IX Subsection "get_path"
$path = \f(CW$SVG\fR\->get_path(%attributes)
Returns the text string of points correctly formatted to be incorporated into
the multi-point \s-1SVG\s0 drawing object definitions (path, polyline, polygon)
\&\fBInput:\fR attributes including:
\& -type = path type (path | polyline | polygon)
\& x = reference to array of x coordinates
\& y = reference to array of y coordinates
\&\fBOutput:\fR a hash reference consisting of the following key-value pair:
\& points = the appropriate points-definition string
\& -type = path|polygon|polyline
\& -relative = 1 (define relative position rather than absolute position)
\& -closed = 1 (close the curve - path and polygon only)
\& #generate an open path definition for a path.
\& $points = $SVG->get_path(x=>\e@x,y=>\e@y,-relative=>1,-type=>'path');
\& #add the path to the SVG document
\& my $p = $SVG->path(%$path, style=>\e%style_definition);
\& #generate an closed path definition for a a polyline.
\& $points = $SVG->get_path(
\& ); # generate a closed path definition for a polyline
\& # add the polyline to the SVG document
\& $p = $SVG->polyline(%$points, id=>'pline1');
\&\fBAliases:\fR get_path set_path
$tag = \f(CW$SVG\fR\->animate(%attributes)
Generate an \s-1SMIL\s0 animation tag. This is allowed within any nonempty tag. Refer\e
to the W3C for detailed information on the subtleties of the animate \s-1SMIL\s0
\&\fBInputs:\fR \-method = Transform | Motion | Color
\& my $an_ellipse = $SVG->ellipse(
\& cx=>30,cy=>150,rx=>10,ry=>10,id=>'an_ellipse',
\& stroke=>'rgb(130,220,70)',fill=>'rgb(30,20,50)');
\& $an_ellipse-> animate(
\& attributeName=>"cx",values=>"20; 200; 20",dur=>"10s", repeatDur=>'indefinite');
\& $an_ellipse-> animate(
\& attributeName=>"rx",values=>"10;30;20;100;50",
\& dur=>"10s", repeatDur=>'indefinite');
\& $an_ellipse-> animate(
\& attributeName=>"ry",values=>"30;50;10;20;70;150",
\& dur=>"15s", repeatDur=>'indefinite');
\& $an_ellipse-> animate(
\& attributeName=>"rx",values=>"30;75;10;100;20;20;150",
\& dur=>"20s", repeatDur=>'indefinite');
\& $an_ellipse-> animate(
\& attributeName=>"fill",values=>"red;green;blue;cyan;yellow",
\& dur=>"5s", repeatDur=>'indefinite');
\& $an_ellipse-> animate(
\& attributeName=>"fill-opacity",values=>"0;1;0.5;0.75;1",
\& dur=>"20s",repeatDur=>'indefinite');
\& $an_ellipse-> animate(
\& attributeName=>"stroke-width",values=>"1;3;2;10;5",
\& dur=>"20s",repeatDur=>'indefinite');
$tag = \f(CW$SVG\fR\->group(%attributes)
Define a group of objects with common properties. groups can have style,
animation, filters, transformations, and mouse actions assigned to them.
\& 'font' => [ qw( Arial Helvetica sans ) ],
\& transform => 'rotate(-45)'
$tag = \f(CW$SVG\fR\->defs(%attributes)
define a definition segment. A Defs requires children when defined using \s-1SVG\s0.pm
\& $tag = $SVG->defs(id => 'def_con_one',);
Sets/Adds style-definition for the following objects being created.
Style definitions apply to an object and all its children for all properties for
which the value of the property is not redefined by the child.
.IX Subsection "mouseaction"
$SVG\->mouseaction(%attributes)
Sets/Adds mouse action definitions for tag
$SVG\->attrib($name, \f(CW$value\fR)
Sets/Adds attributes of an element.
\& $SVG->attrib $name, $value
\& $SVG->attrib $name, \e@value
Set a hash attribute (i.e. style definitions):
\& $SVG->attrib $name, \e%value
\& $svg->attrib($name,undef);
\&\fBAliases:\fR attr attribute
Sets cdata to \f(CW$text\fR. \s-1SVG\s0.pm allows you to set cdata for any tag. If the tag is
meant to be an empty tag, \s-1SVG\s0.pm will not complain, but the rendering agent will
fail. In the \s-1SVG\s0 \s-1DTD\s0, cdata is generally only meant for adding text or script
\& })->cdata('SVG.pm is a perl module on CPAN!');
\& my $text = $SVG->text(style=>{'font'=>'Arial','font-size'=>20});
\& $text->cdata('SVG.pm is a perl module on CPAN!');
\& E<lt>text style="font: Arial; font-size: 20" E<gt>SVG.pm is a perl module on CPAN!E<lt>/text E<gt>
\&\s-1SEE\s0 \s-1ALSO:\s0
\& L<"CDATA"> L<"desc">, L<"title">, L<"text">, L<"script">.
\& $script = $SVG->script();
\& $script->CDATA($text);
Generates a <![CDATA[ ... ]]> tag with the contents of \f(CW$text\fR rendered exactly as supplied. \s-1SVG\s0.pm allows you to set cdata for any tag. If the tag is
meant to be an empty tag, \s-1SVG\s0.pm will not complain, but the rendering agent will
fail. In the \s-1SVG\s0 \s-1DTD\s0, cdata is generally only meant for adding text or script
\& var groups = new Array();
\& * Find this SVG's document element
\& * Define members of each group by id
\& SVGDoc = e.getTarget().getOwnerDocument();
\& append_group(1, 4, 6); // group 0
\& append_group(5, 4, 3); // group 1
\& append_group(2, 3); // group 2
\& $SVG->script()->CDATA($text);
\& var groups = new Array();
\& * Find this SVG's document element
\& * Define members of each group by id
\& SVGDoc = e.getTarget().getOwnerDocument();
\& append_group(1, 4, 6); // group 0
\& append_group(5, 4, 3); // group 1
\& append_group(2, 3); // group 2
\&\s-1SEE\s0 \s-1ALSO:\s0
\& L<"cdata">, L<"script">.
$tag = \f(CW$SVG\fR\->filter(%attributes)
Generate a filter. Filter elements contain \*(L"fe\*(R" filter sub\-elements.
\& my $filter = $SVG->filter(
\& filterUnits=>"objectBoundingBox",
\& filterUnits=>'objectBoundingBox'
\&\s-1SEE\s0 \s-1ALSO:\s0
$tag = \f(CW$SVG\fR\->fe(\-type=>'type', \f(CW%attributes\fR)
Generate a filter sub\-element. Must be a child of a \*(L"filter\*(R" element.
\& -type => 'DiffuseLighting' # required - element name omiting 'fe'
\& 'font' => [ qw(Arial Helvetica sans) ],
\& transform => 'rotate(-45)'
Note that the following filter elements are currently supported:
.IP "\(bu feColorMatrix" 4
.IP "\(bu feComponentTransfer" 4
.IX Item "feComponentTransfer"
.IP "\(bu feConvolveMatrix" 4
.IX Item "feConvolveMatrix"
.IP "\(bu feDiffuseLighting" 4
.IX Item "feDiffuseLighting"
.IP "\(bu feDisplacementMap" 4
.IX Item "feDisplacementMap"
.IP "\(bu feDistantLight" 4
.IX Item "feDistantLight"
.IP "\(bu feGaussianBlur" 4
.IX Item "feGaussianBlur"
.IP "\(bu feMorphology" 4
.IP "\(bu fePointLight" 4
.IP "\(bu feSpecularLighting" 4
.IX Item "feSpecularLighting"
.IP "\(bu feTurbulence" 4
\&\s-1SEE\s0 \s-1ALSO:\s0
$tag = \f(CW$SVG\fR\->pattern(%attributes)
Define a pattern for later reference by url.
\& my $pattern = $SVG->pattern(
\& patternUnits => "userSpaceOnUse",
\& patternContentUnits => "userSpaceOnUse"
$tag = \f(CW$SVG\fR\->set(%attributes)
Set a definition for an \s-1SVG\s0 object in one section, to be referenced in other
\& patternUnits => "userSpaceOnUse",
\& patternContentUnits => "userSpaceOnUse"
$tag = \f(CW$SVG\fR\->stop(%attributes)
Define a stop boundary for \*(L"gradient\*(R"
\& my $pattern = $SVG->stop(
\& patternUnits => "userSpaceOnUse",
\& patternContentUnits => "userSpaceOnUse"
$tag = \f(CW$SVG\fR\->gradient(%attributes)
Define a color gradient. Can be of type \fBlinear\fR or \fBradial\fR
\& my $gradient = $SVG->gradient(
.SH "GENERIC ELEMENT METHODS"
.IX Header "GENERIC ELEMENT METHODS"
The following elements are generically supported by \s-1SVG:\s0
.IP "\(bu altGlyphItem" 4
.IP "\(bu color-profile" 4
.IP "\(bu definition-src" 4
.IX Item "definition-src"
.IP "\(bu font-face-format" 4
.IX Item "font-face-format"
.IP "\(bu font-face-name" 4
.IX Item "font-face-name"
.IP "\(bu font-face-src" 4
.IP "\(bu font-face-url" 4
.IP "\(bu foreignObject" 4
.IP "\(bu missing-glyph" 4
See e.g. \*(L"pattern\*(R" for an example of the use of these methods.
projects / OpenSPARC-T2-DV / blob