NAME

Graph::Easy::Marpa::Renderer::GraphViz2 - This is the default rendering engine for Graph::Easy::Marpa

Synopsis

See "Synopsis" in Graph::Easy::Marpa.

Description

Graph::Easy::Marpa::Renderer provides a GraphViz2-based renderer for Graph::Easy-style graph definitions.

This module is the default rendering engine for Graph::Easy::Marpa.

Installation

Install Graph::Easy::Marpa as you would for any Perl module:

Run:

        cpanm Graph::Easy::Marpa

or run:

        sudo cpan Graph::Easy::Marpa

or unpack the distro, and then either:

        perl Build.PL
        ./Build
        ./Build test
        sudo ./Build install

or:

        perl Makefile.PL
        make (or dmake or nmake)
        make test
        make install

Constructor and Initialization

new() is called as my($parser) = Graph::Easy::Marpa::Renderer::GraphViz2 -> new(k1 => v1, k2 => v2, ...).

It returns a new object of type Graph::Easy::Marpa::Renderer::GraphViz2.

Key-value pairs accepted in the parameter list (see corresponding methods for details [e.g. maxlevel()]):

o (None)

Methods

run(%arg)

Renders a set of items as an image, using GraphViz2.

Keys and values in %arg are:

o format => $format

The format (e.g. 'svg') to pass to the rendering engine.

o items => $arrayref

This arrayref, passed from Graph::Easy::Marpa::Parser is the result of lexing and parsing the Graph::Easy-style graph definition (raw) file.

Each element of this arrayref is a hashref with these key-value pairs:

o count => $integer

o name => $string

o type => $string

o value => $string

o output_file => $file_name

This is where the output of 'dot' will be written.

Machine-Readable Change Log

The file CHANGES was converted into Changelog.ini by Module::Metadata::Changes.

Version Numbers

Version numbers < 1.00 represent development versions. From 1.00 up, they are production versions.

Support

Email the author, or log a bug on RT:

https://rt.cpan.org/Public/Dist/Display.html?Name=Graph::Easy::Marpa.

Author

Graph::Easy::Marpa was written by Ron Savage <ron@savage.net.au> in 2011.

Home page: http://savage.net.au/index.html.

Copyright

Australian copyright (c) 2011, Ron Savage.

        All Programs of mine are 'OSI Certified Open Source Software';
        you can redistribute them and/or modify them under the terms of
        The Artistic License, a copy of which is available at:
        http://www.opensource.org/licenses/index.html

cpanm Graph::Easy::Marpa

perl -MCPAN -e shell
install Graph::Easy::Marpa