/ 
Spreadsheet-HTML-0.18
River stage one • 1 direct dependent • 1 total dependent
/ Spreadsheet::HTML

NAME

Spreadsheet::HTML - Render HTML5 tables with ease.

SYNOPSIS

use Spreadsheet::HTML;

$data = [ [qw(a1 a2 a3)], [qw(b1 b2 b3)], [qw(c1 c2 c3)] ];

$table = Spreadsheet::HTML->new( data => $data, indent => "\t" );
print $table->portrait;
print $table->landscape;

# load from files (first table found)
$table = Spreadsheet::HTML->new( file => 'data.xls', cache => 1 );

# non OO
use Spreadsheet::HTML qw( portrait landscape );
print portrait( $data );
print landscape( $data );

DESCRIPTION

THIS MODULE IS AN ALPHA RELEASE! Although we are very close to BETA.

Renders HTML5 tables with ease. Provides a handful of distinctly named methods to control overall table orientation. These methods in turn accept a number of distinctly named attributes for directing what tags and attributes to use.

METHODS

All methods (except new) are exportable as functions. With the exception of new, all methods return HTML as a scalar string and they accept the same named parameters (see PARAMETERS below).

  • new( %args )

    my $table = Spreadsheet::HTML->new( data => $data );

    Constructs object. Accepts the same named parameters as the table generating functions below:

  • generate( %args )

    $html = $table->generate( table => {border => 1}, encode => '<>' );
print Spreadsheet::HTML::generate( data => $data, indent => "\t" );

  • portrait( %args )

  • north( %args )

    Headers on top generate( 'theta', 0 )

  • landscape( %args )

  • west( %args )

    Headers on left: generate( 'theta', -270 )

  • south( %args )

    Headers on bottom: generate( 'theta', -180 )

  • east( %args )

    Headers on right: generate( 'theta', 90 )

  • transpose( %args )

    Deprecated: use landscape()

  • earthquake( %args )

    Deprecated: use east()

  • tsunami( %args )

    Deprecated: use east( 'flip', 1 )

  • mirror( %args )

    Deprecated: use north( 'flip', 1 )

  • reverse( %args )

    Deprecated: use south( 'flip', 1 )

  • flip( %args )

    Deprecated: use south()

For most cases, portrait() and landscape() are all you need.

PARAMETERS

All methods/procedures accept the same named parameters. If named parameters are detected: the data has to be an array ref assigned to the key 'data'. If no named args are detected then the parameter list is treated as the data itself, either an array containing array references or an array reference containing array references.

  • data: [ [], [], [], ... ]

    The data to be rendered into table cells. Should be an array ref of array refs.

    data => [["a".."c"],[1..3],[4..6],[7..9]]

  • file: $str

    The name of the data file to read. Supported formats are XLS, CSV, JSON, YAML and HTML (first table found).

    file => 'foo.json'

  • theta: 0, 90, 180, 270, -90, -180, -270

    Rotates table clockwise. Default to 0: headers at top. 90: headers at right. 180: headers at bottom. 270: headers at left. To achieve landscape, use -270.

  • flip: 0 or 1

    Flips table horizontally. Can be used in conjunction with theta.

  • indent: $str

    Render the table with nested indentation. Defaults to undefined which produces no indentation. Adds newlines when set to any value that is defined.

    indent => '    '

  • encodes: $str

    HTML Encode contents of td tags. Defaults to empty string which performs no encoding of entities. Pass a string like '<>&=' to perform encoding on any characters found. If the value is 'undef' then all unsafe characters will be encoded as HTML entites.

    encodes => '<>"'

  • empty: $str

    Replace empty cells with this value. Defaults to &nbsp; Set value to undef to avoid any substitutions.

    empty => '&#160;'

  • cache: 0 or 1

    cache => 1

    Preserve data after it has been processed (and loaded).

  • matrix: 0 or 1

    Render the table with only td tags, no th tags, if true.

    matrix => 1

  • layout: 0 or 1

    Layout tables are not recommended, but if you choose to use them you should label them as such. This adds W3C recommended layout attributes to the table tag and features: emiting only <td> tags, no padding or pruning of rows, forces no HTML entity encoding in table cells.

    layout => 1

  • headless: 0 or 1

    Render the table with without the headings row, if true.

    headless => 1

  • headings: \& or \%

    Apply anonymous subroutine to each cell in headings row.

    headings => sub {join(" ",map{ucfirst lc$_}split"_",shift)}

    Or apply hash ref as attributes:

    headings => { class => 'some-class' }

  • -rowX: \& or \%

    Apply this anonymous subroutine to row X. (0 index based)

    -row3 => sub { uc shift }

    Or apply hash ref as attributes:

    -row3 => { class => 'some-class' }

  • -colX: \& or \%

    Apply this anonymous subroutine to column X. (0 index based)

    -col4 => sub { sprintf "%02d", shift || 0 }

    Or apply hash ref as attributes:

    -colo => { class => 'some-class' }

    You can alias any column number by the value of the heading name in that column:

    -my_heading3 => sub { "<b>$_[0]"</b>" }

-my_heading3 => { class => 'special-row' }

  • tgroups: 0 or 1

    Group table rows into <thead> <tfoot> and <tbody> sections. The <tfoot> section is always found before the <tbody> section. Only available for generate(), portrait() and mirror().

    tgroups => 1

  • caption: $str or \%

    Caption is special in that you can either pass a string to be used as CDATA or a hash whose only key is the string to be used as CDATA:

    caption => "Just Another Title"

caption => { "With Attributes" => { align => "bottom" } }

  • colgroup: \@ or \%

    Add colgroup tag(s) to the table. Use an AoH for multiple.

    colgroup => { span => 2, style => { 'background-color' => 'orange' } }

colgroup => [ { span => 20 }, { span => 1, class => 'end' } ]

  • col: \@ or \%

    Add col tag(s) to the table. Use an AoH for multiple. Wraps tags within a colgroup tag.

    col => { span => 2, style => { 'background-color' => 'orange' } }

col => [ { span => 20 }, { span => 1, class => 'end' } ]

  • table: \%

    Apply these attributes to the table tag.

    table => { class => 'spreadsheet' }

  • thead: \%

    thead => { style => 'background: color' }

  • tfoot: \%

    tfoot => { style => 'background: color' }

  • tbody: \%

    tbody => { style => 'background: color' }

  • tr: \%

    tr => { style => { background => [qw( color1 color2 )]' } }

  • th: \%

    th => { style => 'background: color' }

  • td: \%

    td => { style => 'background: color' }

REQUIRES

  • HTML::AutoTag

    Used to generate HTML. Handles indentation and HTML entity encoding. Uses Tie::Hash::Attribute to handle rotation of class attributes.

  • Math::Matrix

    Used for transposing data from portrait to landscape.

  • Clone

    Useful for preventing data from being clobbered.

OPTIONAL

Used to load data from various different file formats.

SEE ALSO

BUGS AND LIMITATIONS

Benchmarks have improved since switching from HTML::Element to HTML::AutoTag but we are still a C- student at best. The following benchmark was performed by rendering a 500x500 cell table 20 times:

Before switch to HTML::AutoTag

                   s/iter  S::H  H::E H::AT  H::T D::XT
Spreadsheet::HTML    8.58    --  -13%  -53%  -66%  -78%
HTML::Element        7.50   14%    --  -47%  -62%  -74%
HTML::AutoTag        4.01  114%   87%    --  -28%  -52%
HTML::Tiny           2.87  198%  161%   39%    --  -33%
DBIx::XHTML_Table    1.92  347%  291%  109%   50%    --

After switch to HTML::AutoTag

                  s/iter  H::E  S::H H::AT  H::T D::XT
HTML::Element       7.56    --  -34%  -46%  -60%  -74%
Spreadsheet::HTML   4.96   53%    --  -17%  -39%  -60%
HTML::AutoTag       4.12   84%   21%    --  -26%  -52%
HTML::Tiny          3.05  148%   63%   35%    --  -35%
DBIx::XHTML_Table   1.99  281%  150%  107%   53%    --

Switching to HTML::Tiny would improve speed but this would complicate rotating attributes. The suggestion from these benchmarks is to do it the way DBIx::XHTML_Table does it: by complete brute force. This does not interest me ... if 1 second can be shaved off of HTML::AutoTag's time this would suffice.

Please report any bugs or feature requests to either

I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

GITHUB

The Github project is https://github.com/jeffa/Spreadsheet-HTML

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Spreadsheet::HTML

You can also look for information at:

ACKNOWLEDGEMENTS

Thank you very much! :)

  • Neil Bowers

    Helped with Makefile.PL suggestions and corrections.

AUTHOR

Jeff Anderson, <jeffa at cpan.org>

LICENSE AND COPYRIGHT

Copyright 2015 Jeff Anderson.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.