[%# # IMPORTANT NOTE # This documentation is generated automatically from source # templates. Any changes you make here may be lost. # # The 'docsrc' documentation source bundle is available for download # from http://www.template-toolkit.org/docs.html and contains all # the source templates, XML files, scripts, etc., from which the # documentation for the Template Toolkit is built. -%] [% META book = 'Modules' page = 'Plugin_GD_Graph_lines' %] [% WRAPPER toc; PROCESS tocitem title ="SYNOPSIS" subs = []; PROCESS tocitem title ="EXAMPLES" subs = []; PROCESS tocitem title ="DESCRIPTION" subs = []; PROCESS tocitem title ="AUTHOR" subs = []; PROCESS tocitem title ="VERSION" subs = []; PROCESS tocitem title ="COPYRIGHT" subs = []; PROCESS tocitem title ="SEE ALSO" subs = []; END %] [% WRAPPER section title="SYNOPSIS" -%]

        [% tt_start_tag %] USE g = GD.Graph.lines(x_size, y_size); [% tt_end_tag %]

[%- END %] [% WRAPPER section title="EXAMPLES" -%]

        [% tt_start_tag %] FILTER null;
            USE g = GD.Graph.lines(300,200);
            x = [1, 2, 3, 4];
            y = [5, 4, 2, 3];
            g.set(
                    x_label => 'X Label',
                    y_label => 'Y label',
                    title => 'Title'
            );
            g.plot([x, y]).png | stdout(1);
           END;
        -[% tt_end_tag %]

        [% tt_start_tag %] FILTER null;
            data = [
                ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug",
                                             "Sep", "Oct", "Nov", "Dec", ],
                [-5, -4, -3, -3, -1,  0,  2,  1,  3,  4,  6,  7],
                [4,   3,  5,  6,  3,1.5, -1, -3, -4, -6, -7, -8],
                [1,   2,  2,  3,  4,  3,  1, -1,  0,  2,  3,  2],
            ];

            USE my_graph = GD.Graph.lines();

            my_graph.set(
                    x_label => 'Month',
                    y_label => 'Measure of success',
                    title => 'A Simple Line Graph',

                    y_max_value => 8,
                    y_min_value => -8,
                    y_tick_number => 16,
                    y_label_skip => 2,
                    box_axis => 0,
                    line_width => 3,
                    zero_axis_only => 1,
                    x_label_position => 1,
                    y_label_position => 1,

                    x_label_skip => 3,
                    x_tick_offset => 2,

                    transparent => 0,
            );
            my_graph.set_legend("Us", "Them", "Others");
            my_graph.plot(data).png | stdout(1);
           END;
        -[% tt_end_tag %]

[%- END %] [% WRAPPER section title="DESCRIPTION" -%]

The GD.Graph.lines plugin provides an interface to the GD::Graph::lines class defined by the GD::Graph module. It allows one or more (x,y) data sets to be plotted as y versus x lines with axes and legends.

See [% ttlink('GD::Graph') -%] for more details.

[%- END %] [% WRAPPER section title="AUTHOR" -%]

Craig Barratt <craig@arraycomm.com>

The GD::Graph module was written by Martien Verbruggen.

[%- END %] [% WRAPPER section title="VERSION" -%]

1.58, distributed as part of the Template Toolkit version 2.14, released on 04 October 2004.

[%- END %] [% WRAPPER section title="COPYRIGHT" -%]

Copyright (C) 2001 Craig Barratt <craig@arraycomm.com>

GD::Graph is copyright 1999 Martien Verbruggen.

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

[%- END %] [% WRAPPER section title="SEE ALSO" -%]

[% ttlink('Template::Plugin', 'Template::Plugin') -%], [% ttlink('Template::Plugin::GD', 'Template::Plugin::GD') -%], [% ttlink('Template::Plugin::GD::Graph::lines3d', 'Template::Plugin::GD::Graph::lines3d') -%], [% ttlink('Template::Plugin::GD::Graph::bars', 'Template::Plugin::GD::Graph::bars') -%], [% ttlink('Template::Plugin::GD::Graph::bars3d', 'Template::Plugin::GD::Graph::bars3d') -%], [% ttlink('Template::Plugin::GD::Graph::points', 'Template::Plugin::GD::Graph::points') -%], [% ttlink('Template::Plugin::GD::Graph::linespoints', 'Template::Plugin::GD::Graph::linespoints') -%], [% ttlink('Template::Plugin::GD::Graph::area', 'Template::Plugin::GD::Graph::area') -%], [% ttlink('Template::Plugin::GD::Graph::mixed', 'Template::Plugin::GD::Graph::mixed') -%], [% ttlink('Template::Plugin::GD::Graph::pie', 'Template::Plugin::GD::Graph::pie') -%], [% ttlink('Template::Plugin::GD::Graph::pie3d', 'Template::Plugin::GD::Graph::pie3d') -%], [% ttlink('GD::Graph', 'GD::Graph') -%]

[%- END %]