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

NAME

Spreadsheet::HTML - Render HTML tables with ease.

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 ... maybe ...

  • 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, which provides support for tags such as caption, col, colgroup, thead, and tbody.

SYNOPSIS

use Spreadsheet::HTML;

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

$table = Spreadsheet::HTML->new( data => $data );
print $table->portrait;
print $table->landscape;

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

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

METHODS

  • new( %args )

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

    Constructs object. Accepts named arguments (see ATTRIBUTES). Unless you give it an array of array refs. Or an array ref of array refs. Otherwise it expects named arguments. The most favorite being 'data' which is exactly an array ref of array refs. The first row will be treated as the headings unless you specify otherwise (see ATTRIBUTES).

  • generate( %args )

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

    Returns a string that contains the rendered HTML table.

  • portrait( %args )

    Alias for generate()

  • transpose( %args )

    Uses Math::Matrix to rotate the headings and data 90 degrees counter-clockwise.

  • landscape( %args )

    Alias for transpose()

  • flip( %args )

    Flips the headings and data upside down.

  • mirror( %args )

    Columns are rendered right to left.

  • reverse( %args )

    Combines flip and mirror: flips the headings and data upside down and render columns right to left.

  • process( %args )

    Returns processed data.

ATTRIBUTES

All methods/procedures accept named arguments. If named arguments 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.

  • file: $str

    The name of the data file to read. Supported formats are CSV, JSON, YAML and HTML (first table found). Support for Excel files is planned.

  • indent: $str

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

  • empty: $str

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

  • cache: 0 or 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.

  • headless: 0 or 1

    Render the table with without headings, if true.

  • headings: sub { return function( shift ) }

    Apply this anonymous subroutine to headers.

  • table: { %args }

  • tr: { %args }

  • th: { %args }

  • td: { %args }

    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. Handles indentation and HTML entity encoding.

  • 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

  • DBIx::HTML

    Uses this module (Spreadsheet::HTML) to format SQL query results.

  • DBIx::XHTML_Table

    The original since 2001. Can handle advanced grouping, individual cell value contol, rotating attributes and totals/subtotals.

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.

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.