=head1 NAME
- Imager::Graph::Vertical- A super class for line/bar/column charts
+Imager::Graph::Vertical- A super class for line/bar/column/area charts
+
+=head1 SYNOPSIS
+
+ use Imager::Graph::Vertical;
+
+ my $vert = Imager::Graph::Vertical->new;
+ $vert->add_column_data_series(\@data, "My data");
+ $vert->add_area_data_series(\@data2, "Area data");
+ $vert->add_stacked_column_data_series(\@data3, "stacked data");
+ $vert->add_line_data_series(\@data4, "line data");
+ my $img = $vert->draw();
+
+ use Imager::Graph::Column;
+ my $column = Imager::Graph::Column->new;
+ $column->add_data_series(\@data, "my data");
+ my $img = $column->draw();
+
+=head1 DESCRIPTION
+
+This is a base class that implements the functionality for column,
+stacked column, line and area charts where the dependent variable is
+represented in changes in the vertical position.
+
+The subclasses, L<Imager::Graph::Column>,
+L<Imager::Graph::StackedColumn>, L<Imager::Graph::Line> and
+L<Imager::Graph::Area> simply provide default data series types.
+
+=head1 METHODS
=cut
use vars qw(@ISA);
use Imager::Graph;
@ISA = qw(Imager::Graph);
+use Imager::Fill;
use constant STARTING_MIN_VALUE => 99999;
-=over 4
+=over
=item add_data_series(\@data, $series_name)
-Add a data series to the graph, of the default type.
+Add a data series to the graph, of the default type. This requires
+that the graph object be one of the derived graph classes.
=cut
return;
}
-
=item set_y_max($value)
-Sets the maximum y value to be displayed. This will be ignored if the y_max is lower than the highest value.
+Sets the maximum y value to be displayed. This will be ignored if the
+y_max is lower than the highest value.
=cut
=item set_y_min($value)
-Sets the minimum y value to be displayed. This will be ignored if the y_min is higher than the lowest value.
+Sets the minimum y value to be displayed. This will be ignored if the
+y_min is higher than the lowest value.
=cut
=item set_column_padding($int)
-Sets the padding between columns. This is a percentage of the column width. Defaults to 0.
+Sets the padding between columns. This is a percentage of the column
+width. Defaults to 0.
=cut
=item set_range_padding($percentage)
-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.
+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.
-Defaults to 10. This attribute is ignored for positive numbers if set_y_max() has been called, and ignored for negative numbers if set_y_min() has been called.
+Defaults to 10. This attribute is ignored for positive numbers if
+set_y_max() has been called, and ignored for negative numbers if
+set_y_min() has been called.
=cut
my $style = $self->{_style};
+ $self->_make_img
+ or return;
+
my $img = $self->_get_image()
or return;
# Scale the graph box down to the widest graph that can cleanly hold the # of columns.
return unless $self->_get_data_range();
- $self->_remove_tics_from_chart_box(\@chart_box);
+ $self->_remove_tics_from_chart_box(\@chart_box, \%opts);
my $column_count = $self->_get_column_count();
my $width = $self->_get_number('width');
$self->_set_graph_box(\@graph_box);
my @fill_box = ( $left, $top, $left+$graph_width, $top+$graph_height );
- if ($self->{_style}{features}{graph_outline}) {
- $img->box(
- color => $self->_get_color('graph.outline'),
- xmin => $left,
- xmax => $left+$graph_width,
- ymin => $top,
- ymax => $top+$graph_height,
- );
+ if ($self->_feature_enabled("graph_outline")) {
+ my @line = $self->_get_line("graph.outline")
+ or return;
+
+ $self->_box(
+ @line,
+ box => \@fill_box,
+ img => $img,
+ );
++$fill_box[0];
++$fill_box[1];
--$fill_box[2];
$img->box(
$self->_get_fill('graph.fill'),
box => \@fill_box,
- );
+ );
my $min_value = $self->_get_min_value();
my $max_value = $self->_get_max_value();
);
}
+ $self->_reset_series_counter();
+
if ($self->_get_data_series()->{'stacked_column'}) {
return unless $self->_draw_stacked_columns();
}
if ($self->_get_y_tics()) {
$self->_draw_y_tics();
}
- if ($self->_get_labels()) {
- $self->_draw_x_tics();
+ if ($self->_get_labels(\%opts)) {
+ $self->_draw_x_tics(\%opts);
}
return $self->_get_image();
my $y2 = $bottom + ($value_range - $data[$data_size - 1] + $min_value)/$value_range * $graph_height;
- push @marker_positions, [$x2, $y2];
- foreach my $position (@marker_positions) {
- $self->_draw_line_marker($position->[0], $position->[1], $series_counter);
+ if ($self->_feature_enabled("linemarkers")) {
+ push @marker_positions, [$x2, $y2];
+ foreach my $position (@marker_positions) {
+ $self->_draw_line_marker($position->[0], $position->[1], $series_counter);
+ }
}
$series_counter++;
}
my @fill = $self->_area_data_fill($series_counter, [$left, $bottom, $right, $top]);
$img->polygon(points => [@polygon_points], @fill);
- push @marker_positions, [$x2, $y2];
- foreach my $position (@marker_positions) {
- $self->_draw_line_marker($position->[0], $position->[1], $series_counter);
+ if ($self->_feature_enabled("areamarkers")) {
+ push @marker_positions, [$x2, $y2];
+ foreach my $position (@marker_positions) {
+ $self->_draw_line_marker($position->[0], $position->[1], $series_counter);
+ }
}
$series_counter++;
}
return 1;
}
-
-
-sub _line_marker {
- my ($self, $index) = @_;
-
- my $markers = $self->{'_style'}{'line_markers'};
- if (!$markers) {
- return;
- }
- my $marker = $markers->[$index % @$markers];
-
- return $marker;
-}
-
-sub _draw_line_marker {
- my $self = shift;
- my ($x1, $y1, $series_counter) = @_;
-
- my $img = $self->_get_image();
-
- my $style = $self->_line_marker($series_counter);
- return unless $style;
-
- my $type = $style->{'shape'};
- my $radius = $style->{'radius'};
-
- my $line_aa = $self->_get_number("lineaa");
- my $fill_aa = $self->_get_number("fill.aa");
- if ($type eq 'circle') {
- my @fill = $self->_data_fill($series_counter, [$x1 - $radius, $y1 - $radius, $x1 + $radius, $y1 + $radius]);
- $img->circle(x => $x1, y => $y1, r => $radius, aa => $fill_aa, filled => 1, @fill);
- }
- elsif ($type eq 'square') {
- my @fill = $self->_data_fill($series_counter, [$x1 - $radius, $y1 - $radius, $x1 + $radius, $y1 + $radius]);
- $img->box(xmin => $x1 - $radius, ymin => $y1 - $radius, xmax => $x1 + $radius, ymax => $y1 + $radius, @fill);
- }
- elsif ($type eq 'diamond') {
- # The gradient really doesn't work for diamond
- my $color = $self->_data_color($series_counter);
- $img->polygon(
- points => [
- [$x1 - $radius, $y1],
- [$x1, $y1 + $radius],
- [$x1 + $radius, $y1],
- [$x1, $y1 - $radius],
- ],
- filled => 1, color => $color, aa => $fill_aa);
- }
- elsif ($type eq 'triangle') {
- # The gradient really doesn't work for triangle
- my $color = $self->_data_color($series_counter);
- $img->polygon(
- points => [
- [$x1 - $radius, $y1 + $radius],
- [$x1 + $radius, $y1 + $radius],
- [$x1, $y1 - $radius],
- ],
- filled => 1, color => $color, aa => $fill_aa);
-
- }
- elsif ($type eq 'x') {
- my $color = $self->_data_color($series_counter);
- $img->line(x1 => $x1 - $radius, y1 => $y1 -$radius, x2 => $x1 + $radius, y2 => $y1+$radius, aa => $line_aa, color => $color) || die $img->errstr;
- $img->line(x1 => $x1 + $radius, y1 => $y1 -$radius, x2 => $x1 - $radius, y2 => $y1+$radius, aa => $line_aa, color => $color) || die $img->errstr;
- }
- elsif ($type eq 'plus') {
- my $color = $self->_data_color($series_counter);
- $img->line(x1 => $x1, y1 => $y1 -$radius, x2 => $x1, y2 => $y1+$radius, aa => $line_aa, color => $color) || die $img->errstr;
- $img->line(x1 => $x1 + $radius, y1 => $y1, x2 => $x1 - $radius, y2 => $y1, aa => $line_aa, color => $color) || die $img->errstr;
- }
-}
-
sub _draw_columns {
my $self = shift;
my $style = $self->{'_style'};
return;
}
+=back
+
+=head1 FEATURES
+
=over
=item show_horizontal_gridlines()
-Shows horizontal gridlines at the y-tics.
+Feature: horizontal_gridlines
+X<horizontal_gridlines>X<features, horizontal_gridlines>
+
+Enables the C<horizontal_gridlines> feature, which shows horizontal
+gridlines at the y-tics.
+
+The style of the gridlines can be controlled with the
+set_horizontal_gridline_style() method (or by setting the hgrid
+style).
=cut
sub show_horizontal_gridlines {
- $_[0]->{'custom_style'}->{'horizontal_gridlines'} = 1;
+ $_[0]->{'custom_style'}{features}{'horizontal_gridlines'} = 1;
+}
+
+=item set_horizontal_gridline_style(style => $style, color => $color)
+
+Style: hgrid.
+X<hgrid>X<style parameters, hgrid>
+
+Set the style and color of horizonal gridlines.
+
+See: L<Imager::Graph/"Line styles">
+
+=cut
+
+sub set_horizontal_gridline_style {
+ my ($self, %opts) = @_;
+
+ $self->{custom_style}{hgrid} ||= {};
+ @{$self->{custom_style}{hgrid}}{keys %opts} = values %opts;
+
+ return 1;
+}
+
+=item show_graph_outline($flag)
+
+Feature: graph_outline
+X<graph_outline>X<features, graph_outline>
+
+If no flag is supplied, unconditionally enable the graph outline.
+
+If $flag is supplied, enable/disable the graph_outline feature based
+on that.
+
+Enabled by default.
+
+=cut
+
+sub show_graph_outline {
+ my ($self, $flag) = @_;
+
+ @_ == 1 and $flag = 1;
+
+ $self->{custom_style}{features}{graph_outline} = $flag;
+
+ return 1;
+}
+
+=item set_graph_outline_style(color => ...)
+
+=item set_graph_outline_style(style => ..., color => ...)
+
+Style: graph.outline
+X<graph.outline>X<style parameters, graph.outline>
+
+Sets the style of the graph outline.
+
+Default: the style C<fg>.
+
+=cut
+
+sub set_graph_outline_style {
+ my ($self, %opts) = @_;
+
+ $self->{custom_style}{graph}{outline} = \%opts;
+
+ return 1;
+}
+
+=item set_graph_fill_style(I<fill parameters>)
+
+Style: graph.fill
+X<graph.fill>X<style parameters, graph.fill>
+
+Set the fill used to fill the graph data area.
+
+Default: the style C<bg>.
+
+eg.
+
+ $graph->set_graph_fill_style(solid => "FF000020", combine => "normal");
+
+=cut
+
+sub set_graph_fill_style {
+ my ($self, %opts) = @_;
+
+ $self->{custom_style}{graph}{fill} = \%opts;
+
+ return 1;
+}
+
+=item show_area_markers()
+
+=item show_area_markers($value)
+
+Feature: areamarkers.
+
+If $value is missing or true, draw markers along the top of area data
+series.
+
+eg.
+
+ $chart->show_area_markers();
+
+=cut
+
+sub show_area_markers {
+ my ($self, $value) = @_;
+
+ @_ > 1 or $value = 1;
+
+ $self->{custom_style}{features}{areamarkers} = $value;
+
+ return 1;
+}
+
+=item show_line_markers()
+
+=item show_line_markers($value)
+
+Feature: linemarkers.
+
+If $value is missing or true, draw markers on a line data series.
+
+Note: line markers are drawn by default.
+
+=cut
+
+sub show_line_markers {
+ my ($self, $value) = @_;
+
+ @_ > 1 or $value = 1;
+
+ $self->{custom_style}{features}{linemarkers} = $value;
+
+ return 1;
}
=item use_automatic_axis()
-Automatically scale the Y axis, based on L<Chart::Math::Axis>. If Chart::Math::Axis isn't installed, this sets an error and returns undef. Returns 1 if it is installed.
+Automatically scale the Y axis, based on L<Chart::Math::Axis>. If
+Chart::Math::Axis isn't installed, this sets an error and returns
+undef. Returns 1 if it is installed.
=cut
return 1;
}
-
=item set_y_tics($count)
-Set the number of Y tics to use. Their value and position will be determined by the data range.
+Set the number of Y tics to use. Their value and position will be
+determined by the data range.
=cut
}
sub _remove_tics_from_chart_box {
- my $self = shift;
- my $chart_box = shift;
+ my ($self, $chart_box, $opts) = @_;
# XXX - bad default
my $tic_width = $self->_get_y_tic_width() || 10;
my @y_tic_box = ($chart_box->[0], $chart_box->[1], $chart_box->[0] + $tic_width, $chart_box->[3]);
# XXX - bad default
- my $tic_height = $self->_get_x_tic_height() || 10;
+ my $tic_height = $self->_get_x_tic_height($opts) || 10;
my @x_tic_box = ($chart_box->[0], $chart_box->[3] - $tic_height, $chart_box->[2], $chart_box->[3]);
$self->_remove_box($chart_box, \@y_tic_box);
$self->_remove_box($chart_box, \@y_tic_tops);
# Make sure that the first and last label fit
- if (my $labels = $self->_get_labels()) {
+ if (my $labels = $self->_get_labels($opts)) {
if (my @box = $self->_text_bbox($labels->[0], 'legend')) {
my @remove_box = ($chart_box->[0],
$chart_box->[1],
}
}
-sub _get_y_tic_width{
+sub _get_y_tic_width {
my $self = shift;
my $min = $self->_get_min_value();
my $max = $self->_get_max_value();
my $max_width = 0;
for my $count (0 .. $tic_count - 1) {
- my $value = sprintf("%.2f", ($count*$interval)+$min);
+ my $value = ($count*$interval)+$min;
+ if ($interval < 1 || ($value != int($value))) {
+ $value = sprintf("%.2f", $value);
+ }
my @box = $self->_text_bbox($value, 'legend');
my $width = $box[2] - $box[0];
}
sub _get_x_tic_height {
- my $self = shift;
+ my ($self, $opts) = @_;
- my $labels = $self->_get_labels();
+ my $labels = $self->_get_labels($opts);
if (!$labels) {
return;
or return;
my $line_style = $self->_get_color('outline.line');
- my $show_gridlines = $self->_get_number('horizontal_gridlines');
+ my $show_gridlines = $self->{_style}{features}{'horizontal_gridlines'};
+ my @grid_line = $self->_get_line("hgrid");
my $tic_distance = ($graph_box->[3] - $graph_box->[1]) / ($tic_count - 1);
for my $count (0 .. $tic_count - 1) {
my $x1 = $graph_box->[0] - 5;
text => $value
);
- if ($show_gridlines) {
- # XXX - line styles!
- for (my $i = $graph_box->[0]; $i < $graph_box->[2]; $i += 6) {
- my $x1 = $i;
- my $x2 = $i + 2;
- if ($x2 > $graph_box->[2]) { $x2 = $graph_box->[2]; }
- $img->line(x1 => $x1, x2 => $x2, y1 => $y1, y2 => $y1, aa => 1, color => $line_style);
- }
+ if ($show_gridlines && $y1 != $graph_box->[1] && $y1 != $graph_box->[3]) {
+ $self->_line(x1 => $graph_box->[0], y1 => $y1,
+ x2 => $graph_box->[2], y2 => $y1,
+ img => $img,
+ @grid_line);
}
}
}
sub _draw_x_tics {
- my $self = shift;
+ my ($self, $opts) = @_;
my $img = $self->_get_image();
my $graph_box = $self->_get_graph_box();
my $image_box = $self->_get_image_box();
- my $labels = $self->_get_labels();
+ my $labels = $self->_get_labels($opts);
my $tic_count = (scalar @$labels) - 1;
sub _get_max_value { return $_[0]->{'max_value'} }
sub _get_image_box { return $_[0]->{'image_box'} }
sub _get_graph_box { return $_[0]->{'graph_box'} }
+sub _reset_series_counter { $_[0]->{series_counter} = 0 }
sub _get_series_counter { return $_[0]->{'series_counter'} }
sub _style_defs {
{
opacity => 0.5,
};
- push @{$work{features}}, qw/graph_outline graph_fill/;
+ push @{$work{features}}, qw/graph_outline graph_fill linemarkers/;
+ $work{hgrid} =
+ {
+ color => "lookup(fg)",
+ style => "solid",
+ };
return \%work;
}
sub _composite {
my ($self) = @_;
- return ( $self->SUPER::_composite(), "graph" );
+ return ( $self->SUPER::_composite(), "graph", "hgrid" );
}
1;
projects / imager-graph.git / blobdiff