The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Stepford::Grapher::Renderer::Graphviz - Render to a graph using GraphViz

VERSION

version 1.01

SYNOPSIS

   my $grapher = Stepford::Grapher->new(
       step  => 'My::Step::ExampleStep',
       step_namespaces => ['My::Steps'],
       renderer => Stepford::Grapher::Renderer::Graphiz->new(
           output => 'diagram.png',
       ),
   );
   $grapher->run;

DESCRIPTION

Renders the graph using GraphViz.

ATTRIBUTES

output

A string containing the filename that the rendered graph should be written to. By default this is undef, rendering the output to STDOUT.

format

The format the graph should be written in (jpg, png, pdf, etc.) You may use the special format src or dot to indicate that you want simple dot source code (for manually feeding into Graphviz) output rather than having the rendering done for you.

By default the format is determined from the output file extension if there is one. If one cannot be determined (either because the output attribute is undefined or the filename does not have an extension) then format will default to src.

METHOD

$renderer->render()

Renders the output.

SUPPORT

Bugs may be submitted through https://github.com/maxmind/Stepford-Grapher/issues.

AUTHOR

Mark Fowler <mfowler@maxmind.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2016 - 2017 by MaxMind, Inc..

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