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

NAME

Spreadsheet::HTML - Tabular data to HTML tables.

THIS IS AN ALPHA RELEASE.

While most functionality for this module has been completed, that final 10% takes 90% of the time ... there is still much todo:

  • emit col, colgroup, thead, tbody and caption tags

  • map client functions to cells

  • assign attrs to td tags by row

  • do that nifty rotating attr value trick

You are encouraged to try my older DBIx::XHTML_Table during the development of this module.

REQUIRES

HTML::Entities

Used to encode values with HTML entities.

Math::Matrix

Used to transpose data from portrait to landscape.

SYNOPSIS

use Spreadsheet::HTML;

my $data = [
    [qw(header1 header2 header3)],
    [qw(foo bar baz)],
    [qw(one two three)],
    [qw(col1 col2 col3)],
];

my $table = Spreadsheet::HTML->new( data => $data );
print $table->generate;
print $table->transpose;
print $table->reverse;

# non OO
print Spreadsheet::HTML::generate( $data );
print Spreadsheet::HTML::transpose( $data );
print Spreadsheet::HTML::reverse( $data );

METHODS

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

Constructs object. Currently accepts one parameter: data. Data should be a two dimensional array and you should expect the first row to be treated as the header (which means each cell will be wrapped with <th> tags instead of <td> tags).

generate()
portrait()
my $html = $table->generate;
my $html = $table->generate( indent => '    ' );
my $html = $table->generate( encode => '<>&=' );
my $html = $table->generate( table => { class => 'foo' } );

my $html = Spreadsheet::HTML::generate( @data );
my $html = Spreadsheet::HTML::generate( $data );
my $html = Spreadsheet::HTML::generate(
    data   => $data,
    indent => '    ',
    encode => '<>&=',
    table  => { class => 'foo' },
);

Returns a string that contains the rendered HTML table. Currently (and subject to change if better ideas arise), all data will:

- be converted to &nbsp; if empty
- have any newlines converted to <br> tags
transpose()
landscape()
(same usage as generate)

Uses Math::Matrix to rotate the data 90 degrees and then returns a string containing the rendered HTML table.

reverse()
(same usage as generate)

Uses Math::Matrix to rotate the data 180 degrees and then returns a string containing the rendered HTML table.

process_data()

Returns the munged data before it is used to generate a rendered HTML table. This is called on your behalf, but is available should you want it.

ATTRIBUTES

All methods/procedures can accept named arguments. If named arguments are detected, the data has to be an array ref assigned to the key 'data'.

  • data => [ [], [], [], ... ]

    The data to be rendered into table cells.

  • indent => 0 or 1

    Render the table with whitespace indention. Defaults to undefined which produces no trailing whitespace to tags. Useful values are some number of spaces or tabs. See HTML::Element::as_HTML()

  • encode => undef, '', or 'chars in a string'

    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. See HTML::Element::as_HTML()

  • matrix => 0 or 1

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

  • table => { key => 'value' }

  • tr => { key => 'value' }

  • th => { key => 'value' }

  • td => { key => 'value' }

    Supply attributes to the HTML tags that compose the table. There is currently no support for col, colgroup, caption, thead and tbody. See DBIx::XHTML_Table for that, which despite being a DBI extension, can accept an AoA and produce an table with those tags, plus totals and subtotals. That module cannot produce a transposed table, however.

REQUIRES

HTML::Tree

Used to generate HTML.

Math::Matrix

Used for transposing data.

AUTHOR

Jeff Anderson, <jeffa at cpan.org>

BUGS

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.

SUPPORT

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

perldoc Spreadsheet::HTML

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

You can also look for information at:

ACKNOWLEDGEMENTS

Thank you very much! :)

  • Neil Bowers

    Helped with Makefile.PL suggestions and corrections.

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.