2 # vim: softtabstop=4 tabstop=4 shiftwidth=4 ft=perl expandtab smarttab
11 use List::Util qw(sum);
13 our $VERSION = '0.10.1';
15 print __PACKAGE__.' is version: '.$VERSION.$/ if($ENV{'PDF_TABLE_DEBUG'});
17 ############################################################
21 # Parameters are meta information about the PDF
23 # $pdf = PDF::Table->new();
25 ############################################################
30 my $class = ref($type) || $type;
32 bless ($self, $class);
34 # Pass all the rest to init for validation and initialisation
42 my ($self, $pdf, $page, $data, %options ) = @_;
44 # Check and set default values
45 $self->set_defaults();
47 # Check and set mandatory params
49 $self->set_page($page);
50 $self->set_data($data);
51 $self->set_options(\%options);
59 $self->{'font_size'} = 12;
63 my ($self, $pdf) = @_;
64 $self->{'pdf'} = $pdf;
68 my ($self, $page) = @_;
69 if ( defined($page) && ref($page) ne 'PDF::API2::Page' ){
71 if( ref($self->{'pdf'}) eq 'PDF::API2' ){
72 $self->{'page'} = $self->{'pdf'}->page();
74 carp 'Warning: Page must be a PDF::API2::Page object but it seems to be: '.ref($page).$/;
75 carp 'Error: Cannot set page from passed PDF object either as it is invalid!'.$/;
79 $self->{'page'} = $page;
84 my ($self, $data) = @_;
89 my ($self, $options) = @_;
93 ############################################################
95 # text_block - utility method to build multi-paragraph blocks of text
97 ############################################################
102 my $text_object = shift;
103 my $text = shift; # The text to be displayed
104 my %arg = @_; # Additional Arguments
106 my ( $align, $xpos, $ypos, $xbase, $ybase, $line_width, $wordspace, $endw , $width, $height) =
107 ( undef , undef, undef, undef , undef , undef , undef , undef , undef , undef );
108 my @line = (); # Temp data array with words on one line
109 my %width = (); # The width of every unique word in the givven text
111 # Try to provide backward compatibility
112 foreach my $key (keys %arg)
115 if($newkey =~ s#^-##)
117 $arg{$newkey} = $arg{$key};
124 # Lets check mandatory parameters with no default values
126 $xbase = $arg{'x'} || -1;
127 $ybase = $arg{'y'} || -1;
128 $width = $arg{'w'} || -1;
129 $height = $arg{'h'} || -1;
130 unless( $xbase > 0 ){ carp "Error: Left Edge of Block is NOT defined!\n"; return; }
131 unless( $ybase > 0 ){ carp "Error: Base Line of Block is NOT defined!\n"; return; }
132 unless( $width > 0 ){ carp "Error: Width of Block is NOT defined!\n"; return; }
133 unless( $height > 0 ){ carp "Error: Height of Block is NOT defined!\n"; return; }
134 # Check if any text to display
135 unless( defined( $text) and length($text) > 0 )
137 carp "Warning: No input text found. Trying to add dummy '-' and not to break everything.\n";
141 # Strip any <CR> and Split the text into paragraphs
143 my @paragraphs = split(/\n/, $text);
145 # Width between lines in pixels
146 my $line_space = defined $arg{'lead'} && $arg{'lead'} > 0 ? $arg{'lead'} : 12;
148 # Calculate width of all words
149 my $space_width = $text_object->advancewidth("\x20");
150 my @words = split(/\s+/, $text);
153 next if exists $width{$_};
154 $width{$_} = $text_object->advancewidth($_);
157 my @paragraph = split(' ', shift(@paragraphs));
159 my $first_paragraph = 1;
164 $ypos = $ybase + $line_space;
165 my $bottom_border = $ypos - $height;
166 # While we can add another line
167 while ( $ypos >= $bottom_border + $line_space )
169 # Is there any text to render ?
172 # Finish if nothing left
173 last unless scalar @paragraphs;
174 # Else take one line from the text
175 @paragraph = split(' ', shift( @paragraphs ) );
177 $ypos -= $arg{'parspace'} if $arg{'parspace'};
178 last unless $ypos >= $bottom_border;
180 $ypos -= $line_space;
183 # While there's room on the line, add another word
186 if( $first_line && exists $arg{'hang'} )
188 my $hang_width = $text_object->advancewidth($arg{'hang'});
190 $text_object->translate( $xpos, $ypos );
191 $text_object->text( $arg{'hang'} );
193 $xpos += $hang_width;
194 $line_width += $hang_width;
195 $arg{'indent'} += $hang_width if $first_paragraph;
197 elsif( $first_line && exists $arg{'flindent'} && $arg{'flindent'} > 0 )
199 $xpos += $arg{'flindent'};
200 $line_width += $arg{'flindent'};
202 elsif( $first_paragraph && exists $arg{'fpindent'} && $arg{'fpindent'} > 0 )
204 $xpos += $arg{'fpindent'};
205 $line_width += $arg{'fpindent'};
207 elsif (exists $arg{'indent'} && $arg{'indent'} > 0 )
209 $xpos += $arg{'indent'};
210 $line_width += $arg{'indent'};
213 # Lets take from paragraph as many words as we can put into $width - $indent;
214 while ( @paragraph and $text_object->advancewidth( join("\x20", @line)."\x20" . $paragraph[0]) +
215 $line_width < $width )
217 push(@line, shift(@paragraph));
219 $line_width += $text_object->advancewidth(join('', @line));
221 # calculate the space width
222 if( $arg{'align'} eq 'fulljustify' or ($arg{'align'} eq 'justify' and @paragraph))
224 @line = split(//,$line[0]) if (scalar(@line) == 1) ;
225 $wordspace = ($width - $line_width) / (scalar(@line) - 1);
230 $align=($arg{'align'} eq 'justify') ? 'left' : $arg{'align'};
231 $wordspace = $space_width;
233 $line_width += $wordspace * (scalar(@line) - 1);
235 if( $align eq 'justify')
237 foreach my $word (@line)
239 $text_object->translate( $xpos, $ypos );
240 $text_object->text( $word );
241 $xpos += ($width{$word} + $wordspace) if (@line);
247 # calculate the left hand position of the line
248 if( $align eq 'right' )
250 $xpos += $width - $line_width;
252 elsif( $align eq 'center' )
254 $xpos += ( $width / 2 ) - ( $line_width / 2 );
258 $text_object->translate( $xpos, $ypos );
259 $endw = $text_object->text( join("\x20", @line));
263 unshift(@paragraphs, join(' ',@paragraph)) if scalar(@paragraph);
264 return ($endw, $ypos, join("\n", @paragraphs))
268 ################################################################
269 # table - utility method to build multi-row, multicolumn tables
270 ################################################################
279 #=====================================
280 # Mandatory Arguments Section
281 #=====================================
282 unless($pdf and $page and $data)
284 carp "Error: Mandatory parameter is missing pdf/page/data object!\n";
288 # Validate mandatory argument data type
289 croak "Error: Invalid pdf object received." unless (ref($pdf) eq 'PDF::API2');
290 croak "Error: Invalid page object received." unless (ref($page) eq 'PDF::API2::Page');
291 croak "Error: Invalid data received." unless ((ref($data) eq 'ARRAY') && scalar(@$data));
292 croak "Error: Missing required settings." unless (scalar(keys %arg));
294 # Validate settings key
295 my %valid_settings_key = (
308 background_color => 1,
309 background_color_odd => 1,
310 background_color_even => 1,
313 horizontal_borders => 1,
314 vertical_borders => 1,
319 font_color_even => 1,
321 background_color_odd => 1,
322 background_color_even => 1,
328 max_word_length => 1,
329 cell_render_hook => 1,
331 num_header_rows => 1,
333 foreach my $key (keys %arg)
335 # Provide backward compatibility
336 $arg{$key} = delete $arg{"-$key"} if $key =~ s/^-//;
338 croak "Error: Invalid setting key '$key' received."
339 unless exists $valid_settings_key{$key};
344 #TODO: Add code for header props compatibility and col_props comp....
346 my ( $xbase, $ybase, $width, $height ) = ( undef, undef, undef, undef );
347 # Could be 'int' or 'real' values
348 $xbase = $arg{'x' } || -1;
349 $ybase = $arg{'start_y'} || -1;
350 $width = $arg{'w' } || -1;
351 $height = $arg{'start_h'} || -1;
353 # Global geometry parameters are also mandatory.
354 unless( $xbase > 0 ){ carp "Error: Left Edge of Table is NOT defined!\n"; return; }
355 unless( $ybase > 0 ){ carp "Error: Base Line of Table is NOT defined!\n"; return; }
356 unless( $width > 0 ){ carp "Error: Width of Table is NOT defined!\n"; return; }
357 unless( $height > 0 ){ carp "Error: Height of Table is NOT defined!\n"; return; }
359 # Ensure default values for -next_y and -next_h
360 my $next_y = $arg{'next_y'} || $arg{'start_y'} || 0;
361 my $next_h = $arg{'next_h'} || $arg{'start_h'} || 0;
364 my $txt = $page->text;
366 # Set Default Properties
367 my $fnt_name = $arg{'font' } || $pdf->corefont('Times',-encode => 'utf8');
368 my $fnt_size = $arg{'font_size' } || 12;
369 my $fnt_underline = $arg{'font_underline' } || undef; # merely stating undef is the intended default
370 my $max_word_len = $arg{'max_word_length' } || 20;
372 #=====================================
373 # Table Header Section
374 #=====================================
375 # Disable header row into the table
376 my $header_props = undef;
377 my (@header_rows, @header_row_cell_props);
378 # Check if the user enabled it ?
379 if(defined $arg{'header_props'} and ref( $arg{'header_props'}) eq 'HASH')
381 # Transfer the reference to local variable
382 $header_props = $arg{'header_props'};
384 # Check other params and put defaults if needed
385 $header_props->{'repeat' } = $header_props->{'repeat' } || 0;
386 $header_props->{'font' } = $header_props->{'font' } || $fnt_name;
387 $header_props->{'font_color' } = $header_props->{'font_color' } || '#000066';
388 $header_props->{'font_size' } = $header_props->{'font_size' } || $fnt_size + 2;
389 $header_props->{'font_underline'} = $header_props->{'font_underline'} || $fnt_underline;
390 $header_props->{'bg_color' } = $header_props->{'bg_color' } || '#FFFFAA';
391 $header_props->{'justify' } = $header_props->{'justify' };
392 $header_props->{num_header_rows } = $arg{num_header_rows } || 1;
394 #=====================================
395 # Other Parameters check
396 #=====================================
397 my $lead = $arg{'lead' } || $fnt_size;
398 my $pad_left = $arg{'padding_left' } || $arg{'padding'} || 0;
399 my $pad_right = $arg{'padding_right' } || $arg{'padding'} || 0;
400 my $pad_top = $arg{'padding_top' } || $arg{'padding'} || 0;
401 my $pad_bot = $arg{'padding_bottom'} || $arg{'padding'} || 0;
402 my $default_text = $arg{'default_text' } // '-';
403 my $line_w = defined $arg{'border'} ? $arg{'border'} : 1 ;
404 my $horiz_borders = defined $arg{'horizontal_borders'}
405 ? $arg{'horizontal_borders'}
407 my $vert_borders = defined $arg{'vertical_borders'}
408 ? $arg{'vertical_borders'}
411 my $background_color_even = $arg{'background_color_even' } || $arg{'background_color'} || undef;
412 my $background_color_odd = $arg{'background_color_odd' } || $arg{'background_color'} || undef;
413 my $font_color_even = $arg{'font_color_even' } || $arg{'font_color' } || 'black';
414 my $font_color_odd = $arg{'font_color_odd' } || $arg{'font_color' } || 'black';
415 my $border_color = $arg{'border_color' } || 'black';
417 my $min_row_h = $fnt_size + $pad_top + $pad_bot;
418 my $row_h = defined ($arg{'row_height'})
420 ($arg{'row_height'} > $min_row_h)
422 $arg{'row_height'} : $min_row_h;
426 my $cell_props = $arg{cell_props} || []; # per cell properties
428 #If there is no valid data array reference warn and return!
429 if(ref $data ne 'ARRAY')
431 carp "Passed table data is not an ARRAY reference. It's actually a ref to ".ref($data);
432 return ($page,0,$cur_y);
435 # Copy the header row if header is enabled
436 if (defined $header_props) {
437 map { push @header_rows, $$data[$_] } (0..$header_props->{num_header_rows} - 1);
438 map { push @header_row_cell_props, $$cell_props[$_] } (0..$header_props->{num_header_rows} - 1);
440 # Determine column widths based on content
442 # an arrayref whose values are a hashref holding
443 # the minimum and maximum width of that column
444 my $col_props = $arg{'column_props'} || [];
446 # An array ref of arrayrefs whose values are
447 # the actual widths of the column/row intersection
448 my $row_col_widths = [];
449 # An array ref with the widths of the header row
450 my @header_row_widths;
452 # Scalars that hold sum of the maximum and minimum widths of all columns
453 my ( $max_col_w , $min_col_w ) = ( 0,0 );
454 my ( $row, $col_name, $col_fnt_size, $col_fnt_underline, $space_w );
456 my $word_widths = {};
457 my $rows_height = [];
460 for( my $row_idx = 0; $row_idx < scalar(@$data) ; $row_idx++ )
462 push @header_row_widths, [] if $row_idx < $header_props->{num_header_rows};
464 my $column_widths = []; #holds the width of each column
465 # Init the height for this row
466 $rows_height->[$row_idx] = 0;
468 for( my $column_idx = 0; $column_idx < scalar(@{$data->[$row_idx]}) ; $column_idx++ )
470 # look for font information for this column
471 my ($cell_font, $cell_font_size, $cell_font_underline);
473 if( !$row_idx and ref $header_props )
475 $cell_font = $header_props->{'font'};
476 $cell_font_size = $header_props->{'font_size'};
477 $cell_font_underline = $header_props->{'font_underline'};
480 # Get the most specific value if none was already set from header_props
481 $cell_font ||= $cell_props->[$row_idx][$column_idx]->{'font'}
482 || $col_props->[$column_idx]->{'font'}
485 $cell_font_size ||= $cell_props->[$row_idx][$column_idx]->{'font_size'}
486 || $col_props->[$column_idx]->{'font_size'}
489 $cell_font_underline ||= $cell_props->[$row_idx][$column_idx]->{'font_underline'}
490 || $col_props->[$column_idx]->{'font_underline'}
496 $txt->font( $cell_font, $cell_font_size );
498 # Set row height to biggest font size from row's cells
499 if( $cell_font_size > $rows_height->[$row_idx] )
501 $rows_height->[$row_idx] = $cell_font_size;
504 # This should fix a bug with very long words like serial numbers etc.
505 if( $max_word_len > 0 )
507 $data->[$row_idx][$column_idx] =~ s#(\S{$max_word_len})(?=\S)#$1 #g;
510 # Init cell size limits
511 $space_w = $txt->advancewidth( "\x20" );
512 $column_widths->[$column_idx] = 0;
516 my @words = split( /\s+/, $data->[$row_idx][$column_idx] );
520 unless( exists $word_widths->{$_} )
521 { # Calculate the width of every word and add the space width to it
522 $word_widths->{$_} = $txt->advancewidth( $_ ) + $space_w;
525 $column_widths->[$column_idx] += $word_widths->{$_};
526 $min_col_w = $word_widths->{$_} if( $word_widths->{$_} > $min_col_w );
527 $max_col_w += $word_widths->{$_};
530 $min_col_w += $pad_left + $pad_right;
531 $max_col_w += $pad_left + $pad_right;
532 $column_widths->[$column_idx] += $pad_left + $pad_right;
534 # Keep a running total of the overall min and max widths
535 $col_props->[$column_idx]->{'min_w'} ||= 0;
536 $col_props->[$column_idx]->{'max_w'} ||= 0;
538 if( $min_col_w > $col_props->[$column_idx]->{'min_w'} )
539 { # Calculated Minimum Column Width is more than user-defined
540 $col_props->[$column_idx]->{'min_w'} = $min_col_w ;
543 if( $max_col_w > $col_props->[$column_idx]->{'max_w'} )
544 { # Calculated Maximum Column Width is more than user-defined
545 $col_props->[$column_idx]->{'max_w'} = $max_col_w ;
547 }#End of for(my $column_idx....
549 $row_col_widths->[$row_idx] = $column_widths;
551 # Copy the calculated row properties of header row.
552 if (ref $header_props && $row_idx < $header_props->{num_header_rows}) {
553 push @header_row_widths, [ @{ $column_widths } ];
557 # Calc real column widths and expand table width if needed.
558 my $calc_column_widths;
559 ($calc_column_widths, $width) = CalcColumnWidths( $col_props, $width );
560 my $num_cols = scalar @{ $calc_column_widths };
562 # Lets draw what we have!
564 # Store header row height for later use if headers have to be repeated
565 my @header_row_heights = @$rows_height[0 .. $header_props->{num_header_rows}-1];
567 my ( $gfx, $gfx_bg, $background_color, $font_color, $bot_marg, $table_top_y, $text_start);
569 my $remaining_header_rows = $header_props ? $header_props->{num_header_rows} : 0;
571 # Each iteration adds a new page as neccessary
572 while(scalar(@{$data}))
575 my $columns_number = 0;
579 $table_top_y = $ybase;
580 $bot_marg = $table_top_y - $height;
582 # Check for safety reasons
584 { # This warning should remain i think
585 #carp "!!! Warning: !!! Incorrect Table Geometry! start_h (${height}) is above start_y (${table_top_y}). Setting bottom margin to end of sheet!\n";
592 if(ref $arg{'new_page_func'})
594 $page = &{$arg{'new_page_func'}};
601 $table_top_y = $next_y;
602 $bot_marg = $table_top_y - $next_h;
604 # Check for safety reasons
606 { # This warning should remain i think
607 #carp "!!! Warning: !!! Incorrect Table Geometry! next_y or start_y (${next_y}) is above next_h or start_h (${next_h}). Setting bottom margin to end of sheet!\n";
611 if( ref $header_props and $header_props->{'repeat'})
613 for my $idx (0 .. $header_props->{num_header_rows} - 1) {
614 unshift @$data, [ @{ $header_rows[$idx] } ];
615 unshift @$row_col_widths, [ @{ $header_row_widths[$idx] } ];
616 unshift @$rows_height, $header_row_heights[$idx];
618 $remaining_header_rows = $header_props->{num_header_rows};
623 $gfx_bg = $page->gfx;
625 $txt->font($fnt_name, $fnt_size);
627 $cur_y = $table_top_y;
632 $gfx->strokecolor($border_color);
633 $gfx->linewidth($line_w);
638 $gfx->move( $xbase , $cur_y );
639 $gfx->hline($xbase + $width );
647 # Each iteration adds a row to the current page until the page is full
648 # or there are no more rows to add
650 while(scalar(@{$data}) and $cur_y-$row_h > $bot_marg)
652 # Remove the next item from $data
653 my $record = shift @{$data};
655 # Get max columns number to know later how many vertical lines to draw
656 $columns_number = scalar(@$record)
657 if scalar(@$record) > $columns_number;
659 # Get the next set of row related settings
661 my $pre_calculated_row_height = shift @$rows_height;
664 my $record_widths = shift @$row_col_widths;
666 # Row coloumn props - TODO in another commit
668 # Row cell props - TODO in another commit
671 # Choose colors for this row
672 $background_color = $row_index % 2 ? $background_color_even : $background_color_odd;
673 $font_color = $row_index % 2 ? $font_color_even : $font_color_odd;
675 #Determine current row height
676 my $current_row_height = $pad_top + $pre_calculated_row_height + $pad_bot;
678 # $row_h is the calculated global user requested row height.
679 # It will be honored, only if it has bigger value than the calculated one.
680 # TODO: It's questionable if padding should be inclided in this calculation or not
681 if($current_row_height < $row_h){
682 $current_row_height = $row_h;
685 # Define the font y base position for this line.
686 $text_start = $cur_y - ($current_row_height - $pad_bot);
689 my $leftovers = undef; # Reference to text that is returned from textblock()
690 my $do_leftovers = 0;
691 my ($colspan, @vertical_lines);
693 # Process every cell(column) from current row
694 for( my $column_idx = 0; $column_idx < scalar( @$record); $column_idx++ )
696 next unless $col_props->[$column_idx]->{'max_w'};
697 next unless $col_props->[$column_idx]->{'min_w'};
698 $leftovers->[$column_idx] = undef;
700 # look for font information for this cell
701 my ($cell_font, $cell_font_size, $cell_font_color, $cell_font_underline, $justify);
703 if( $remaining_header_rows and ref $header_props)
705 $cell_font = $header_props->{'font'};
706 $cell_font_size = $header_props->{'font_size'};
707 $cell_font_color = $header_props->{'font_color'};
708 $cell_font_underline = $header_props->{'font_underline'};
709 $justify = $header_props->{'justify'};
712 # Get the most specific value if none was already set from header_props
713 $cell_font ||= $cell_props->[$row_index][$column_idx]->{'font'}
714 || $col_props->[$column_idx]->{'font'}
717 $cell_font_size ||= $cell_props->[$row_index][$column_idx]->{'font_size'}
718 || $col_props->[$column_idx]->{'font_size'}
721 $cell_font_color ||= $cell_props->[$row_index][$column_idx]->{'font_color'}
722 || $col_props->[$column_idx]->{'font_color'}
725 $cell_font_underline ||= $cell_props->[$row_index][$column_idx]->{'font_underline'}
726 || $col_props->[$column_idx]->{'font_underline'}
730 $justify ||= $cell_props->[$row_index][$column_idx]->{'justify'}
731 || $col_props->[$column_idx]->{'justify'}
735 # Init cell font object
736 $txt->font( $cell_font, $cell_font_size );
737 $txt->fillcolor($cell_font_color);
739 # Added to resolve infite loop bug with returned undef values
740 $record->[$column_idx] //= $cell_props->[$row_index][$column_idx]->{'default_text'}
741 // $col_props->[$column_idx]->{'default_text'}
745 if (!$remaining_header_rows && $cell_props->[$row_index][$column_idx]->{colspan}) {
746 $colspan = $cell_props->[$row_index][$column_idx]->{colspan};
747 } elsif ($remaining_header_rows && $header_row_cell_props[$header_props->{num_header_rows} - $remaining_header_rows][$column_idx]->{colspan}) {
748 $colspan = $header_row_cell_props[$header_props->{num_header_rows} - $remaining_header_rows][$column_idx]->{colspan};
752 $colspan = $num_cols - $column_idx if (-1 == $colspan);
753 my $last_idx = $column_idx + $colspan - 1;
754 $this_width = sum @{ $calc_column_widths }[$column_idx..$last_idx];
756 $this_width = $calc_column_widths->[$column_idx];
759 # If the content is wider than the specified width, we need to add the text as a text block
760 if( $record->[$column_idx] !~ m/(.\n.)/ and
761 $record_widths->[$column_idx] and
762 $record_widths->[$column_idx] <= $this_width
764 my $space = $pad_left;
765 if ($justify eq 'right')
767 $space = $this_width -($txt->advancewidth($record->[$column_idx]) + $pad_right);
769 elsif ($justify eq 'center')
771 $space = ($this_width - $txt->advancewidth($record->[$column_idx])) / 2;
773 $txt->translate( $cur_x + $space, $text_start );
775 $text_options{'-underline'} = $cell_font_underline if $cell_font_underline;
776 $txt->text( $record->[$column_idx], %text_options );
778 # Otherwise just use the $page->text() method
781 my ($width_of_last_line, $ypos_of_last_line, $left_over_text) = $self->text_block(
783 $record->[$column_idx],
784 x => $cur_x + $pad_left,
786 w => $this_width - $pad_left - $pad_right,
787 h => $cur_y - $bot_marg - $pad_top - $pad_bot,
791 # Desi - Removed $lead because of fixed incorrect ypos bug in text_block
792 my $current_cell_height = $cur_y - $ypos_of_last_line + $pad_bot;
793 if( $current_cell_height > $current_row_height )
795 $current_row_height = $current_cell_height;
798 if( $left_over_text )
800 $leftovers->[$column_idx] = $left_over_text;
805 # Hook to pass coordinates back - http://www.perlmonks.org/?node_id=754777
806 if (ref $arg{cell_render_hook} eq 'CODE') {
807 $arg{cell_render_hook}->(
814 $calc_column_widths->[$column_idx],
819 $cur_x += $calc_column_widths->[$column_idx];
821 push @vertical_lines, (!$colspan || (1 >= $colspan)) ? 1 : 0;
822 $colspan-- if $colspan;
826 unshift @$data, $leftovers;
827 unshift @$row_col_widths, $record_widths;
828 unshift @$rows_height, $pre_calculated_row_height;
832 # This has to be separately from the text loop
833 # because we do not know the final height of the cell until all text has been drawn
835 for(my $column_idx = 0 ; $column_idx < scalar(@$record) ; $column_idx++)
839 if( $remaining_header_rows and ref $header_props)
840 { #Compatibility Consistency with other props
841 $cell_bg_color = $header_props->{'bg_color'} || $header_props->{'background_color'};
844 # Get the most specific value if none was already set from header_props
845 $cell_bg_color ||= $cell_props->[$row_index][$column_idx]->{'background_color'}
846 || $col_props->[$column_idx]->{'background_color'}
847 || $background_color;
851 $gfx_bg->rect( $cur_x, $cur_y-$current_row_height, $calc_column_widths->[$column_idx], $current_row_height);
852 $gfx_bg->fillcolor($cell_bg_color);
855 $cur_x += $calc_column_widths->[$column_idx];
857 if ($line_w && $vertical_lines[$column_idx] && ($column_idx != (scalar(@{ $record }) - 1))) {
858 $gfx->move($cur_x, $cur_y);
859 $gfx->vline($cur_y - $row_h);
860 $gfx->fillcolor($border_color);
862 }#End of for(my $column_idx....
864 $cur_y -= $current_row_height;
865 if ($gfx && $horiz_borders)
867 $gfx->move( $xbase , $cur_y );
868 $gfx->hline( $xbase + $width );
872 if ($remaining_header_rows) {
873 $remaining_header_rows--;
875 $row_index++ unless $do_leftovers;
881 # Draw vertical lines
884 $gfx->move( $xbase, $table_top_y);
885 $gfx->vline( $cur_y );
886 $gfx->move($xbase + sum(@{ $calc_column_widths }[0..$num_cols - 1]), $table_top_y);
887 $gfx->vline( $cur_y );
890 # ACTUALLY draw all the lines
891 $gfx->fillcolor( $border_color);
895 }# End of while(scalar(@{$data}))
897 return ($page,--$pg_cnt,$cur_y);
901 # calculate the column widths
904 my $col_props = shift;
905 my $avail_width = shift;
910 for(my $j = 0; $j < scalar( @$col_props); $j++)
912 $min_width += $col_props->[$j]->{min_w} || 0;
915 # I think this is the optimal variant when good view can be guaranateed
916 if($avail_width < $min_width)
918 carp "!!! Warning !!!\n Calculated Mininal width($min_width) > Table width($avail_width).\n",
919 ' Expanding table width to:',int($min_width)+1,' but this could lead to unexpected results.',"\n",
920 ' Possible solutions:',"\n",
921 ' 0)Increase table width.',"\n",
922 ' 1)Decrease font size.',"\n",
923 ' 2)Choose a more narrow font.',"\n",
924 ' 3)Decrease "max_word_length" parameter.',"\n",
925 ' 4)Rotate page to landscape(if it is portrait).',"\n",
926 ' 5)Use larger paper size.',"\n",
927 '!!! --------- !!!',"\n";
928 $avail_width = int( $min_width) + 1;
932 # Calculate how much can be added to every column to fit the available width.
933 for(my $j = 0; $j < scalar(@$col_props); $j++ )
935 $calc_widths->[$j] = $col_props->[$j]->{min_w} || 0;;
938 # Allow columns to expand to max_w before applying extra space equally.
942 my $span = ($avail_width - $min_width) / scalar( @$col_props);
946 my $next_will_be_last_iter = 1;
947 for(my $j = 0; $j < scalar(@$col_props); $j++ )
949 my $new_w = $calc_widths->[$j] + $span;
951 if (!$is_last_iter && $new_w > $col_props->[$j]->{max_w})
953 $new_w = $col_props->[$j]->{max_w}
955 if ($calc_widths->[$j] != $new_w )
957 $calc_widths->[$j] = $new_w;
958 $next_will_be_last_iter = 0;
960 $min_width += $new_w;
962 last if $is_last_iter;
963 $is_last_iter = $next_will_be_last_iter;
966 return ($calc_widths,$avail_width);
976 PDF::Table - A utility class for building table layouts in a PDF::API2 object.
983 my $pdftable = new PDF::Table;
984 my $pdf = new PDF::API2(-file => "table_of_lorem.pdf");
985 my $page = $pdf->page;
987 # some data to layout
989 ["1 Lorem ipsum dolor",
990 "Donec odio neque, faucibus vel",
991 "consequat quis, tincidunt vel, felis."],
992 ["Nulla euismod sem eget neque.",
998 $left_edge_of_table = 50;
999 # build the table layout
1005 x => $left_edge_of_table,
1009 # some optional params
1013 padding_right => 10,
1014 background_color_odd => "gray",
1015 background_color_even => "lightblue", #cell background color for even rows
1018 # do other stuff with $pdf
1024 For a complete working example or initial script look into distribution`s 'examples' folder.
1029 This class is a utility for use with the PDF::API2 module from CPAN.
1030 It can be used to display text data in a table layout within a PDF.
1031 The text data must be in a 2D array (such as returned by a DBI statement handle fetchall_arrayref() call).
1032 The PDF::Table will automatically add as many new pages as necessary to display all of the data.
1033 Various layout properties, such as font, font size, and cell padding and background color can be specified for each column and/or for even/odd rows.
1034 Also a (non)repeated header row with different layout properties can be specified.
1036 See the L</METHODS> section for complete documentation of every parameter.
1042 my $pdf_table = new PDF::Table;
1048 Creates a new instance of the class. (to be improved)
1052 There are no parameters.
1056 Reference to the new instance
1062 my ($final_page, $number_of_pages, $final_y) = table($pdf, $page, $data, %settings)
1068 Generates a multi-row, multi-column table into an existing PDF document based on provided data set and settings.
1072 $pdf - a PDF::API2 instance representing the document being created
1073 $page - a PDF::API2::Page instance representing the current page of the document
1074 $data - an ARRAY reference to a 2D data structure that will be used to build the table
1075 %settings - HASH with geometry and formatting parameters.
1077 For full %settings description see section L</Table settings> below.
1079 This method will add more pages to the pdf instance as required based on the formatting options and the amount of data.
1083 The return value is a 3 items list where
1085 $final_page - The first item is a PDF::API2::Page instance that the table ends on
1086 $number_of_pages - The second item is the count of pages that the table spans on
1087 $final_y - The third item is the Y coordinate of the table bottom so that additional content can be added in the same document.
1091 my $pdf = new PDF::API2;
1092 my $page = $pdf->page();
1094 ['foo1','bar1','baz1'],
1095 ['foo2','bar2','baz2']
1104 my ($final_page, $number_of_pages, $final_y) = $pdftable->table( $pdf, $page, $data, %options );
1108 =head3 Table settings
1112 There are some mandatory parameteres for setting table geometry and position across page(s)
1116 =item B<x> - X coordinate of upper left corner of the table. Left edge of the sheet is 0.
1118 B<Value:> can be any whole number satisfying 0 =< X < PageWidth
1119 B<Default:> No default value
1123 =item B<start_y> - Y coordinate of upper left corner of the table at the initial page.
1125 B<Value:> can be any whole number satisfying 0 < start_y < PageHeight (depending on space availability when embedding a table)
1126 B<Default:> No default value
1130 =item B<w> - width of the table starting from X.
1132 B<Value:> can be any whole number satisfying 0 < w < PageWidth - x
1133 B<Default:> No default value
1137 =item B<start_h> - Height of the table on the initial page
1139 B<Value:> can be any whole number satisfying 0 < start_h < PageHeight - Current Y position
1140 B<Default:> No default value
1150 =item B<next_h> - Height of the table on any additional page
1152 B<Value:> can be any whole number satisfying 0 < next_h < PageHeight
1153 B<Default:> Value of param B<'start_h'>
1157 =item B<next_y> - Y coordinate of upper left corner of the table at any additional page.
1159 B<Value:> can be any whole number satisfying 0 < next_y < PageHeight
1160 B<Default:> Value of param B<'start_y'>
1164 =item B<max_word_length> - Breaks long words (like serial numbers hashes etc.) by adding a space after every Nth symbol
1166 B<Value:> can be any whole positive number
1169 max_word_length => 20 # Will add a space after every 20 symbols
1171 =item B<padding> - Padding applied to every cell
1173 =item B<padding_top> - top cell padding, overrides 'padding'
1175 =item B<padding_right> - right cell padding, overrides 'padding'
1177 =item B<padding_left> - left cell padding, overrides 'padding'
1179 =item B<padding_bottom> - bottom padding, overrides 'padding'
1181 B<Value:> can be any whole positive number
1183 B<Default padding:> 0
1185 B<Default padding_*> $padding
1187 padding => 5 # all sides cell padding
1188 padding_top => 8, # top cell padding, overrides 'padding'
1189 padding_right => 6, # right cell padding, overrides 'padding'
1190 padding_left => 2, # left cell padding, overrides 'padding'
1191 padding_bottom => undef # bottom padding will be 5 as it will fallback to 'padding'
1193 =item B<border> - Width of table border lines.
1195 =item B<horizontal_borders> - Width of horizontal border lines. Overrides 'border' value.
1197 =item B<vertical_borders> - Width of vertical border lines. Overrides 'border' value.
1199 B<Value:> can be any whole positive number. When set to 0 will disable border lines.
1202 border => 3 # border width is 3
1203 horizontal_borders => 1 # horizontal borders will be 1 overriding 3
1204 vertical_borders => undef # vertical borders will be 3 as it will fallback to 'border'
1206 =item B<vertical_borders> - Width of vertical border lines. Overrides 'border' value.
1208 B<Value:> Color specifier as 'name' or 'HEX'
1211 border_color => 'red'
1213 =item B<font> - instance of PDF::API2::Resource::Font defining the fontf to be used in the table
1215 B<Value:> can be any PDF::API2::Resource::* type of font
1216 B<Default:> 'Times' with UTF8 encoding
1218 font => $pdf->corefont("Helvetica", -encoding => "utf8")
1220 =item B<font_size> - Default size of the font that will be used across the table
1222 B<Value:> can be any positive number
1227 =item B<font_color> - Font color for all rows
1229 =item B<font_color_odd> - Font color for odd rows
1231 =item B<font_color_even> - Font color for even rows
1233 =item B<font_underline> - Font underline of the header row
1235 B<Value:> 'auto', integer of distance, or arrayref of distance & thickness (more than one pair will provide mlultiple underlines. Negative distance gives strike-through.
1238 =item B<background_color_odd> - Background color for odd rows
1240 =item B<background_color_even> - Background color for even rows
1242 B<Value:> Color specifier as 'name' or 'HEX'
1243 B<Default:> 'black' font on 'white' background
1245 font_color => '#333333'
1246 font_color_odd => 'purple'
1247 font_color_even => '#00FF00'
1248 background_color_odd => 'gray'
1249 background_color_even => 'lightblue'
1251 =item B<row_height> - Desired row height but it will be honored only if row_height > font_size + padding_top + padding_bottom
1253 B<Value:> can be any whole positive number
1254 B<Default:> font_size + padding_top + padding_bottom
1258 =item B<new_page_func> - CODE reference to a function that returns a PDF::API2::Page instance.
1260 If used the parameter 'new_page_func' must be a function reference which when executed will create a new page and will return the object back to the module.
1261 For example you can use it to put Page Title, Page Frame, Page Numbers and other staff that you need.
1262 Also if you need some different type of paper size and orientation than the default A4-Portrait for example B2-Landscape you can use this function ref to set it up for you. For more info about creating pages refer to PDF::API2 PAGE METHODS Section.
1263 Don't forget that your function must return a page object created with PDF::API2 page() method.
1265 new_page_func => $code_ref
1267 =item B<header_props> - HASH reference to specific settings for the Header row of the table. See section L</Header Row Properties> below
1269 header_props => $hdr_props
1271 =item B<column_props> - HASH reference to specific settings for each column of the table. See section L</Column Properties> below
1273 column_props => $col_props
1275 =item B<cell_props> - HASH reference to specific settings for each column of the table. See section L</Cell Properties> below
1277 cell_props => $cel_props
1279 =item B<cell_render_hook> - CODE reference to a function called with the current cell coordinates. If used the parameter 'cell_render_hook' must be a function reference. It is most useful for creating a url link inside of a cell. The following example adds a link in the first column of each non-header row:
1281 cell_render_hook => sub {
1282 my ($page, $first_row, $row, $col, $x, $y, $w, $h) = @_;
1284 # Do nothing except for first column (and not a header row)
1285 return unless ($col == 0);
1286 return if ($first_row);
1289 my $value = $list_of_vals[$row-1];
1290 my $url = "https://${hostname}/app/${value}";
1292 my $annot = $page->annotation();
1293 $annot->url( $url, -rect => [$x, $y, $x+$w, $y+$h] );
1298 =head4 Header Row Properties
1300 If the 'header_props' parameter is used, it should be a hashref. Passing an empty HASH will trigger a header row initialised with Default values.
1301 There is no 'data' variable for the content, because the module asumes that first table row will become the header row. It will copy this row and put it on every new page if 'repeat' param is set.
1305 =item B<font> - instance of PDF::API2::Resource::Font defining the fontf to be used in the header row
1307 B<Value:> can be any PDF::API2::Resource::* type of font
1308 B<Default:> 'font' of the table. See table parameter 'font' for more details.
1310 =item B<font_size> - Font size of the header row
1312 B<Value:> can be any positive number
1313 B<Default:> 'font_size' of the table + 2
1315 =item B<font_color> - Font color of the header row
1317 B<Value:> Color specifier as 'name' or 'HEX'
1318 B<Default:> '#000066'
1320 =item B<font_underline> - Font underline of the header row
1322 B<Value:> 'auto', integer of distance, or arrayref of distance & thickness (more than one pair will provide mlultiple underlines. Negative distance gives strike-through.
1325 =item B<bg_color> - Background color of the header row
1327 B<Value:> Color specifier as 'name' or 'HEX'
1330 =item B<repeat> - Flag showing if header row should be repeated on every new page
1332 B<Value:> 0,1 1-Yes/True, 0-No/False
1335 =item B<justify> - Alignment of text in the header row.
1337 B<Value:> One of 'left', 'right', 'center'
1338 B<Default:> Same as column alignment (or 'left' if undefined)
1342 font => $pdf->corefont("Helvetica", -encoding => "utf8"),
1344 font_color => '#004444',
1345 bg_color => 'yellow',
1352 =head4 Column Properties
1354 If the 'column_props' parameter is used, it should be an arrayref of hashrefs,
1355 with one hashref for each column of the table. The columns are counted from left to right so the hash reference at $col_props[0] will hold properties for the first column from left to right.
1356 If you DO NOT want to give properties for a column but to give for another just insert and empty hash reference into the array for the column that you want to skip. This will cause the counting to proceed as expected and the properties to be applyed at the right columns.
1358 Each hashref can contain any of the keys shown below:
1362 =item B<min_w> - Minimum width of this column. Auto calculation will try its best to honour this param but aplying it is NOT guaranteed.
1364 B<Value:> can be any whole number satisfying 0 < min_w < w
1365 B<Default:> Auto calculated
1367 =item B<max_w> - Maximum width of this column. Auto calculation will try its best to honour this param but aplying it is NOT guaranteed.
1369 B<Value:> can be any whole number satisfying 0 < max_w < w
1370 B<Default:> Auto calculated
1372 =item B<font> - instance of PDF::API2::Resource::Font defining the fontf to be used in this column
1374 B<Value:> can be any PDF::API2::Resource::* type of font
1375 B<Default:> 'font' of the table. See table parameter 'font' for more details.
1377 =item B<font_size> - Font size of this column
1379 B<Value:> can be any positive number
1380 B<Default:> 'font_size' of the table.
1382 =item B<font_color> - Font color of this column
1384 B<Value:> Color specifier as 'name' or 'HEX'
1385 B<Default:> 'font_color' of the table.
1387 =item B<font_underline> - Font underline of this cell
1389 B<Value:> 'auto', integer of distance, or arrayref of distance & thickness (more than one pair will provide mlultiple underlines. Negative distance gives strike-through.
1392 =item B<background_color> - Background color of this column
1394 B<Value:> Color specifier as 'name' or 'HEX'
1397 =item B<justify> - Alignment of text in this column
1399 B<Value:> One of 'left', 'right', 'center'
1405 {},# This is an empty hash so the next one will hold the properties for the second column from left to right.
1407 min_w => 100, # Minimum column width of 100.
1408 max_w => 150, # Maximum column width of 150 .
1409 justify => 'right', # Right text alignment
1410 font => $pdf->corefont("Helvetica", -encoding => "latin1"),
1412 font_color=> 'blue',
1413 background_color => '#FFFF00',
1420 NOTE: If 'min_w' and/or 'max_w' parameter is used in 'col_props', have in mind that it may be overridden by the calculated minimum/maximum cell witdh so that table can be created.
1421 When this happens a warning will be issued with some advises what can be done.
1422 In cases of a conflict between column formatting and odd/even row formatting, 'col_props' will override odd/even.
1424 =head4 Cell Properties
1426 If the 'cell_props' parameter is used, it should be an arrayref with arrays of hashrefs
1427 (of the same dimension as the data array) with one hashref for each cell of the table.
1429 Each hashref can contain any of the keys shown below:
1433 =item B<font> - instance of PDF::API2::Resource::Font defining the fontf to be used in this cell
1435 B<Value:> can be any PDF::API2::Resource::* type of font
1436 B<Default:> 'font' of the table. See table parameter 'font' for more details.
1438 =item B<font_size> - Font size of this cell
1440 B<Value:> can be any positive number
1441 B<Default:> 'font_size' of the table.
1443 =item B<font_color> - Font color of this cell
1445 B<Value:> Color specifier as 'name' or 'HEX'
1446 B<Default:> 'font_color' of the table.
1448 =item B<font_underline> - Font underline of this cell
1450 B<Value:> 'auto', integer of distance, or arrayref of distance & thickness (more than one pair will provide mlultiple underlines. Negative distance gives strike-through.
1453 =item B<background_color> - Background color of this cell
1455 B<Value:> Color specifier as 'name' or 'HEX'
1458 =item B<justify> - Alignment of text in this cell
1460 B<Value:> One of 'left', 'right', 'center'
1466 [ #This array is for the first row. If header_props is defined it will overwrite these settings.
1468 background_color => '#AAAA00',
1469 font_color => 'yellow',
1470 font_underline => [ 2, 2 ],
1477 background_color => '#CCCC00',
1478 font_color => 'blue',
1481 background_color => '#BBBB00',
1482 font_color => 'red',
1491 my $cell_props = [];
1492 $cell_props->[1][0] = {
1494 background_color => '#CCCC00',
1495 font_color => 'blue',
1500 NOTE: In case of a conflict between column, odd/even and cell formatting, cell formatting will overwrite the other two.
1501 In case of a conflict between header row and cell formatting, header formatting will override cell.
1505 my ($width_of_last_line, $ypos_of_last_line, $left_over_text) = text_block( $txt, $data, %settings)
1511 Utility method to create a block of text. The block may contain multiple paragraphs.
1512 It is mainly used internaly but you can use it from outside for placing formatted text anywhere on the sheet.
1514 NOTE: This method will NOT add more pages to the pdf instance if the space is not enough to place the string inside the block.
1515 Leftover text will be returned and has to be handled by the caller - i.e. add a new page and a new block with the leftover.
1519 $txt - a PDF::API2::Page::Text instance representing the text tool
1520 $data - a string that will be placed inside the block
1521 %settings - HASH with geometry and formatting parameters.
1525 The return value is a 3 items list where
1527 $width_of_last_line - Width of last line in the block
1528 $final_y - The Y coordinate of the block bottom so that additional content can be added after it
1529 $left_over_text - Text that was did not fit in the provided box geometry.
1534 my $page = $pdf->page;
1535 my $txt = $page->text;
1544 lead => $font_size | $distance_between_lines,
1545 align => "left|right|center|justify|fulljustify",
1546 hang => $optional_hanging_indent,
1547 Only one of the subsequent 3params can be given.
1548 They override each other.-parspace is the weightest
1549 parspace => $optional_vertical_space_before_first_paragraph,
1550 flindent => $optional_indent_of_first_line,
1551 fpindent => $optional_indent_of_first_paragraph,
1552 indent => $optional_indent_of_text_to_every_non_first_line,
1555 my ( $width_of_last_line, $final_y, $left_over_text ) = $pdftable->text_block( $txt, $data, %settings );
1569 Further development since Ver: 0.02 - Desislav Kamenov
1571 =head1 COPYRIGHT AND LICENSE
1573 Copyright (C) 2006 by Daemmon Hughes, portions Copyright 2004 Stone
1574 Environmental Inc. (www.stone-env.com) All Rights Reserved.
1576 This library is free software; you can redistribute it and/or modify
1577 it under the same terms as Perl itself, either Perl version 5.8.4 or,
1578 at your option, any later version of Perl 5 you may have available.
1584 =item by Daemmon Hughes
1586 Much of the work on this module was sponsered by
1587 Stone Environmental Inc. (www.stone-env.com).
1589 The text_block() method is a slightly modified copy of the one from
1590 Rick Measham's PDF::API2 tutorial at
1591 http://pdfapi2.sourceforge.net/cgi-bin/view/Main/YourFirstDocument
1593 =item by Desislav Kamenov (@deskata on Twitter)
1595 The development of this module was supported by SEEBURGER AG (www.seeburger.com) till year 2007
1597 Thanks to my friends Krasimir Berov and Alex Kantchev for helpful tips and QA during development of versions 0.9.0 to 0.9.5
1599 Thanks to all GitHub contributors!
1605 Hey PDF::Table is on GitHub. You are more than welcome to contribute!
1607 https://github.com/kamenov/PDF-Table