1 package Imager::Graph::Vertical;
5 Imager::Graph::Vertical- A super class for line/bar/column charts
12 @ISA = qw(Imager::Graph);
16 =item add_data_series(\@data, $series_name)
18 Add a data series to the graph, of the default type.
25 my $series_name = shift;
27 my $series_type = $self->_get_default_series_type();
28 $self->_add_data_series($series_type, $data_ref, $series_name);
33 =item add_column_data_series(\@data, $series_name)
35 Add a column data series to the graph.
39 sub add_column_data_series {
42 my $series_name = shift;
44 $self->_add_data_series('column', $data_ref, $series_name);
49 =item add_stacked_column_data_series(\@data, $series_name)
51 Add a stacked column data series to the graph.
55 sub add_stacked_column_data_series {
58 my $series_name = shift;
60 $self->_add_data_series('stacked_column', $data_ref, $series_name);
65 =item add_line_data_series(\@data, $series_name)
67 Add a line data series to the graph.
71 sub add_line_data_series {
74 my $series_name = shift;
76 $self->_add_data_series('line', $data_ref, $series_name);
81 =item set_range_padding($percentage)
83 Sets the padding to be used, as a percentage. For example, if your data ranges from 0 to 10, and you have a 20 percent padding, the y axis will go to 12.
89 sub set_range_padding {
90 $_[0]->{'custom_style'}->{'range_padding'} = $_[1];
100 my ($self, %opts) = @_;
102 if (!$self->_valid_input()) {
106 $self->_style_setup(\%opts);
108 my $style = $self->{_style};
110 my $img = $self->_get_image()
113 my @image_box = ( 0, 0, $img->getwidth-1, $img->getheight-1 );
114 $self->_set_image_box(\@image_box);
116 # Scale the graph box down to the widest graph that can cleanly hold the # of columns.
117 $self->_get_data_range();
118 my $column_count = $self->_get_column_count();
120 my $width = $self->_get_number('width');
121 my $height = $self->_get_number('height');
122 my $size = $self->_get_number('size');
124 my $bottom = ($height - $size) / 2;
125 my $left = ($width - $size) / 2;
127 my $col_width = int($size / $column_count) -1;
128 my $graph_width = $col_width * $column_count + 1;
130 my @graph_box = ( $left, $bottom, $left + $graph_width - 1, $bottom + $size - 1 );
131 $self->_set_graph_box(\@graph_box);
133 $self->_draw_legend();
136 color => $self->_get_color('outline.line'),
138 xmax => $left+$graph_width,
140 ymax => $bottom+$size,
144 color => $self->_get_color('bg'),
146 xmax => $left+$graph_width - 1,
148 ymax => $bottom+$size -1 ,
152 my $min_value = $self->_get_min_value();
153 my $max_value = $self->_get_max_value();
154 my $value_range = $max_value - $min_value;
158 $zero_position = $bottom + $size - (-1*$min_value / $value_range) * ($size -1);
161 if ($min_value < 0) {
163 color => $self->_get_color('negative_bg'),
165 xmax => $left+$graph_width- 1,
166 ymin => $zero_position,
167 ymax => $bottom+$size -1,
172 y1 => $zero_position,
173 x2 => $left + $graph_width,
174 y2 => $zero_position,
175 color => $self->_get_color('outline.line'),
179 if ($self->_get_data_series()->{'stacked_column'}) {
180 $self->_draw_stacked_columns();
182 if ($self->_get_data_series()->{'column'}) {
183 $self->_draw_columns();
185 if ($self->_get_data_series()->{'line'}) {
186 $self->_draw_lines();
188 return $self->_get_image();
191 sub _get_data_range {
196 my $column_count = 0;
198 my ($sc_min, $sc_max, $sc_cols) = $self->_get_stacked_column_range();
199 my ($c_min, $c_max, $c_cols) = $self->_get_column_range();
200 my ($l_min, $l_max, $l_cols) = $self->_get_line_range();
202 # These are side by side...
205 $min_value = $self->_min(0, $sc_min, $c_min, $l_min);
206 $max_value = $self->_max(0, $sc_max, $c_max, $l_max);
208 my $range_padding = $self->_get_number('range_padding');
209 if (!defined $range_padding) {
212 if ($range_padding && $min_value < 0) {
213 my $difference = $min_value * $range_padding / 100;
214 if ($min_value < -1 && $difference > -1) {
217 $min_value += $difference;
219 if ($range_padding && $max_value > 0) {
220 my $difference = $max_value * $range_padding / 100;
221 if ($max_value > 1 && $difference < 1) {
224 $max_value += $difference;
227 $column_count = $self->_max(0, $sc_cols, $l_cols);
229 $self->_set_max_value($max_value);
230 $self->_set_min_value($min_value);
231 $self->_set_column_count($column_count);
238 foreach my $value (@_) {
239 if ($value < $min) { $min = $value; }
248 foreach my $value (@_) {
249 if ($value > $min) { $min = $value; }
254 sub _get_line_range {
256 my $series = $self->_get_data_series()->{'line'};
257 return (0, 0, 0) unless $series;
261 my $column_count = 0;
263 my @series = @{$series};
264 foreach my $series (@series) {
265 my @data = @{$series->{'data'}};
267 if (scalar @data > $column_count) {
268 $column_count = scalar @data;
271 foreach my $value (@data) {
272 if ($value > $max_value) { $max_value = $value; }
273 if ($value < $min_value) { $min_value = $value; }
277 return ($min_value, $max_value, $column_count);
280 sub _get_column_range {
283 my $series = $self->_get_data_series()->{'column'};
284 return (0, 0, 0) unless $series;
288 my $column_count = 0;
290 my @series = @{$series};
291 foreach my $series (@series) {
292 my @data = @{$series->{'data'}};
294 foreach my $value (@data) {
296 if ($value > $max_value) { $max_value = $value; }
297 if ($value < $min_value) { $min_value = $value; }
301 return ($min_value, $max_value, $column_count);
304 sub _get_stacked_column_range {
309 my $column_count = 0;
311 return (0, 0, 0) unless $self->_get_data_series()->{'stacked_column'};
312 my @series = @{$self->_get_data_series()->{'stacked_column'}};
316 for (my $i = scalar @series - 1; $i >= 0; $i--) {
317 my $series = $series[$i];
318 my $data = $series->{'data'};
320 for (my $i = 0; $i < scalar @$data; $i++) {
322 if ($data->[$i] > 0) {
323 $value = $data->[$i] + ($max_entries[$i] || 0);
324 $data->[$i] = $value;
325 $max_entries[$i] = $value;
327 elsif ($data->[$i] < 0) {
328 $value = $data->[$i] + ($min_entries[$i] || 0);
329 $data->[$i] = $value;
330 $min_entries[$i] = $value;
332 if ($value > $max_value) { $max_value = $value; }
333 if ($value < $min_value) { $min_value = $value; }
335 if (scalar @$data > $column_count) {
336 $column_count = scalar @$data;
340 return ($min_value, $max_value, $column_count);
345 my $style = $self->{'_style'};
348 my $img = $self->_get_image();
349 if (my $series = $self->_get_data_series()->{'stacked_column'}) {
350 push @labels, map { $_->{'series_name'} } @$series;
352 if (my $series = $self->_get_data_series()->{'column'}) {
353 push @labels, map { $_->{'series_name'} } @$series;
355 if (my $series = $self->_get_data_series()->{'line'}) {
356 push @labels, map { $_->{'series_name'} } @$series;
359 if ($style->{features}{legend} && (scalar @labels)) {
360 $self->SUPER::_draw_legend($self->_get_image(), \@labels, $self->_get_image_box())
366 sub _draw_flat_legend {
372 my $style = $self->{'_style'};
374 my $img = $self->_get_image();
376 my $max_value = $self->_get_max_value();
377 my $min_value = $self->_get_min_value();
378 my $column_count = $self->_get_column_count();
380 my $value_range = $max_value - $min_value;
382 my $width = $self->_get_number('width');
383 my $height = $self->_get_number('height');
384 my $size = $self->_get_number('size');
386 my $bottom = ($height - $size) / 2;
387 my $left = ($width - $size) / 2;
389 my $zero_position = $bottom + $size - (-1*$min_value / $value_range) * ($size -1);
391 if ($self->_get_y_tics()) {
392 $self->_draw_y_tics();
394 if ($self->_get_labels()) {
395 $self->_draw_x_tics();
398 my $line_series = $self->_get_data_series()->{'line'};
399 my $series_counter = $self->_get_series_counter() || 0;
401 my $has_columns = (defined $self->_get_data_series()->{'column'} || $self->_get_data_series->{'stacked_column'}) ? 1 : 0;
403 my $col_width = int($size / $column_count) -1;
404 my $graph_width = $col_width * $column_count + 1;
406 foreach my $series (@$line_series) {
407 my @data = @{$series->{'data'}};
408 my $data_size = scalar @data;
412 $interval = $graph_width / ($data_size);
415 $interval = $graph_width / ($data_size - 1);
417 my @fill = $self->_data_fill($series_counter, $self->_get_graph_box());
418 my $color = $self->_data_color($series_counter);
419 for (my $i = 0; $i < $data_size - 1; $i++) {
420 my $x1 = $left + $i * $interval;
421 my $x2 = $left + ($i + 1) * $interval;
423 $x1 += $has_columns * $interval / 2;
424 $x2 += $has_columns * $interval / 2;
426 my $y1 = $bottom + ($value_range - $data[$i] + $min_value)/$value_range * $size;
427 my $y2 = $bottom + ($value_range - $data[$i + 1] + $min_value)/$value_range * $size;
429 $img->line(x1 => $x1, y1 => $y1, x2 => $x2, y2 => $y2, aa => 1, color => $color) || die $img->errstr;
430 $img->circle(x => $x1, y => $y1, r => 3, aa => 1, filled => 1, @fill);
433 my $x2 = $left + ($data_size - 1) * $interval;
434 $x2 += $has_columns * $interval / 2;
436 my $y2 = $bottom + ($value_range - $data[$data_size - 1] + $min_value)/$value_range * $size;
438 $img->circle(x => $x2, y => $y2, r => 3, aa => 1, filled => 1, @fill);
442 $self->_set_series_counter($series_counter);
448 my $style = $self->{'_style'};
450 my $img = $self->_get_image();
452 my $max_value = $self->_get_max_value();
453 my $min_value = $self->_get_min_value();
454 my $column_count = $self->_get_column_count();
456 my $value_range = $max_value - $min_value;
458 my $width = $self->_get_number('width');
459 my $height = $self->_get_number('height');
460 my $size = $self->_get_number('size');
462 my $bottom = ($height - $size) / 2;
463 my $left = ($width - $size) / 2 + 1;
465 my $zero_position = int($bottom + $size - (-1*$min_value / $value_range) * ($size -1));
467 if ($self->_get_y_tics()) {
468 $self->_draw_y_tics();
470 if ($self->_get_labels()) {
471 $self->_draw_x_tics();
474 my $bar_width = int(($size)/ $column_count - 2);
477 if ($style->{'features'}{'outline'}) {
478 $outline_color = $self->_get_color('outline.line');
481 my $series_counter = $self->_get_series_counter() || 0;
482 my $col_series = $self->_get_data_series()->{'column'};
484 # This tracks the series we're in relative to the starting series - this way colors stay accurate, but the columns don't start out too far to the right.
485 my $column_series = 0;
487 # If there are stacked columns, non-stacked columns need to start one to the right of where they would otherwise
488 my $has_stacked_columns = (defined $self->_get_data_series()->{'stacked_column'} ? 1 : 0);
490 for (my $series_pos = 0; $series_pos < scalar @$col_series; $series_pos++) {
491 my $series = $col_series->[$series_pos];
492 my @data = @{$series->{'data'}};
493 my $data_size = scalar @data;
494 my $color = $self->_data_color($series_counter);
495 for (my $i = 0; $i < $data_size; $i++) {
496 my $x1 = int($left + $bar_width * (scalar @$col_series * $i + $series_pos)) + scalar @$col_series * $i + $series_pos;
497 if ($has_stacked_columns) {
498 $x1 += ($i + 1) * $bar_width + $i + 1;
500 my $x2 = $x1 + $bar_width;
502 my $y1 = int($bottom + ($value_range - $data[$i] + $min_value)/$value_range * $size);
504 my $color = $self->_data_color($series_counter);
506 # my @fill = $self->_data_fill($series_counter, [$x1, $y1, $x2, $zero_position]);
508 $img->box(xmin => $x1, xmax => $x2, ymin => $y1, ymax => $zero_position-1, color => $color, filled => 1);
509 if ($style->{'features'}{'outline'}) {
510 $img->box(xmin => $x1, xmax => $x2, ymin => $y1, ymax => $zero_position, color => $outline_color);
514 $img->box(xmin => $x1, xmax => $x2, ymin => $zero_position+1, ymax => $y1, color => $color, filled => 1);
515 if ($style->{'features'}{'outline'}) {
516 $img->box(xmin => $x1, xmax => $x2, ymin => $zero_position+1, ymax => $y1+1, color => $outline_color);
524 $self->_set_series_counter($series_counter);
528 sub _draw_stacked_columns {
530 my $style = $self->{'_style'};
532 my $img = $self->_get_image();
534 my $max_value = $self->_get_max_value();
535 my $min_value = $self->_get_min_value();
536 my $column_count = $self->_get_column_count();
537 my $value_range = $max_value - $min_value;
539 my $graph_box = $self->_get_graph_box();
540 my $left = $graph_box->[0] + 1;
541 my $bottom = $graph_box->[1];
542 my $size = $self->_get_number('size');
544 if ($self->_get_y_tics()) {
545 $self->_draw_y_tics();
547 if ($self->_get_labels()) {
548 $self->_draw_x_tics();
551 my $bar_width = int($size / $column_count -2);
552 my $column_series = 0;
553 if (my $column_series_data = $self->_get_data_series()->{'column'}) {
554 $column_series = (scalar @$column_series_data);
559 if ($style->{'features'}{'outline'}) {
560 $outline_color = $self->_get_color('outline.line');
563 my $zero_position = $bottom + $size - (-1*$min_value / $value_range) * ($size -1);
564 my $col_series = $self->_get_data_series()->{'stacked_column'};
565 my $series_counter = $self->_get_series_counter() || 0;
566 foreach my $series (@$col_series) {
567 my @data = @{$series->{'data'}};
568 my $data_size = scalar @data;
569 my $color = $self->_data_color($series_counter);
570 for (my $i = 0; $i < $data_size; $i++) {
571 my $x1 = int($left + $bar_width * ($column_series * $i)) + $column_series * $i;
572 # my $x1 = $left + $i * $size / ($data_size);
573 my $x2 = $x1 + $bar_width;
575 my $y1 = $bottom + ($value_range - $data[$i] + $min_value)/$value_range * $size;
578 $img->box(xmin => $x1, xmax => $x2, ymin => $y1, ymax => $zero_position-1, color => $color, filled => 1);
579 if ($style->{'features'}{'outline'}) {
580 $img->box(xmin => $x1, xmax => $x2, ymin => $y1, ymax => $zero_position, color => $outline_color);
584 $img->box(xmin => $x1, xmax => $x2, ymin => $zero_position+1, ymax => $y1, color => $color, filled => 1);
585 if ($style->{'features'}{'outline'}) {
586 $img->box(xmin => $x1, xmax => $x2, ymin => $zero_position+1, ymax => $y1+1, color => $outline_color);
593 $self->_set_series_counter($series_counter);
597 sub _add_data_series {
599 my $series_type = shift;
600 my $data_ref = shift;
601 my $series_name = shift;
603 my $graph_data = $self->{'graph_data'} || {};
605 my $series = $graph_data->{$series_type} || [];
607 push @$series, { data => $data_ref, series_name => $series_name };
609 $graph_data->{$series_type} = $series;
611 $self->{'graph_data'} = $graph_data;
617 =item set_y_tics($count)
619 Set the number of Y tics to use. Their value and position will be determined by the data range.
624 $_[0]->{'y_tics'} = $_[1];
628 return $_[0]->{'y_tics'};
633 my $min = $self->_get_min_value();
634 my $max = $self->_get_max_value();
635 my $tic_count = $self->_get_y_tics();
637 my $img = $self->_get_image();
638 my $graph_box = $self->_get_graph_box();
639 my $image_box = $self->_get_image_box();
641 my $interval = ($max - $min) / ($tic_count - 1);
643 my %text_info = $self->_text_style('legend')
646 my $tic_distance = ($graph_box->[3] - $graph_box->[1]) / ($tic_count - 1);
647 for my $count (0 .. $tic_count - 1) {
648 my $x1 = $graph_box->[0] - 5;
649 my $x2 = $graph_box->[0] + 5;
650 my $y1 = $graph_box->[3] - ($count * $tic_distance);
652 my $value = sprintf("%.2f", ($count*$interval)+$min);
656 my @box = $self->_text_bbox($value, 'legend')
659 $img->line(x1 => $x1, x2 => $x2, y1 => $y1, y2 => $y1, aa => 1, color => '000000');
662 my $height = $box[3];
664 $img->string(%text_info,
665 x => ($x1 - $width - 3),
666 y => ($y1 + ($height / 2)),
676 my $img = $self->_get_image();
677 my $graph_box = $self->_get_graph_box();
678 my $image_box = $self->_get_image_box();
680 my $labels = $self->_get_labels();
682 my $tic_count = (scalar @$labels) - 1;
684 my $has_columns = (defined $self->_get_data_series()->{'column'} || defined $self->_get_data_series()->{'stacked_column'});
686 # If we have columns, we want the x-ticks to show up in the middle of the column, not on the left edge
687 my $denominator = $tic_count;
691 my $tic_distance = ($graph_box->[2] - $graph_box->[0]) / ($denominator);
692 my %text_info = $self->_text_style('legend')
695 for my $count (0 .. $tic_count) {
696 my $label = $labels->[$count];
697 my $x1 = $graph_box->[0] + ($tic_distance * $count);
700 $x1 += $tic_distance / 2;
702 my $y1 = $graph_box->[3] + 5;
703 my $y2 = $graph_box->[3] - 5;
705 $img->line(x1 => $x1, x2 => $x1, y1 => $y1, y2 => $y2, aa => 1, color => '000000');
707 my @box = $self->_text_bbox($label, 'legend')
711 my $height = $box[3];
713 $img->string(%text_info,
714 x => ($x1 - ($width / 2)),
715 y => ($y1 + ($height + 5)),
725 if (!defined $self->_get_data_series() || !keys %{$self->_get_data_series()}) {
726 return $self->_error("No data supplied");
729 my $data = $self->_get_data_series();
730 if (defined $data->{'line'} && !scalar @{$data->{'line'}->[0]->{'data'}}) {
731 return $self->_error("No values in data series");
733 if (defined $data->{'column'} && !scalar @{$data->{'column'}->[0]->{'data'}}) {
734 return $self->_error("No values in data series");
736 if (defined $data->{'stacked_column'} && !scalar @{$data->{'stacked_column'}->[0]->{'data'}}) {
737 return $self->_error("No values in data series");
743 sub _set_column_count { $_[0]->{'column_count'} = $_[1]; }
744 sub _set_min_value { $_[0]->{'min_value'} = $_[1]; }
745 sub _set_max_value { $_[0]->{'max_value'} = $_[1]; }
746 sub _set_image_box { $_[0]->{'image_box'} = $_[1]; }
747 sub _set_graph_box { $_[0]->{'graph_box'} = $_[1]; }
748 sub _set_series_counter { $_[0]->{'series_counter'} = $_[1]; }
749 sub _get_column_count { return $_[0]->{'column_count'} }
750 sub _get_min_value { return $_[0]->{'min_value'} }
751 sub _get_max_value { return $_[0]->{'max_value'} }
752 sub _get_image_box { return $_[0]->{'image_box'} }
753 sub _get_graph_box { return $_[0]->{'graph_box'} }
754 sub _get_series_counter { return $_[0]->{'series_counter'} }