public
Description: Extensible, Beautiful Charts for Perl
Homepage: http://www.onemogin.com/clicker/
Clone URL: git://github.com/gphat/chart-clicker.git
chart-clicker / lib / Chart / Clicker / Tutorial.pod
100644 173 lines (127 sloc) 4.46 kb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
=head1 NAME
 
Chart::Clicker::Tutorial
 
=head1 DESCRIPTION
 
This document aims to provide a tutorial for using Chart::Clicker.
 
=head1 DISCLAIMER
 
This is a work in progress. If you find errors or would like to make
contributions, drop me a line!
 
=head1 EXAMPLES
 
=head2 Simple chart from a single data source
 
# grab the needed modules
use Chart::Clicker;
use Chart::Clicker::Data::Series;
use Chart::Clicker::Data::DataSet;
 
# build the chart
my $chart = Chart::Clicker->new;
 
# build the series (static here, will usually be supplied arrayrefs from elsewhere)
my $series = Chart::Clicker::Data::Series->new(
keys => [ 1,2,3,4,5 ],
values => [ 52,74,52,82,14 ],
);
 
# build the dataset
my $dataset = Chart::Clicker::Data::DataSet->new(
series => [ $series ],
);
 
# add the dataset to the chart
$chart->add_to_datasets($dataset);
 
# draw and write the chart to a file
$chart->draw;
$chart->write('chart.png');
 
=head2 Simple chart from multiple data sources
 
use Chart::Clicker;
use Chart::Clicker::Data::Series;
use Chart::Clicker::Data::DataSet;
 
my $chart = Chart::Clicker->new;
 
# start an array that will hold the series data
    my $series1 = Chart::Clicker::Data::Series->new(
keys => [ 1,2,3,4,5 ],
values => [ 52,74,52,82,14 ]
);
    my $series2 = Chart::Clicker::Data::Series->new(
keys => [ 1,2,3,4,5 ],
values => [ 34,67,89,45,67 ]
);
 
# add the array of series data to the dataset
my $dataset = Chart::Clicker::Data::DataSet->new(
series => [ $series1, $series2 ]
);
 
$chart->add_to_datasets($dataset);
 
$chart->draw;
$chart->write('chart.png');
 
=head2 Simple chart with multiple data sources and custom colors
 
use Chart::Clicker;
use Chart::Clicker::Data::Series;
use Chart::Clicker::Data::DataSet;
# some new modules, these are only needed if you want to monkey with color changing
use Graphics::Color::RGB;
use Chart::Clicker::Drawing::ColorAllocator;
 
# build the color allocator
my $ca = Chart::Clicker::Drawing::ColorAllocator->new;
# this hash is simply here to make things readable and cleaner, you can always call G::C::R inline
my $red => Graphics::Color::RGB->new({
red =>.75, green =>0, blue =>0, alpha =>.8
});
my $green => Graphics::Color::RGB->new({
red => 0,green => .75, blue=> 0, alpha=>.8
});
my $blue => Graphics::Color::RGB->new({
red => 0, green => 0, blue => .75, alpha => .8
}),
 
my $chart = Chart::Clicker->new;
 
    # Create an empty dataset that we can add to
my $dataset = Chart::Clicker::Data::DataSet->new;
 
$dataset->add_to_series(Chart::Clicker::Data::Series->new(
keys => [ 1,2,3,4,5 ],
values => [ 52,74,52,82,14 ]
    ));
    # add a color - note that the order of colors and the order of the
# series must match, the first series will use the first color and so on
# see contexts and axes for alternate ways of doing this
$ca->add_to_colors($blue);
 
$dataset->add_to_series(Chart::Clicker::Data::Series->new(
keys => [ 1,2,3,4,5 ],
values => [ 34,67,89,45,67 ],
));
# add a second color
$ca->add_to_colors($colorset{red});
 
$dataset->add_to_series(Chart::Clicker::Data::Series->new(
keys => [ 1,2,3,4,5 ],
values => [ 11,22,33,44,55 ],
));
# add a third color
$ca->add_to_colors($colorset{green});
 
$chart->add_to_datasets($dataset);
 
# assign the color allocator to the chart
$chart->color_allocator($ca);
 
$chart->draw;
$chart->write('chart.png');
 
=head2 Example 4 : Simple chart with a different render type
 
    use Chart::Clicker;
    use Chart::Clicker::Data::Series;
    use Chart::Clicker::Data::DataSet;
    # add in the module of the renerer(s) you want to use
    use Chart::Clicker::Renderer::Area;
 
    my $chart=Chart::Clicker->new;
 
    my $series=Chart::Clicker::Data::Series->new(
        keys => [ 1,2,3,4,5 ],
        values => [ 52,74,52,82,14 ]
    );
 
    my $dataset = Chart::Clicker::Data::DataSet->new(
        series => [ $series ]
    );
 
    $chart->add_to_datasets($dataset);
 
# build the renderer to use
my $renderer = Chart::Clicker::Renderer::Area->new(
opacity => .75,
);
 
# assign the renderer to the default context
$chart->get_context('default')->renderer($renderer);
 
    $chart->draw;
    $chart->write('chart.png');
 
=head1 AUTHOR
 
Cory G Watson <gphat@cpan.org>
 
=head1 CONTRIBUTORS
 
Steve Bradford
 
=head1 LICENSE
 
You can redistribute and/or modify this code under the same terms as Perl
itself.