Tk::Chart::Areas - Extension of Canvas widget to create area lines graph.
#!/usr/bin/perl use strict; use warnings; use Tk; use Tk::Chart::Areas; my $mw = MainWindow->new( -title => 'Tk::Chart::Areas example', -background => 'white', ); my $chart = $mw->Areas( -title => 'My Area graph title', -xlabel => 'X Label', -ylabel => 'Y Label', -linewidth => 1, )->pack(qw / -fill both -expand 1 /); my @data = ( ['1st','2nd','3rd','4th','5th','6th','7th', '8th', '9th'], [ 5, 12, 24, 33, 19, 8, 6, 15, 21], [ -1, -2, -5, -6, -3, 1.5, 1, 1.3, 2] ); # Add a legend to the graph my @Legends = ( 'legend 1', 'legend 2', ); $chart->set_legend( -title => 'Title legend', -data => \@Legends, -titlecolors => 'blue', ); # Add help identification $chart->set_balloon(); # Create the graph $chart->plot( \@data ); MainLoop();
Tk::Chart::Areas is an extension of the Canvas widget. It is an easy way to build an interactive Area line graph into your Perl Tk widget. The module is written entirely in Perl/Tk.
You can set a background gradient color.
You can change the color, font of title, labels (x and y) of the graph. You can set an interactive legend. The axes can be automatically scaled or set by the code. With this module it is possible to plot quantitative variables according to qualitative variables.
When the mouse cursor passes over a plotted line or its entry in the legend, the line and its entry will be turned to a color (that you can change) to help identify it.
You can set a background gradient color by using all methods of Tk::Canvas::GradientColor. By default, it is not enabled.
To enabled background gradient color the first time, you firstly have to call enabled_gradientcolor method and configure your color and type of gradient with set_gradientcolor.
$chart->enabled_gradientcolor(); $chart->set_gradientcolor( -start_color => '#6585ED', -end_color => '#FFFFFF', );
Please, read "WIDGET-SPECIFIC METHODS" in Tk::Canvas::GradientColor documentation to know all available configurations.
-background -borderwidth -closeenough -confine -cursor -height -highlightbackground -highlightcolor -highlightthickness -insertbackground -insertborderwidth -insertofftime -insertontime -insertwidth -relief -scrollregion -selectbackground -selectborderwidth -selectforeground -takefocus -width -xscrollcommand -xscrollincrement -yscrollcommand -yscrollincrement
If set to true value, we will see area sections separate by dash lines.
-viewsection => 0, # 0 or 1
Default : 1
Change color of border areas.
-outlinearea => 'blue',
Default : 'black'
See "WIDGET-SPECIFIC OPTIONS" in Tk::Chart::Lines
The Canvas method creates a widget object. This object supports the configure and cget methods described in Tk::options which can be used to enquire and modify the options described above.
This method allows you to add data in your graph. If you have already plot data using plot method and if you want to add new data, you can use this method. Your graph will be updade.
Data array reference
Fill an array of arrays with the values of the datasets (\@data). Make sure that every array has the same size, otherwise Tk::Chart::Lines will complain and refuse to compile the graph.
my @NewData = (1,10,12,5,4); $chart->add_data(\@NewData);
If your last graph has a legend, you have to add a legend entry for the new dataset. Otherwise, the legend graph will not be display (see below).
$legend
my @NewData = (1,10,12,5,4); my $legend = 'New data set'; $chart->add_data(\@NewData, $legend);
This method allows you to clear the graph. The canvas will not be destroy. It's possible to redraw your last graph using the redraw method.
If you call this method, you disable help identification which has been enabled with set_balloon method.
When the graph is created and the widget size changes, the graph is automatically re-created. Call this method to avoid resizing.
$chart->disabled_automatic_redraw;
To plot the value of data near the points area graph, call this method to control in a generic manner.
my @data_point_value = ( [ 9, 2, 5, 6, 3, 1, 1, 3, 4 ], # The first line data undef, # The second line data [ 'A', 'B', undef, 'D', 'E', 'F', 'G', 'H', undef ], # The third line data ); $chart->display_values( \@data_point_value );
In this example, values are added above each point of the first and third lines. The second line is undef, no values are printed in the graph. B value is printed above the second point of the third line data.
Use this method to allow your graph to be recreated automatically when the widget size change. When the graph is created for the first time, this method is called.
$chart->enabled_automatic_redraw;
To display your graph the first time, plot the graph by using this method.
\@data
Fill an array of arrays with the x values and the values of the datasets (\@data). Make sure that every array have the same size, otherwise Tk::Chart::Areas will complain and refuse to compile the graph.
my @data = ( [ '1st', '2nd', '3rd', '4th', '5th', '6th', '7th', '8th', '9th' ], [ 1, 2, 5, 6, 3, 1.5, 1, 3, 4 ], [ 4, 2, 5, 2, 3, 5.5, 7, 9, 4 ], [ 1, 2, 52, 6, 3, 17.5, 1, 43, 10 ] );
@data have to contain a least two arrays, the x values and the values of the datasets.
If you don't have a value for a point in a dataset, you can use undef, and the point will be skipped.
[ 1, undef, 5, 6, 3, 1.5, undef, 3, 4 ]
-substitutionvalue => real number,
If you have a no real number value in a dataset, it will be replaced by a constant value.
Default : 0
my @data = ( [ '1st', '2nd', '3rd', '4th', '5th', '6th', '7th', '8th', '9th' ], [ 1, '--', 5, 6, 3, 1.5, 1, 3, 4 ], [ 'mistake', 2, 5, 2, 3, 'NA', 7, 9, 4 ], [ 1, 2, 52, 6, 3, 17.5, 1, 43, 4 ], ); $chart->plot( \@data, -substitutionvalue => '12', ); # mistake, -- and NA will be replace by 12
-substitutionvalue have to be a real number (ex : 12, .25, 02.25, 5.2e+11, etc ...)
\@data_to_display
Fill an array of arrays with the values of the data to display (\@data_to_display).
my @data_to_display = ( [ 10, 30, 20, 30, 5, 41, 1, 23 ], [ 'A', 'B', 'C', 'D', 'E', 5.5, 'F', 'G', 4 ], [ 4, 'CPAN', 52, 6, 3, 17.5, 1, 43, 10 ] );
If you does not want to display a value for a point, you can use undef, and the point value will be skipped.
-foreground => color,
Set color of text value.
Default : black
-font => string,
Set the font to text value.
-font => 'Times 12 {bold}',
Redraw the graph.
If you have used clearchart for any reason, it is possible to redraw the graph. Tk::Chart::Areas supports the configure and cget methods described in the Tk::options manpage. If you use configure method to change a widget specific option, the modification will not be display. If the graph was already displayed and if you not resize the widget, call redraw method to resolv the bug.
... $mw->Button( -text => 'Change xlabel', -command => sub { $chart->configure(-xlabel => 'red'); }, )->pack; ... # xlabel will be changed but not displayed if you not resize the widget. ... $mw->Button( -text => 'Change xlabel', -command => sub { $chart->configure(-xlabel => 'red'); $chart->redraw; } )->pack; ... # OK, xlabel will be changed and displayed without resize the widget.
If you call this method, you enable help identification. When the mouse cursor passes over a plotted line or its entry in the legend, the line and its entry will be turn into a color (that you can change) to help the identification. set_legend method must be set if you want to enabled identification.
-background => string
Set a background color for the balloon.
-background => 'red',
Default : snow
-colordatamouse => Array reference
Specify an array reference wich contains 2 colors. The first color specifies the color of the line when mouse cursor passes over an entry in the legend. If the line has the same color, the second color will be used.
-colordatamouse => ['blue', 'green'],
Default : -colordatamouse => [ '#7F9010', '#CB89D3' ]
-morepixelselected => integer
When the mouse cursor passes over an entry in the legend, the line width increase.
-morepixelselected => 5,
Default : 2
View a legend for the graph and allow to enabled identification help by using set_balloon method.
-title => string
Set a title legend.
-title => 'My title',
Default : undef
-titlecolors => string
Set a color to legend text.
-titlecolors => 'red',
-titlefont => string
Set the font to legend title text.
-titlefont => '{Arial} 8 {normal}',
Default : {Times} 8 {bold}
-legendcolor => color
Color of legend text.
-legendcolor => 'white',
-legendfont => string
Set the font to legend text.
-legendfont => '{Arial} 8 {normal}',
Default : {Times} 8 {normal}
-box => boolean
Set a box around all legend.
-box => 1, # or 0
-legendmarkerheight => integer
Change the heigth of marker for each legend entry.
-legendmarkerheight => 5,
Default : 10
-legendmarkerwidth => integer
Change the width of marker for each legend entry.
-legendmarkerwidth => 5,
-heighttitle => integer
Change the height title legend space.
-heighttitle => 75,
Default : 30
$chart->zoom(integer);
Zoom the graph. The x-axis and y-axis will be zoomed. If your graph has a 300*300 size, after a zoom(200), the graph will have a 600*600 size.
$chart->zoom(50); # size divide by 2 => 150*150 ... $chart->zoom(200); # size multiplie by 2 => 600*600 ... $chart->zoom(120); # 20% add in each axis => 360*360 ... $chart->zoom(100); # original resize 300*300.
Zoom the graph the x-axis.
# original canvas size 300*300 $chart->zoomx(50); # new size : 150*300 ... $chart->zoom(100); # new size : 300*300
Zoom the graph the y-axis.
# original canvas size 300*300 $chart->zoomy(50); # new size : 300*150 ... $chart->zoom(100); # new size : 300*300
In the demo directory, you have a lot of script examples with their screenshot. See also the http://search.cpan.org/dist/Tk-Chart/MANIFEST web page of Tk::Chart.
See Tk::Canvas for details of the standard options.
See Tk::Chart, Tk::Chart::FAQ, GD::Graph.
Djibril Ousmanou, <djibel at cpan.org>
<djibel at cpan.org>
Please report any bugs or feature requests to bug-Tk-Chart at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Tk-Chart. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
bug-Tk-Chart at rt.cpan.org
You can find documentation for this module with the perldoc command.
perldoc Tk::Chart::Areas
You can also look for information at:
RT: CPAN's request tracker
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Tk-Chart
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/Tk-Chart
CPAN Ratings
http://cpanratings.perl.org/d/Tk-Chart
Search CPAN
http://search.cpan.org/dist/Tk-Chart/
Copyright 2011 Djibril Ousmanou, all rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install Tk::Chart, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Tk::Chart
CPAN shell
perl -MCPAN -e shell install Tk::Chart
For more information on module installation, please visit the detailed CPAN module installation guide.