Tk::ForDummies::Graph::Lines - Extension of Canvas widget to create a line graph.
#!/usr/bin/perl use strict; use warnings; use Tk; use Tk::ForDummies::Graph::Lines; my $mw = new MainWindow( -title => 'Tk::ForDummies::Graph::Lines example', -background => 'white', ); my $GraphDummies = $mw->Lines( -title => 'My graph title', -xlabel => 'X Label', -ylabel => 'Y Label', )->pack(qw / -fill both -expand 1 /); 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 ] ); # Add a legend to the graph my @Legends = ( 'legend 1', 'legend 2', 'legend 3' ); $GraphDummies->set_legend( -title => 'Title legend', -data => \@Legends, -titlecolors => 'blue', ); # Add help identification $GraphDummies->set_balloon(); # Create the graph $GraphDummies->plot( \@data ); MainLoop();
Tk::ForDummies::Graph::Lines is an extension of the Canvas widget. It is an easy way to build an interactive line graph into your Perl Tk widget. The module is written entirely in Perl/Tk.
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 use 3 methods to zoom (vertically, horizontally or both).
-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
Many options allow you to configure your graph as you want. The default configuration is already OK, but you can change it.
use -dash canvas option, see Tk::Canvas.
-dash => '.',
Default : undef
Title of your graph.
-title => 'My graph title',
Position of title : center, left or right
-titleposition => 'left',
Default : center
Title color of your graph.
-titlecolor => 'red',
Default : black
Set the font for the title text. See also textfont option.
-titlefont => 'Times 15 {normal}',
Default : {Times} 12 {bold}
Height for title graph space.
-titleheight => 100,
Default : 40
The label to be printed just below the x axis.
-xlabel => 'X label',
Set x label color. See also textcolor option.
-xlabelcolor => 'red',
Set the font for the x label text. See also textfont option.
-xlabelfont => 'Times 15 {normal}',
Default : {Times} 10 {bold}
Height for x label space.
-xlabelheight => 50,
Default : 30
Print every xlabelskip number under the tick on the x axis. If you have a dataset wich contain many points, the tick and x values will be overwrite on the graph. This option can help you to clarify your graph. Eg:
# ['leg1', 'leg2', ...'leg1000', 'leg1001', ... 'leg2000'] => There are 2000 ticks and text values on x axis. -xlabelskip => 1 => ['leg1', 'leg3', 'leg5', ...] # => 1000 ticks will be display.
See also -xvaluesregex option.
-xlabelskip => 2,
Default : 0
Set x values colors. See also textcolor option.
-xvaluecolor => 'red',
Width for x values space.
-xvaluespace => 50,
View values on x axis.
-xvalueview => 0, # 0 or 1
Default : 1
View the x values which will match with regex. It allows you to display tick on x axis and values that you want. You can combine it with -xlabelskip to display many dataset.
... ['leg1', 'leg2', 'data1', 'data2', 'symb1', 'symb2'] ... -xvaluesregex => qr/leg/i,
On the graph, just leg1 and leg2 will be display.
Default : qr/.+/
The labels to be printed next to y axis.
-ylabel => 'Y label',
Set the color of y label. See also textcolor option.
-ylabelcolor => 'red',
Set the font for the y label text. See also textfont option.
-ylabelfont => 'Times 15 {normal}',
Width of space for y label.
-ylabelwidth => 30,
Default : 5
Set the color of y values. See also valuecolor option.
-yvaluecolor => 'red',
View values on y axis.
-yvalueview => 0, # 0 or 1
Combine xlabelcolor and ylabelcolor options. See also textcolor option.
-labelscolor => 'red',
Set the color of x, y values in axis. It combines xvaluecolor and yvaluecolor options.
-valuescolor => 'red',
Set the color of x, y labels and title text. It combines titlecolor, xlabelcolor and ylabelcolor options.
-textcolor => 'red',
Set the font of x, y labels and title text. It combines titlefont, xlabelfont and ylabelfont options.
-textfont => 'Times 15 {normal}',
Draw the axes as a box.
-boxaxis => 0, # 0 or 1
If long_ticks is a true value, ticks will be drawn the same length as the axes.
-longticks => 1, # 0 or 1
Hide the axis with ticks and values ticks.
-noaxis => 1, # 0 or 1
If set to a true value, the axis for y values will only be drawn. This might be useful in case your graph contains negative values, but you want it to be clear where the zero value is. (see also zeroaxisonly and boxaxis).
-zeroaxis => 1, # 0 or 1
If set to a true value, the zero x axis will be drawn and no axis at the bottom of the graph will be drawn. The labels for X values will be placed on the zero x axis. This works if there is at least one negative value in dataset.
-zeroaxisonly => 1, # 0 or 1
Set height of all x ticks.
-xtickheight => 10,
View x ticks of graph.
-xtickview => 0, # 0 or 1
Number of ticks to print for the Y axis.
-yticknumber => 10,
Default : 4
Set width of all y ticks.
-ytickwidth => 10,
View y ticks of graph.
-ytickview => 0, # 0 or 1
View all ticks of graph. Combines xtickview and ytickview options.
-alltickview => 0, # 0 or 1
Set width of all lines graph of dataset.
-linewidth => 10,
This controls the colors of the lines. This should be a reference to an array of color names.
-colordata => [ qw(green pink blue cyan) ],
Default :
[ 'red', 'green', 'blue', 'yellow', 'purple', 'cyan', '#996600', '#99A6CC', '#669933', '#929292', '#006600', '#FFE100', '#00A6FF', '#009060', '#B000E0', '#A08000', 'orange', 'brown', 'black', '#FFCCFF', '#99CCFF', '#FF00CC', '#FF8000', '#006090', ],
The default array contains 24 colors. If you have more than 24 samples, the next line will have the color of the first array case (red).
To create lines graph as Bézier curve. The curve crosses only by the extreme points (the first and the last).
-bezier => 1, # 0 or 1
To create lines graph as Bézier curve. The curve crosses by all points. The -bezier option has to be set to 1.
-spline => 1, # 0 or 1
These options are specific to point lines graph creation.
Set a true value to create point lines graph.
-pointline => 1, # 0 or 1
The size of the markers used in points graphs, in pixels.
-markersize => 10, # integer
Default : 8
This controls the order of markers in points graphs. This should be a reference to an array of numbers:
-markers => [3, 5, 6], Available markers are: 1: filled square 2: open square 3: horizontal cross 4: diagonal cross 5: filled diamond 6: open diamond 7: filled circle 8: open circle 9: horizontal line 10: vertical line
Default : [1,2,3,4,5,6,7,8] Note that the last two are not part of the default list.
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::ForDummies::Graph::Lines will complain and refuse to compile the graph.
my @NewData = (1,10,12,5,4); $GraphDummies->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'; $GraphDummies->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.
$GraphDummies->disabled_automatic_redraw;
To plot the value of data near the points line 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 ); $GraphDummies->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.
$GraphDummies->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::ForDummies::Graph::Lines 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.
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 ], ); $GraphDummies->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.
-font => string,
Set the font to text value.
-font => 'Times 12 {bold}',
Redraw the graph.
If you have used cleargraph for any reason, it is possible to redraw the graph. Tk::ForDummies::Graph::Lines 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.
... $fenetre->Button(-text => 'Change xlabel', -command => sub { $GraphDummies->configure(-xlabel => 'red'); } )->pack; ... # xlabel will be changed but not displayed if you not resize the widget. ... $fenetre->Button( -text => 'Change xlabel', -command => sub { $GraphDummies->configure( -xlabel => 'red' ); $GraphDummies->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',
-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}
-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 => 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,
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.
$GraphDummies->zoom($zoom);
$zoom must be an integer great than 0.
$GraphDummies->zoom(50); # size divide by 2 => 150*150 ... $GraphDummies->zoom(200); # size multiplie by 2 => 600*600 ... $GraphDummies->zoom(120); # 20% add in each axis => 360*360 ... $GraphDummies->zoom(100); # original resize 300*300.
zoom the graph the x axis.
# original canvas size 300*300 $GraphDummies->zoomx(50); # new size : 150*300 ... $GraphDummies->zoom(100); # new size : 300*300
zoom the graph the y axis.
# original canvas size 300*300 $GraphDummies->zoomy(50); # new size : 300*150 ... $GraphDummies->zoom(100); # new size : 300*300
Djibril Ousmanou, <djibel at cpan.org>
<djibel at cpan.org>
Please report any bugs or feature requests to bug-Tk-ForDummies-Graph at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Tk-ForDummies-Graph. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
bug-Tk-ForDummies-Graph at rt.cpan.org
No legend
#!/usr/bin/perl use strict; use warnings; use Tk; use Tk::ForDummies::Graph::Bars; my $mw = new MainWindow( -title => 'Tk::ForDummies::Graph::Bars No legend', -background => 'white', ); my $GraphDummies = $mw->Bars( -title => 'My graph title - no legend', -xlabel => 'X Label', -ylabel => 'Y Label', )->pack(qw / -fill both -expand 1 /); my @data = ( [ '1st', '2nd', '3rd', '4th', '5th', '6th', '7th', '8th', '9th' ], [ 4, 0, 16, 2, 3, 5.5, 7, 5, 02 ], [ 1, 2, 4, 6, 3, 17.5, 1, 20, 10 ] ); # Create the graph $GraphDummies->plot( \@data ); MainLoop();
Just negative values
#!/usr/bin/perl use strict; use warnings; use Tk; use Tk::ForDummies::Graph::Lines; my $mw = new MainWindow( -title => 'Tk::ForDummies::Graph::Lines example - negative values', -background => 'white', ); my $GraphDummies = $mw->Lines( -title => 'My graph title', -xlabel => 'X Label', -ylabel => 'Y Label', -zeroaxisonly => 1, )->pack(qw / -fill both -expand 1 /); my @data = ( [ '1st', '2nd', '3rd', '4th', '5th', '6th', '7th', '8th', '9th' ], [ 4, -4, -16, -2, -3, -5.5, -7, -5, -2 ], [ -1, -2, -4, -6, -3, -17.5, -1, -20, -10 ] ); # Create the graph $GraphDummies->plot( \@data ); MainLoop();
Create a zoom Menu with the graph.
#!/usr/bin/perl use strict; use warnings; use Tk; use Tk::ForDummies::Graph::Lines; my $mw = new MainWindow( -title => 'Tk::ForDummies::Graph::Lines example with legend and zoom menu', -background => 'white', ); my $GraphDummies = $mw->Lines( -title => 'My graph title', -xlabel => 'X Label', -ylabel => 'Y Label', -linewidth => 2, -background => 'white', )->pack(qw / -fill both -expand 1 /); my @data = ( [ '1st', '2nd', '3rd', '4th', '5th', '6th', '7th', '8th', '9th' ], [ 1, 2, 5, -6, 3, 1.5, 1, 3, 4 ], [ 4, 0, 16, 2, 3, 5.5, 7, 5, 02 ], [ 1, 2, 4, 6, 3, 17.5, 1, 20, 10 ] ); # Add a legend to our graph my @Legends = ( 'legend 1', 'legend 2', 'legend 3' ); $GraphDummies->set_legend( -title => 'Title legend', -data => \@Legends, -titlecolors => 'blue', ); # I can see the legend text when mouse pass on line and # the line change color when mouse pass on legend text $GraphDummies->set_balloon(); # Create the graph $GraphDummies->plot( \@data ); $GraphDummies->add_data( [ 1 .. 9 ], 'legend 4' ); my $menu = Menu( $GraphDummies, [qw/30 50 80 100 150 200/] ); MainLoop(); sub CanvasMenu { my ( $Canvas, $x, $y, $CanvasMenu ) = @_; $CanvasMenu->post( $x, $y ); return; } sub Menu { my ( $GraphDummies, $RefData ) = @_; my %MenuConfig = ( -tearoff => 0, -takefocus => 1, -background => 'white', -menuitems => [], ); my $Menu = $GraphDummies->Menu(%MenuConfig); $Menu->add( 'cascade', -label => 'Zoom' ); $Menu->add( 'cascade', -label => 'Zoom X-axis' ); $Menu->add( 'cascade', -label => 'Zoom Y-axis' ); my $SsMenuZoomX = $Menu->Menu(%MenuConfig); my $SsMenuZoomY = $Menu->Menu(%MenuConfig); my $SsMenuZoom = $Menu->Menu(%MenuConfig); for my $Zoom ( @{$RefData} ) { $SsMenuZoom->add( 'command', -label => '$Zoom %', -command => sub { $GraphDummies->zoom($Zoom); } ); $SsMenuZoomX->add( 'command', -label => '$Zoom %', -command => sub { $GraphDummies->zoomx($Zoom); } ); $SsMenuZoomY->add( 'command', -label => '$Zoom %', -command => sub { $GraphDummies->zoomy($Zoom); } ); } $Menu->entryconfigure( 'Zoom X-axis', -menu => $SsMenuZoomX ); $Menu->entryconfigure( 'Zoom Y-axis', -menu => $SsMenuZoomY ); $Menu->entryconfigure( 'Zoom', -menu => $SsMenuZoom ); $GraphDummies->Tk::bind( '<ButtonPress-3>', [ \&CanvasMenu, Ev('X'), Ev('Y'), $Menu, $GraphDummies ] ); return $Menu; }
See Tk::Canvas for details of the standard options.
See Tk::ForDummies::Graph, Tk::ForDummies::Graph::FAQ, GD::Graph, Tk::Graph, Tk::LineGraph, Tk::PlotDataset
You can find documentation for this module with the perldoc command.
perldoc Tk::ForDummies::Graph::Lines
You can also look for information at:
RT: CPAN's request tracker
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Tk-ForDummies-Graph
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/Tk-ForDummies-Graph
CPAN Ratings
http://cpanratings.perl.org/d/Tk-ForDummies-Graph
Search CPAN
http://search.cpan.org/dist/Tk-ForDummies-Graph/
Copyright 2010 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::ForDummies::Graph, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Tk::ForDummies::Graph
CPAN shell
perl -MCPAN -e shell install Tk::ForDummies::Graph
For more information on module installation, please visit the detailed CPAN module installation guide.