Skip to content

michal-josef-spacek/PYX-GraphViz

Repository files navigation

NAME
    PYX::GraphViz - GraphViz output for PYX handling.

SYNOPSIS
     use PYX::GraphViz;

     my $obj = PYX::GraphViz->new(%parameters);
     $obj->parse($pyx, $out);
     $obj->parse_file($input_file, $out);
     $obj->parse_handler($input_file_handler, $out);

METHODS
    "new(%parameters)"
            Constructor

            *       "colors"

                     Colors.
                     Default value is {
                             'a' => 'blue',
                             'blockquote' => 'orange',
                             'br' => 'orange',
                             'div' => 'green',
                             'form' => 'yellow',
                             'html' => 'black',
                             'img' => 'violet',
                             'input' => 'yellow',
                             'option' => 'yellow',
                             'p' => 'orange',
                             'select' => 'yellow',
                             'table' => 'red',
                             'td' => 'red',
                             'textarea' => 'yellow',
                             'tr' => 'red',
                             '*' => 'grey',
                     }

            *       "height"

                     GraphViz object height.
                     Default value is 10.

            *       "layout"

                     GraphViz layout.
                     Default value is 'neato'.

            *       "node_height"

                     GraphViz object node height.
                     Default value is 0.3.

            *       "output_handler"

                     Output handler.
                     Default value is \*STDOUT.

            *       "width"

                     GraphViz object width.
                     Default value is 10.

    "parse($pyx[, $out])"
             Parse PYX text or array of PYX text.
             If $out not present, use 'output_handler'.
             Returns undef.

    "parse_file($input_file[, $out])"
             Parse file with PYX data.
             If $out not present, use 'output_handler'.
             Returns undef.

    "parse_handler($input_file_handler[, $out])"
             Parse PYX handler.
             If $out not present, use 'output_handler'.
             Returns undef.

ERRORS
     new():
            Bad color define for '*' elements.
            From Class::Utils::set_params():
                    Unknown parameter '%s'.

EXAMPLE
     use strict;
     use warnings;

     use PYX::GraphViz;

     # Example PYX data.
     my $pyx = <<'END';
     (html
     (head
     (title
     -Title
     )title
     )head
     (body
     (div
     -data
     )div
     )body
     END

     # Object.
     my $obj = PYX::GraphViz->new;

     # Parse.
     $obj->parse($pyx);

     # Output
     # PNG data

DEPENDENCIES
    Class::Utils, Error::Pure, GraphViz, PYX::Parser.

SEE ALSO
    Task::PYX
        Install the PYX modules.

REPOSITORY
    <https://github.com/michal-josef-spacek/PYX-GraphViz>

AUTHOR
    Michal Josef Špaček <mailto:skim@cpan.org>

    <http://skim.cz>

LICENSE AND COPYRIGHT
    © 2011-2023 Michal Josef Špaček

    BSD 2-Clause License

VERSION
    0.07

About

GraphViz output for PYX handling.

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published

Languages