/ 
Bio-Phylo-0.04
River stage two • 8 direct dependents • 17 total dependents
/ Bio::Phylo::Unparsers::Svg

NAME

Bio::Phylo::Unparsers::Svg - An object-oriented module for unparsing tree objects into SVG vector drawings.

SYNOPSIS

my $svg = Bio::Phylo::Unparsers::Svg->new(%options);
my $string = $svg->build_svg();

DESCRIPTION

This module unparses a Bio::Phylo::Trees::Tree object into a scalable vector graphic.

METHODS

CONSTRUCTOR

new()
Type    : Constructor
Title   : new
Usage   : my $svg = Bio::Phylo::Unparsers::Svg->new(%args);
Function: Initializes a Bio::Phylo::Unparsers::Svg object.
Alias   :
Returns : A Bio::Phylo::Unparsers::Svg object.
Args    : none.
width()
Type    : Accessor / Mutator
Title   : width()
Usage   : $svg->width(1000);
Function: gets/sets the width of the svg canvas.
Returns :
Args    : SCALAR width in pixels.
height()
Type    : Accessor / Mutator
Title   : height()
Usage   : $svg->height(1000);
Function: gets/sets the height of the svg canvas.
Returns :
Args    : SCALAR height in pixels.
mode()
Type    : Accessor / Mutator
Title   : mode()
Usage   : $svg->mode($mode);
Function: gets/sets the tree mode, i.e. cladogram or phylogram.
Returns :
Args    : SCALAR string, [clado|phylo]
shape()
Type    : Accessor / Mutator
Title   : shape()
Usage   : $svg->shape($shape);
Function: gets/sets the tree shape, i.e. rectangular, diagonal or curvy.
Returns :
Args    : SCALAR string, [rect|diag|curvy]
padding()
Type    : Accessor / Mutator
Title   : padding()
Usage   : $svg->padding($padding);
Function: gets/sets the canvas padding.
Returns :
Args    : SCALAR value in pixels.
node_radius()
Type    : Accessor / Mutator
Title   : node_radius()
Usage   : $svg->node_radius($node_radius);
Function: gets/sets the node radius in pixels.
Returns :
Args    : SCALAR value in pixels.
text_horiz_offset()
Type    : Accessor / Mutator
Title   : text_horiz_offset()
Usage   : $svg->text_horiz_offset($text_horiz_offset);
Function: gets/sets the distance between tips and text, in pixels.
Returns :
Args    : SCALAR value in pixels.
text_vert_offset()
Type    : Accessor / Mutator
Title   : text_vert_offset()
Usage   : $svg->text_vert_offset($text_vert_offset);
Function: gets/sets the text baseline relative to the tips, in pixels.
Returns :
Args    : SCALAR value in pixels.
text_width()
Type    : Accessor / Mutator
Title   : text_width()
Usage   : $svg->text_width($text_width);
Function: gets/sets the canvas width for terminal taxon names.
Returns :
Args    : SCALAR value in pixels.
tree()
Type    : Accessor / Mutator
Title   : tree()
Usage   : $svg->tree($tree);
Function: gets/sets the Bio::Phylo::Trees::Tree object to unparse.
Returns :
Args    : A Bio::Phylo::Trees::Tree object.
_scalex()
Type    : Internal method.
Title   : _scalex()
Usage   : $svg->_scalex($scalex);
Function:
Returns :
Args    :
_scaley()
Type    : Internal method.
Title   : _scaley()
Usage   : $svg->_scaley($scaley);
Function:
Returns :
Args    :
to_string()
Type    : Unparsers
Title   : to_string()
Usage   : $svg->to_string(%options);
Function: Unparses a Bio::Phylo::Trees::Tree object into an SVG vector drawing.
Returns : SCALAR
Args    :
_x_positions()
Type    : Internal method.
Title   : _x_positions()
Usage   : $svg->_x_positions();
Function:
Returns :
Args    :
_x_positions_clado()
Type    : Internal method.
Title   : _x_positions_clado()
Usage   : $svg->_x_positions_clado();
Function:
Returns :
Args    :
_y_terminals()
Type    : Internal method.
Title   : _y_terminals()
Usage   : $svg->_y_terminals();
Function:
Returns :
Args    :
_y_internals()
Type    : Internal method.
Title   : _y_internals()
Usage   : $svg->_y_internals();
Function:
Returns :
Args    :
_classes()
Type    : Internal method.
Title   : _classes()
Usage   : $svg->_classes();
Function:
Returns :
Args    :
_to_string()
Type    : Internal method.
Title   : _to_string()
Usage   : $svg->_to_string();
Function:
Returns :
Args    :
_css()
Type    : Internal method.
Title   : _css()
Usage   : $svg->_css();
Function:
Returns :
Args    :
_timeline()
Type    : Internal method.
Title   : _timeline()
Usage   : $svg->_timeline();
Function:
Returns :
Args    :

AUTHOR

Rutger Vos, <rvosa@sfu.ca> http://www.sfu.ca/~rvosa/

BUGS

Please report any bugs or feature requests to bug-bio-phylo@rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Bio-Phylo. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

ACKNOWLEDGEMENTS

The author would like to thank Jason Stajich for many ideas borrowed from BioPerl http://www.bioperl.org, and CIPRES http://www.phylo.org and FAB* http://www.sfu.ca/~fabstar for comments and requests.

COPYRIGHT & LICENSE

Copyright 2005 Rutger Vos, All Rights Reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.