WebService::WebSequenceDiagrams - Simple API for WebSequenceDiagrams
use WebService::WebSequenceDiagrams;
WebService::WebSequenceDiagrams is an API for WebSequecenDiagrams.
see detail => http://www.websequencediagrams.com/
my %args = ( style => [ 'default' | 'rose' | 'qsd' | 'napkin' | 'mscgen' | 'omegapple' | 'modern-blue' | 'earth' | 'roundgreen' ], # default is 'default' paginate => [ 0 | 1 ], # default is 1 paper => [ 'letter' | 'a4' | '11x17' ], # default is 'letter' landscape => [ 0 | 1 ], # default is 1 format => [ 'png' | 'pdf' ] # default is 'png' ); my $wsd = WebService::WebSequenceDiagrams->new(%args);
my %args = ( style => [ 'default' | 'rose' | 'qsd' | 'napkin' | 'mscgen' | 'omegapple' | 'modern-blue' | 'earth' | 'roundgreen' ], # default is 'default' paginate => [ 0 | 1 ], # default is 1 paper => [ 'letter' | 'a4' | '11x17' ], # default is 'letter' landscape => [ 0 | 1 ], # default is 1 format => [ 'png' | 'pdf' ] # default is 'png' ); my $wsd->draw( message => $message, outfile => "/path/to/save", %args, );
These methods create message text programmably.
see detail => http://www.websequencediagrams.com/examples.html
$wsd->signal( from => 'Alice', to => 'Bob', text => 'Authentication Request', line => 'solid' | 'broken', # default is 'solid' );
$wsd->signal_to_self( itself => 'Alice', text => 'This is a signal to self.\nIt also demonstrates \nmultiline \ntext.', line => 'solid' | 'broken', # default is "solid" );
$wsd->participant( name => 'Alice', as => 'A', # optionally );
$wsd->alt( text => 'successful case', );
$wsd->else( text => 'successful case', );
$wsd->opt( text => 'opt', );
$wsd->loop( text => '1000 times', );
$wsd->note( position => 'left_of' | 'right_of' | 'over', name => 'Alice' | ['Alice', 'Bob'], text => 'This is displayed left of Alice', );
Takeshi Miki <miki@cpan.org>
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install WebService::WebSequenceDiagrams, copy and paste the appropriate command in to your terminal.
cpanm
cpanm WebService::WebSequenceDiagrams
CPAN shell
perl -MCPAN -e shell install WebService::WebSequenceDiagrams
For more information on module installation, please visit the detailed CPAN module installation guide.