GIFgraph.pm
上传用户:shbosideng
上传日期:2013-05-04
资源大小:1555k
文件大小:28k
源码类别:

SNMP编程

开发平台:

C/C++

  1. #==========================================================================
  2. #              Copyright (c) 1995-1998 Martien Verbruggen
  3. #--------------------------------------------------------------------------
  4. #
  5. # Name:
  6. # GIFgraph.pm
  7. #
  8. # Description:
  9. #       Module to create graphs from a data set, outputting
  10. # GIF format graphics.
  11. #
  12. # Package of a number of graph types:
  13. # GIFgraph::bars
  14. # GIFgraph::lines
  15. # GIFgraph::points
  16. # GIFgraph::linespoints
  17. # GIFgraph::area
  18. # GIFgraph::pie
  19. # GIFgraph::mixed
  20. #
  21. # $Id: GIFgraph.pm,v 1.1.1.1 2002/02/26 10:16:37 oetiker Exp $
  22. #
  23. #==========================================================================
  24. require 5.004;
  25. use strict;
  26. use vars qw(@ISA);
  27. # Use Lincoln Stein's GD and Thomas Boutell's libgd.a
  28. use GD;
  29. #
  30. # GIFgraph
  31. #
  32. # Parent class containing data all graphs have in common.
  33. #
  34. package GIFgraph;
  35. $GIFgraph::prog_name    = 'GIFgraph.pm';
  36. $GIFgraph::prog_rcs_rev = '$Revision: 1.1.1.1 $';
  37. $GIFgraph::prog_version = 
  38. ($GIFgraph::prog_rcs_rev =~ /s+(d*.d*)/) ? $1 : "0.0";
  39. $GIFgraph::VERSION = '1.10';
  40. # Some tools and utils
  41. use GIFgraph::colour qw(:colours);
  42. my $OS;
  43. # Let's guess what the OS is
  44. # (from CGI.pm by Lincoln Stein)
  45. # OVERRIDE THE OS HERE IF THE GUESS IS WRONG
  46. # $OS = 'UNIX';
  47. # $OS = 'MACINTOSH';
  48. # $OS = 'WINDOWS';
  49. # $OS = 'VMS';
  50. # $OS = 'OS2';
  51. # FIGURE OUT THE OS WE'RE RUNNING UNDER
  52. # Some systems support the $^O variable.  If not
  53. # available then require() the Config library
  54. unless ($OS) {
  55.     unless ($OS = $^O) {
  56.         require Config;
  57.         $OS = $Config::Config{'osname'};
  58.     }
  59. if ($OS=~/Win/i) {
  60. $OS = 'WINDOWS';
  61. } elsif ($OS=~/vms/i) {
  62. $OS = 'VMS';
  63. } elsif ($OS=~/Mac/i) {
  64. $OS = 'MACINTOSH';
  65. } elsif ($OS=~/os2/i) {
  66. $OS = 'OS2';
  67. } else {
  68. $OS = 'UNIX';
  69. }
  70. }
  71. $GIFgraph::needs_binmode = $OS=~/^(WINDOWS|VMS|OS2)/;
  72. my %GIFsize = ( 
  73. 'x' => 400, 
  74. 'y' => 300 
  75. );
  76. my %Defaults = (
  77. # Set the top, bottom, left and right margin for the GIF. These 
  78. # margins will be left empty.
  79. t_margin      => 0,
  80. b_margin      => 0,
  81. l_margin      => 0,
  82. r_margin      => 0,
  83. # Set the factor with which to resize the logo in the GIF (need to
  84. # automatically compute something nice for this, really), set the 
  85. # default logo file name, and set the logo position (UR, BR, UL, BL)
  86. logo_resize   => 1.0,
  87. logo          => undef,
  88. logo_position => 'LR',
  89. # Write a transparent GIF?
  90. transparent   => 1,
  91. # Write an interlaced GIF?
  92. interlaced    => 1,
  93. # Set the background colour, the default foreground colour (used 
  94. # for axes etc), the textcolour, the colour for labels, the colour 
  95. # for numbers on the axes, the colour for accents (extra lines, tick
  96. # marks, etc..)
  97. bgclr         => 'white',
  98. fgclr         => 'dblue',
  99. textclr       => 'dblue',
  100. labelclr      => 'dblue',
  101. axislabelclr  => 'dblue',
  102. accentclr     => 'gray',
  103. # number of pixels to use as text spacing
  104. text_space    => 8,
  105. );
  106. {
  107.     #
  108.     # PUBLIC methods, documented in pod.
  109.     #
  110.     sub new  # ( width, height ) optional;
  111. {
  112.         my $type = shift;
  113.         my $self = {};
  114.         bless $self, $type;
  115.         if (@_) 
  116. {
  117.             # If there are any parameters, they should be the size
  118.             $self->{gifx} = shift;
  119.             # If there's an x size, there should also be a y size.
  120.             die "Usage: GIFgraph::<type>::new( [x_size, y_size] )n" unless @_;
  121.             $self->{gify} = shift;
  122.         } 
  123. else 
  124. {
  125.             # There were obviously no parameters, so use defaults
  126.             $self->{gifx} = $GIFsize{'x'};
  127.             $self->{gify} = $GIFsize{'y'};
  128.         }
  129.         # Initialise all relevant parameters to defaults
  130.         # These are defined in the subclasses. See there.
  131.         $self->initialise( );
  132.         return $self;
  133.     }
  134.     sub set
  135. {
  136.         my $s = shift;
  137.         my %args = @_;
  138.         foreach (keys %args) 
  139. $s->{$_} = $args{$_}; 
  140. }
  141.     }
  142.     # These should probably not be used, or be rewritten to 
  143.     # accept some keywords. Problem is that GD is very limited 
  144.     # on fonts, and this routine just accepts GD font names. 
  145.     # But.. it's not nice to require the user to include GD.pm
  146.     # just because she might want to change the font.
  147.     sub set_title_font # (fontname)
  148. {
  149.         my $self = shift;
  150.         $self->{tf} = shift;
  151.         $self->set( 
  152. tfw => $self->{tf}->width,
  153. tfh => $self->{tf}->height,
  154. );
  155.     }
  156.     sub set_text_clr # (colour name)
  157. {
  158.         my $s = shift;
  159.         my $c = shift;
  160.         $s->set(
  161.             textclr       => $c,
  162.             labelclr      => $c,
  163.             axislabelclr  => $c,
  164.         );
  165.     }
  166. sub plot # (@data)
  167. {
  168. # ABSTRACT
  169. my $s = shift;
  170. $s->die_abstract( "sub plot missing," );
  171. }
  172.     sub plot_to_gif # ("file.gif", @data)
  173. {
  174.         my $s = shift;
  175.         my $file = shift;
  176.         my $data = shift;
  177.         open (GIFPLOT,">$file") || do 
  178. warn "Cannot open $file for writing: $!";
  179. return 0; 
  180. };
  181. binmode GIFPLOT if ($GIFgraph::needs_binmode);
  182.         print GIFPLOT $s->plot( $data );
  183.         close(GIFPLOT);
  184.     }
  185.     # Routine to read GNU style data files
  186. # NOT USEABLE
  187.     sub ReadFile 
  188. {
  189.         my $file = shift; 
  190. my @cols = @_; 
  191. my (@out, $i, $j);
  192.         @cols = 1 if ( $#cols < 1 );
  193.         open (DATA, $file) || do { 
  194. warn "Cannot open file: $file"; 
  195. return []; 
  196. };
  197.         $i=0; 
  198.         while (defined(<DATA>)) 
  199.             s/^s+|s+$//;
  200.             next if ( /^#/ || /^!/ || /^[ t]*$/ );
  201.             @_ = split(/[ t]+/);
  202.             $out[0][$i] = $_[0];
  203.             $j=1;
  204.             foreach (@cols) 
  205. {
  206.                 if ( $_ > $#_ ) { 
  207. warn "Data column $_ not present"; 
  208. return []; 
  209. }
  210.                 $out[$j][$i] = $_[$_]; $j++;
  211.             }
  212.             $i++;
  213.         }
  214.         close(DATA);
  215.         return @out;
  216.     } # ReadFile
  217.     #
  218.     # PRIVATE methods
  219.     #
  220.     # Set defaults that apply to all graph/chart types. 
  221.     # This is called by the default initialise methods 
  222.     # from the objects further down the tree.
  223.     sub initialise()
  224. {
  225.         my $self = shift;
  226. foreach (keys %Defaults) 
  227. {
  228. $self->set( $_ => $Defaults{$_} );
  229. }
  230.         $self->set_title_font(GD::gdLargeFont);
  231. $self->open_graph();
  232.     }
  233.     # Check the integrity of the submitted data
  234.     #
  235.     # Checks are done to assure that every input array 
  236.     # has the same number of data points, it sets the variables
  237.     # that store the number of sets and the number of points
  238.     # per set, and kills the process if there are no datapoints
  239.     # in the sets, or if there are no data sets.
  240.     sub check_data($) # @data
  241. {
  242.         my $self = shift;
  243.         my $data = shift;
  244.         $self->set(numsets => $#$data);
  245.         $self->set(numpoints => $#{@$data[0]});
  246.         ( $self->{numsets} < 1 || $self->{numpoints} < 0 ) && die "No Data";
  247. my $i;
  248.         for $i ( 1..$self->{numsets} ) 
  249. {
  250. die "Data array $i: length misfit"
  251. unless ( $self->{numpoints} == $#{@$data[$i]} );
  252.         }
  253.     }
  254.     # Open the graph output canvas by creating a new GD object.
  255.     sub open_graph()
  256. {
  257.         my $self = shift;
  258. if ( !exists $self->{graph} )
  259. {
  260. my $graph = new GD::Image($self->{gifx}, $self->{gify});
  261. $self->{graph} = $graph;
  262. return $graph;
  263. }
  264. else
  265. {
  266. return $self->{graph};
  267. }
  268.     }
  269.     # Initialise the graph output canvas, setting colours (and getting back
  270.     # index numbers for them) setting the graph to transparent, and 
  271.     # interlaced, putting a logo (if defined) on there.
  272.     sub init_graph($) # GD::Image
  273. {
  274.         my $self = shift;
  275.         my $graph = shift;
  276.         $self->{bgci} = $self->set_clr( $graph, _rgb($self->{bgclr}) );
  277.         $self->{fgci} = $self->set_clr( $graph, _rgb($self->{fgclr}) );
  278.         $self->{tci}  = $self->set_clr( $graph, _rgb($self->{textclr}) );
  279.         $self->{lci}  = $self->set_clr( $graph, _rgb($self->{labelclr}) );
  280.         $self->{alci} = $self->set_clr( $graph, _rgb($self->{axislabelclr}) );
  281.         $self->{acci} = $self->set_clr( $graph, _rgb($self->{accentclr}) );
  282.         $graph->transparent($self->{bgci}) if $self->{transparent};
  283.         $graph->interlaced($self->{interlaced});
  284.         $self->put_logo($graph);
  285.     }
  286.     # read in the logo, and paste it on the graph canvas
  287.     sub put_logo($) # GD::Image
  288. {
  289.         my $self = shift;
  290.         my $graph = shift;
  291. return unless(defined($self->{logo}));
  292.         my ($x, $y, $glogo);
  293.         my $r = $self->{logo_resize};
  294.         my $r_margin = (defined $self->{r_margin_abs}) ? 
  295.             $self->{r_margin_abs} : $self->{r_margin};
  296.         my $b_margin = (defined $self->{b_margin_abs}) ? 
  297.             $self->{b_margin_abs} : $self->{b_margin};
  298.         open(GIFLOGO, $self->{logo}) || return;
  299. binmode(GIFLOGO) if ($GIFgraph::needs_binmode);
  300.         unless ( $glogo = newFromGif GD::Image(*GIFLOGO) ) 
  301. {
  302.             warn "Problems reading $self->{logo}"; 
  303. close(GIFLOGO); 
  304. return;
  305.         }
  306.         close(GIFLOGO);
  307.         my ($w, $h) = $glogo->getBounds;
  308.         LOGO: for ($self->{logo_position}) {
  309.             /UL/i && do {
  310.                 $x = $self->{l_margin};
  311.                 $y = $self->{t_margin};
  312.                 last LOGO;
  313.             };
  314.             /UR/i && do {
  315.                 $x = $self->{gifx} - $r_margin - $w * $r;
  316.                 $y = $self->{t_margin};
  317.                 last LOGO;
  318.             };
  319.             /LL/i && do {
  320.                 $x = $self->{l_margin};
  321.                 $y = $self->{gify} - $b_margin - $h * $r;
  322.                 last LOGO;
  323.             };
  324.             # default "LR"
  325.             $x = $self->{gifx} - $r_margin - $r * $w;
  326.             $y = $self->{gify} - $b_margin - $r * $h;
  327.             last LOGO;
  328.         }
  329.         $graph->copyResized($glogo, $x, $y, 0, 0, $r * $w, $r * $h, $w, $h);
  330.         undef $glogo;
  331.     }
  332.     # Set a colour to work with on the canvas, by rgb value. 
  333.     # Return the colour index in the palette
  334.     sub set_clr($$$$) # GD::Image, r, g, b
  335. {
  336.         my $s = shift; 
  337. my $g = shift; 
  338. my $i;
  339.         # Check if this colour already exists on the canvas
  340.         if ( ( $i = $g->colorExact( @_ ) ) < 0 ) 
  341. {
  342.             # if not, allocate a new one, and return it's index
  343.             return $g->colorAllocate( @_ );
  344.         } 
  345.         return $i;
  346.     }
  347.     
  348.     # Set a colour, disregarding wether or not it already exists.
  349.     sub set_clr_uniq($$$$) # GD::Image, r, g, b
  350. {
  351.         my $s=shift; 
  352.         my $g=shift; 
  353.         $g->colorAllocate( @_ ); 
  354.     }
  355.     # Return an array of rgb values for a colour number
  356.     sub pick_data_clr($) # number
  357. {
  358.         my $s = shift;
  359. # Set up the data colour list if it doesn't exist yet.
  360. # It seemed easier & more robust to me to do it here rather than
  361. # relying on users doing it. AF
  362. $s->set( 
  363. dclrs => [ qw(lred lgreen lblue lyellow lpurple lbrown cyan
  364. lorange marine dyellow red green yellow blue
  365. lgray dbrown purple orange pink gold)] 
  366. ) unless ( exists $s->{dclrs} );
  367.         return _rgb( $s->{dclrs}[ $_[0] % (1+$#{$s->{dclrs}}) -1 ] );
  368.     }
  369.     # DEBUGGING
  370. # data_dump obsolete now, use Data::Dumper
  371. sub die_abstract()
  372. {
  373. my $s = shift;
  374. my $msg = shift;
  375. # ABSTRACT
  376. die
  377. "Subclass (" .
  378. ref($s) . 
  379. ") not implemented correctly: " .
  380. (defined($msg) ? $msg : "unknown error");
  381. }
  382.     # Return the gif contents
  383.     sub gifdata() 
  384. {
  385.         my $s = shift;
  386.         return $s->{graph}->gif;
  387.     }
  388. } # End of package GIFgraph
  389. $GIFgraph::prog_name;
  390. __END__
  391. =head1 NAME
  392. GIFgraph - Graph Plotting Module for Perl 5
  393. =head1 SYNOPSIS
  394. use GIFgraph::moduleName;
  395. =head1 DESCRIPTION
  396. B<GIFgraph> is a I<perl5> module to create and display GIF output 
  397. for a graph.
  398. The following classes for graphs with axes are defined:
  399. =over 4
  400. =item C<GIFgraph::lines>
  401. Create a line chart.
  402. =item C<GIFgraph::bars>
  403. Create a bar chart.
  404. =item C<GIFgraph::points>
  405. Create an chart, displaying the data as points.
  406. =item C<GIFgraph::linespoints>
  407. Combination of lines and points.
  408. =item C<GIFgraph::area>
  409. Create a graph, representing the data as areas under a line.
  410. =item C<GIFgraph::mixed>
  411. Create a mixed type graph, any combination of the above. At the moment
  412. this is fairly limited. Some of the options that can be used with some
  413. of the individual graph types won't work very well. Multiple bar
  414. graphs in a mixed graph won't display very nicely.
  415. =back
  416. Additional types:
  417. =over 4
  418. =item C<GIFgraph::pie>
  419. Create a pie chart.
  420. =back
  421. =head1 EXAMPLES
  422. See the samples directory in the distribution.
  423. =head1 USAGE
  424. Fill an array of arrays with the x values and the values of the data
  425. sets.  Make sure that every array is the same size, otherwise
  426. I<GIFgraph> will complain and refuse to compile the graph.
  427.     @data = ( 
  428.         ["1st","2nd","3rd","4th","5th","6th","7th", "8th", "9th"],
  429.         [    1,    2,    5,    6,    3,  1.5,    1,     3,     4]
  430.         [ sort { $a <=> $b } (1, 2, 5, 6, 3, 1.5, 1, 3, 4) ]
  431.     );
  432. If you don't have a value for a point in a certain dataset, you can
  433. use B<undef>, and I<GIFgraph> will skip that point.
  434. Create a new I<GIFgraph> object by calling the I<new> operator on the
  435. graph type you want to create (I<chart> is I<bars, lines, points,
  436. linespoints> or I<pie>).
  437.     $my_graph = new GIFgraph::chart( );
  438. Set the graph options. 
  439.     $my_graph->set( 
  440.         x_label           => 'X Label',
  441.         y_label           => 'Y label',
  442.         title             => 'Some simple graph',
  443.         y_max_value       => 8,
  444.         y_tick_number     => 8,
  445.         y_label_skip      => 2 
  446.     );
  447. Output the graph
  448.     $my_graph->plot_to_gif( "sample01.gif", @data );
  449. =head1 METHODS AND FUNCTIONS
  450. =head2 Methods for all graphs
  451. =over 4
  452. =item new GIFgraph::chart([width,height])
  453. Create a new object $graph with optional width and heigth. 
  454. Default width = 400, default height = 300. I<chart> is either
  455. I<bars, lines, points, linespoints, area> or I<pie>.
  456. =item set_text_clr( I<colour name> )
  457. Set the colour of the text. This will set the colour of the titles,
  458. labels, and axis labels to I<colour name>. Also see the options
  459. I<textclr>, I<labelclr> and I<axislabelclr>.
  460. =item set_title_font( I<fontname> )
  461. Set the font that will be used for the title of the chart.  Possible
  462. choices are defined in L<GD>. 
  463. B<NB.> If you want to use this function, you'll
  464. need to use L<GD>. At some point I'll rewrite this, so you can give this a
  465. number from 1 to 4, or a string like 'large' or 'small'. On the other
  466. hand, I might not, if Thomas Boutell decides to support more fonts.
  467. =item plot( I<@data> )
  468. Plot the chart, and return the GIF data.
  469. =item plot_to_gif( F<filename>, I<@data> )
  470. Plot the chart, and write the GIF data to I<filename>.
  471. =item set( key1 => value1, key2 => value2 .... )
  472. Set chart options. See OPTIONS section.
  473. =back
  474. =head2 Methods for Pie charts
  475. =over 4
  476. =item set_label_font( I<fontname> )
  477. =item set_value_font( I<fontname> )
  478. Set the font that will be used for the label of the pie or the 
  479. values on the pie.  Possible choices are defined in L<GD>. 
  480. See also I<set_title_font>.
  481. =back
  482. =head2 Methods for charts with axes.
  483. =over 4
  484. =item set_x_label_font ( I<font name> )
  485. =item set_y_label_font ( I<font name> )
  486. =item set_x_axis_font ( I<font name> )
  487. =item set_y_axis_font ( I<font name> )
  488. Set the font for the x and y axis label, and for the x and y axis
  489. value labels.
  490. See also I<set_title_font>.
  491. =back
  492. =head1 OPTIONS
  493. =head2 Options for all graphs
  494. =over 4
  495. =item gifx, gify
  496. The width and height of the gif file in pixels
  497. Default: 400 x 300.
  498. B<NB> At the moment, these are read-only options. If you want to set
  499. the size of a graph, you will have to do that with the I<new> method.
  500. =item t_margin, b_margin, l_margin, r_margin
  501. Top, bottom, left and right margin of the GIF. These margins will be
  502. left blank.
  503. Default: 0 for all.
  504. =item logo
  505. Name of a logo file. This should be a GIF file. 
  506. Default: no logo.
  507. =item logo_resize, logo_position
  508. Factor to resize the logo by, and the position on the canvas of the
  509. logo. Possible values for logo_position are 'LL', 'LR', 'UL', and
  510. 'UR'.  (lower and upper left and right). 
  511. Default: 'LR'.
  512. =item transparent
  513. If set to a true value, the produced GIF will have the background
  514. colour marked as transparent (see also option I<bgclr>).  Default: 1.
  515. =item interlaced
  516. If set to a true value, the produced GIF will be interlaced.
  517. Default: 1.
  518. =item bgclr, fgclr, textclr, labelclr, axislabelclr, accentclr
  519. Background, foreground, text, label, axis label and accent colours.
  520. =item dclrs (short for datacolours)
  521. This controls the colours for the bars, lines, markers, or pie slices.
  522. This should be a reference to an array of colour names as defined in
  523. L<GIFgraph::colour> (C<S<perldoc GIFgraph::colour>> for the names available).
  524.     $graph->set( dclrs => [ qw(green pink blue cyan) ] );
  525. The first (fifth, ninth) data set will be green, the next pink, etc.
  526. Default: [ qw(lred lgreen lblue lyellow lpurple cyan lorange) ] 
  527. =back
  528. =head2 Options for graphs with axes.
  529. options for I<bars>, I<lines>, I<points>, I<linespoints> and 
  530. I<area> charts.
  531. =over 4
  532. =item long_ticks, tick_length
  533. If I<long_ticks> is a true value, ticks will be drawn the same length
  534. as the axes.  Otherwise ticks will be drawn with length
  535. I<tick_length>. if I<tick_length> is negative, the ticks will be drawn
  536. outside the axes.  Default: long_ticks = 0, tick_length = 4.
  537. =item x_ticks
  538. If I<x_ticks> is a true value, ticks will be drawm for the x axis.
  539. These ticks are subject to the values of I<long_ticks> and
  540. I<tick_length>.  Default: 1.
  541. =item y_tick_number
  542. Number of ticks to print for the Y axis. Use this, together with
  543. I<y_label_skip> to control the look of ticks on the y axis.
  544. Default: 5.
  545. =item y_number_format
  546. This can be either a string, or a reference to a subroutine. If it is
  547. a string, it will be taken to be the first argument to an sprintf,
  548. with the value as the second argument:
  549.     $label = sprintf( $s->{y_number_format, $value );
  550. If it is a code reference, it will be executed with the value as the
  551. argument:
  552.     $label = &{$s->{y_number_format}}($value);
  553. This can be useful, for example, if you want to reformat your values
  554. in currency, with the - sign in the right spot. Something like:
  555.     sub y_format
  556.     {
  557.         my $value = shift;
  558.         my $ret;
  559.         if ($value >= 0)
  560.         {
  561.             $ret = sprintf("$%d", $value * $refit);
  562.         }
  563.         else
  564.         {
  565.             $ret = sprintf("-$%d", abs($value) * $refit);
  566.         }
  567.         return $ret;
  568.     }
  569.     $my_graph->set( 'y_number_format' => &y_format );
  570. (Yes, I know this can be much shorter and more concise)
  571. Default: undef.
  572. =item x_label_skip, y_label_skip
  573. Print every I<x_label_skip>th number under the tick on the x axis, and
  574. every I<y_label_skip>th number next to the tick on the y axis.
  575. Default: 1 for both.
  576. =item x_all_ticks
  577. Force a print of all the x ticks, even if x_label_skip is set to a value
  578. Default: 0.
  579. =item x_label_position
  580. Controls the position of the X axis label (title). The value for this
  581. should be between 0 and 1, where 0 means aligned to the left, 1 means
  582. aligned to the right, and 1/2 means centered. 
  583. Default: 3/4
  584. =item y_label_position
  585. Controls the position of both Y axis labels (titles). The value for
  586. this should be between 0 and 1, where 0 means aligned to the bottom, 1
  587. means aligned to the top, and 1/2 means centered. 
  588. Default: 1/2
  589. =item x_labels_vertical
  590. If set to a true value, the X axis labels will be printed vertically.
  591. This can be handy in case these labels get very long.
  592. Default: 0.
  593. =item x_plot_values, y_plot_values
  594. If set to a true value, the values of the ticks on the x or y axes
  595. will be plotted next to the tick. Also see I<x_label_skip,
  596. y_label_skip>.  Default: 1 for both.
  597. =item box_axis
  598. Draw the axes as a box, if true.
  599. Default: 1.
  600. =item two_axes
  601. Use two separate axes for the first and second data set. The first
  602. data set will be set against the left axis, the second against the
  603. right axis. If this is set to a true value, trying to use anything
  604. else than 2 datasets will generate an error.  Default: 0.
  605. =item zero_axis
  606. If set to a true value, the axis for y values of 0 will always be
  607. drawn. This might be useful in case your graph contains negative
  608. values, but you want it to be clear where the zero value is. (see also
  609. I<zero_axis_only> and I<box_axes>).
  610. Default: 0.
  611. =item zero_axis_only
  612. If set to a true value, the zero axis will be drawn (see
  613. I<zero_axis>), and no axis at the bottom of the graph will be drawn.
  614. The labels for X values will be placed on the zero exis.
  615. Default: 0.
  616. =item y_max_value, y_min_value
  617. Maximum and minimum value displayed on the y axis. If two_axes is a
  618. true value, then y1_min_value, y1_max_value (for the left axis),
  619. and y2_min_value, y2_max_value (for the right axis) take precedence
  620. over these.
  621. The range (y_min_value..y_max_value) has to include all the values of
  622. the data points, or I<GIFgraph> will die with a message.
  623. For bar and area graphs, the range (y_min_value..y_max_value) has to
  624. include 0. If it doesn't, the values will be adapted before attempting
  625. to draw the graph.
  626. Default: Computed from data sets.
  627. =item axis_space
  628. This space will be left blank between the axes and the text.
  629. Default: 4.
  630. =item overwrite
  631. If set to 0, bars of different data sets will be drawn next to each
  632. other. If set to 1, they will be drawn in front of each other. If set
  633. to 2 they will be drawn on top of each other.
  634. Default: 0.
  635. If you have negative values in your data sets, setting overwrite to 2
  636. might produce odd results. Of course, the graph itself would be quite
  637. meaningless, because overwrite = 2 is meant to show some cumulative
  638. effect.
  639. =back
  640. =head2 Options for graphs with a numerical X axis
  641. First of all: GIFgraph does B<not> support numerical x axis the way it
  642. should. Data for X axes should be equally spaced. That understood:
  643. There is some support to make the printing of graphs with numerical X
  644. axis values a bit better, thanks to Scott Prahl. If the option
  645. C<x_tick_number> is set to a defined value, GIFgraph will attempt to
  646. treat the X data as numerical.
  647. Extra options are:
  648. =over 4
  649. =item x_tick_number
  650. If set to I<'auto'>, GIFgraph will attempt to format the X axis in a
  651. nice way, based on the actual X values. If set to a number, that's the
  652. number of ticks you will get. If set to undef, GIFgraph will treat X
  653. data as labels.
  654. Default: undef.
  655. =item x_min_value, x_max_value
  656. The minimum and maximum value to use for the X axis.
  657. Default: computed.
  658. =item x_number_format
  659. See y_number_format
  660. =item x_label_skip
  661. See y_label_skip
  662. =back
  663. =head2 Options for graphs with bars
  664. =over 4
  665. =item bar_spacing
  666. Number of pixels to leave open between bars. This works well in most
  667. cases, but on some platforms, a value of 1 will be rounded off to 0.
  668. Default: 0
  669. =back
  670. =head2 Options for graphs with lines
  671. =over 4
  672. =item line_types
  673. Which line types to use for I<lines> and I<linespoints> graphs. This
  674. should be a reference to an array of numbers:
  675.     $graph->set( line_types => [3, 2, 4] );
  676. Available line types are 1: solid, 2: dashed, 3: dotted, 4:
  677. dot-dashed.
  678. Default: [1] (always use solid)
  679. =item line_type_scale
  680. Controls the length of the dashes in the line types. default: 6.
  681. =item line_width
  682. The width of the line used in I<lines> and I<linespoints> graphs, in pixels.
  683. Default: 1.
  684. =back
  685. =head2 Options for graphs with points
  686. =over 4
  687. =item markers
  688. This controls the order of markers in I<points> and I<linespoints>
  689. graphs.  This should be a reference to an array of numbers:
  690.     $graph->set( markers => [3, 5, 6] );
  691. Available markers are: 1: filled square, 2: open square, 3: horizontal
  692. cross, 4: diagonal cross, 5: filled diamond, 6: open diamond, 7:
  693. filled circle, 8: open circle.
  694. Default: [1,2,3,4,5,6,7,8]
  695. =item marker_size
  696. The size of the markers used in I<points> and I<linespoints> graphs,
  697. in pixels.  Default: 4.
  698. =back
  699. =head2 Options for mixed graphs
  700. =over 4
  701. =item types
  702. A reference to an array with graph types, in the same order as the
  703. data sets. Possible values are:
  704.   $graph->set( types => [qw(lines bars points area linespoints)] );
  705.   $graph->set( types => ['lines', undef, undef, 'bars'] );
  706. values that are undefined or unknown will be set to C<default_type>.
  707. Default: all set to C<default_type>
  708. =item default_type
  709. The type of graph to draw for data sets that either have no type set,
  710. or that have an unknown type set.
  711. Default: lines
  712. =back
  713. =head2 Graph legends (axestype graphs only)
  714. At the moment legend support is minimal.
  715. B<Methods>
  716. =over 4
  717. =item set_legend( I<@legend_keys> );
  718. Sets the keys for the legend. The elements of @legend_keys correspond
  719. to the data sets as provided to I<plot()> or I<plot_to_gif()>.
  720. If a key is I<undef> or an empty string, the legend entry will be skipped.
  721. =item set_legend_font( I<font name> );
  722. Sets the font for the legend text (see also I<set_title_font>).
  723. Default: GD::gdTinyFont.
  724. =back
  725. B<Options>
  726. =over 4
  727. =item legend_placement
  728. Where to put the legend. This should be a two letter key of the form:
  729. 'B[LCR]|R[TCB]'. The first letter sigifies the placement (I<B>ottom or
  730. I<R>ight), and the second letter signifies the alignment (I<L>eft,
  731. I<R>ight, I<C>enter, I<T>op, or I<B>ottom).
  732. Default: 'BC'
  733. If the legend is placed at the bottom, some calculations will be made
  734. to ensure that there is some 'intelligent' wrapping going on. if the
  735. legend is placed at the right, all entries will be placed below each
  736. other.
  737. =item legend_spacing
  738. The number of pixels to place around a legend item, and between a
  739. legend 'marker' and the text.
  740. Default: 4
  741. =item legend_marker_width, legend_marker_height
  742. The width and height of a legend 'marker' in pixels.
  743. Defaults: 12, 8
  744. =item lg_cols
  745. If you, for some reason, need to force the legend at the bottom to
  746. have a specific number of columns, you can use this.
  747. Default: computed
  748. =back
  749. =head2 Options for pie graphs
  750. =over 4
  751. =item 3d
  752. If set to a true value, the pie chart will be drawn with a 3d look.
  753. Default: 1.
  754. =item pie_height
  755. The thickness of the pie when I<3d> is true.
  756. Default: 0.1 x GIF y size.
  757. =item start_angle
  758. The angle at which the first data slice will be displayed, with 0 degrees
  759. being "6 o'clock".
  760. Default: 0.
  761. =back
  762. =head1 NOTES
  763. All references to colours in the options for this module have been
  764. shortened to clr. The main reason for this was that I didn't want to
  765. support two spellings for the same word ('colour' and 'color')
  766. Wherever a colour is required, a colour name should be used from the
  767. package L<GIFgraph::colour>. C<S<perldoc GIFgraph::colour>> should give
  768. you the documentation for that module, containing all valid colour
  769. names. I will probably change this to read the systems rgb.txt file if 
  770. it is available.
  771. Wherever a font name is required, a font from L<GD> should be used.
  772. =head1 AUTHOR
  773. Martien Verbruggen
  774. =head2 Contact info 
  775. email: mgjv@comdyn.com.au
  776. =head2 Copyright
  777. Copyright (C) 1995-1998 Martien Verbruggen.
  778. All rights reserved.  This package is free software; you can redistribute it 
  779. and/or modify it under the same terms as Perl itself.
  780. =cut
  781. # WWW: L<http://www.tcp.chem.tue.nl/~tgtcmv/>