Dave Rolsky > Chart-OFC > Chart::OFC::Grid

Download:
Chart-OFC-0.12.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

New  1
Open  1
View/Report Bugs
Module Version: 0.12   Source  

NAME ^

Chart::OFC::Grid - A grid chart

VERSION ^

version 0.12

SYNOPSIS ^

    my $bars = Chart::OFC::Dataset::Bar->new( values => [ 1 .. 5 ] );
    my $line = Chart::OFC::Dataset::Line->new( values => [ 2 .. 7 ] );

    my $x_axis = Chart::OFC::XAxis->new( axis_label => 'X Axis' );
    my $y_axis = Chart::OFC::YAxis->new(
        axis_label  => 'Y Axis',
        max         => 10,
        label_steps => 2
    );

    my $grid = Chart::OFC::Grid->new(
        title    => 'My Grid Chart',
        datasets => [ $bars, $line ],
        x_axis   => $x_axis,
        y_axis   => $y_axis,
    );

DESCRIPTION ^

This class represents a grid chart. A grid chart can contain any combination of bars, lines, and area lines.

It also has an X and a Y axis.

ATTRIBUTES ^

This class is a subclass of Chart::OFC and accepts all of that class's attribute. It has several attributes of its own which may be passed to the new() method.

datasets

This should be an array reference containing at least one dataset. The datasets can be of any type except Class::OFC::Dataset (the base class). Instead, they must be objects of some Dataset subclass.

This attribute is required.

x_axis

This should be a Chart::OFC::XAxis object.

This attribute is required.

y_axis

This should be a Chart::OFC::YAxis object.

This attribute is required.

inner_bg_color

The background color for just the chart itself, as opposed to the surrounding text.

This attribute is optional.

inner_bg_color2

If this is provided, then OFC will implement a fade between the two inner background colors. If you provide this you must also provide an inner_bg_fade_angle attribute.

This attribute is optional.

inner_bg_fade_angle

A number from 0 to 359 specifying the angle of the fade between the two background colors. If you provide this you must also provide two inner background colors.

This attribute is optional.

ROLES ^

This class does the Chart::OFC::Role::OFCDataLines role.

AUTHOR ^

Dave Rolsky <autarch@urth.org>

COPYRIGHT AND LICENSE ^

This software is Copyright (c) 2014 by Dave Rolsky.

This is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)
syntax highlighting: