/ 
Map-Tube-Plugin-Graph-0.02
River stage one • 1 direct dependent • 1 total dependent
/ Map::Tube::Plugin::Graph

NAME

Map::Tube::Plugin::Graph - Graph plugin for Map::Tube.

VERSION

Version 0.02

DESCRIPTION

It is a plugin for Map::Tube to create map of individual lines. This should not be used directly. The support for the plugin is defined in Map::Tube. If installed then Map::Tube should take care of it. There is a method as_image() defined in the package Map::Tube, which is just a very thin wrapper around the plugin.

See the method as_image() defined in the package Map::Tube for more details.

SYNOPSIS

use strict; use warnings;
use MIME::Base64;
use Map::Tube::London;

my $tube = Map::Tube::London->new;
my $line = 'Jubilee';

open($IMAGE, ">$line.png");
print $IMAGE decode_base64($tube->as_image($line));
close($IMAGE);

INSTALLATION

The plugin primarily depends on GraphViz2 library. But the GraphViz2 can only be installed if the perl v5.014002 is installed. If your perl environment satisfies this requirement then ignore the rest of instructions.

However I managed to install GraphViz2 on my box with perl v5.10.1. It requires a bit of nasty hack. If you are willing to do then follow the steps below:

  • Downnload the tar ball from CPAN. e.g. wget http://search.cpan.org/CPAN/authors/id/R/RS/RSAVAGE/GraphViz2-2.34.tgz

  • Extract the tar ball i.e. tar -xvzf GraphViz2-2.34.tgz

  • Change directory to GraphViz2-2.34 i.e. cd GraphViz2-2.34

  • Edit the Makefile.PL and comment the line (no: 11) that says: require 5.014002; # For the utf8 stuff.

  • Now follow the usual command to make/test/install. If it complains about missing package then install it on demand one at a time.

CONSTRUCTOR

The constructor can have the keys from the table below. You wouldn't need to know anyway. The package Map::Tube is doing everything for you.

+-----------+----------+---------- +---------------------------------------------+
| Key       | Required | Default |  Description                                  |
+-----------+----------+---------+-----------------------------------------------+
| tube      | Yes      | -       | Object of package with the role L<Map::Tube>. |
| line      | Yes      | -       | Object of type L<Map::Tube::Line>.            |
| color     | No       | black   | Edge color outside of the Line.               |
| shape     | No       | oval    | Node shape.                                   |
| directed  | No       | 1       | Graph direction.                              |
| arrowsize | No       | 1       | Graph arrowsize.                              |
| labelloc  | No       | top     | Graph label location.                         |
+-----------+----------+---------+-----------------------------------------------+

METHODS

as_image()

Returns image as base64 encoded string.

tube($tube)

Sets the attribute 'tube', an object of package with the role Map::Tube.

tube()

Returns the attribute 'tube'.

line($line)

Sets the attribute 'line', an object of type Map::Tube::Line.

line()

Returns the attribute 'line'.

AUTHOR

Mohammad S Anwar, <mohammad.anwar at yahoo.com>

REPOSITORY

https://github.com/Manwar/Map-Tube-Plugin-Graph

SEE ALSO

BUGS

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

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Map::Tube::Plugin::Graph

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright (C) 2015 Mohammad S Anwar.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License.By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you,you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement,then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.