Jess Robinson > Graph-Writer-TGXML > Graph::Writer::TGXML

Download:
Graph-Writer-TGXML-0.01.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.01   Source  

NAME ^

Graph::Writer::TGXML - write out directed graph as TouchGraph LinkBrowser XML

SYNOPSIS ^

    use Graph;
    use Graph::Writer::TGXML;
    
    $graph = Graph->new();
    # add edges and nodes to the graph
    
    $writer = Graph::Writer::TGXML->new();
    $writer->write_graph($graph, 'mygraph.xml');

DESCRIPTION ^

Graph::Writer::TGXML is a class for writing out a directed graph in a format suitable for use with TouchGraph's LinkBrowser. The graph must be an instance of the Graph class, which is actually a set of classes developed by Jarkko Hietaniemi.

The XML format contains Nodes and Edges. For nodes, the label, URL and tooltip attributes are used, for label, url and hint respectively. For edges, no attributes are currently used.

METHODS ^

new()

Constructor - generate a new writer instance.

    $writer = Graph::Writer::TGXML->new();

This doesn't take any arguments.

write_graph()

Write a specific graph to a named file:

    $writer->write_graph($graph, $file);

The $file argument can either be a filename, or a filehandle for a previously opened file.

KNOWN BUGS ^

TODO ^

Allow users to supply colours, node locations, hint box sizes, and edge lengths.

SEE ALSO ^

XML::Writer

The perl module used to actually write out the XML. It handles entities etc.

Graph

Jarkko Hietaniemi's modules for representing directed graphs, available from CPAN under modules/by-module/Graph/

Algorithms in Perl

The O'Reilly book which has a chapter on directed graphs, which is based around Jarkko's modules.

Graph::Writer

The base-class for Graph::Writer::XML

TouchGraph

A java software to navigate through directed graphs. http://www.touchgraph.com

AUTHOR ^

Jess Robinson <jrobinson@desert-island.demon.co.uk>

COPYRIGHT ^

Copyright (c) 2004, 2005, Jess Robinson. All rights reserved.

This script is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: