NAME
Spreadsheet::Read - Read the data from a spreadsheet
SYNOPSYS
use Spreadsheet::Read; my $xls = ReadData ("test.xls"); my $sxc = ReadData ("test.sxc");
DESCRIPTION
Spreadsheet::Read tries to transparantly read *any* spreadsheet and return it's content in a universal manner independant of the parsing module that does the actual spreadsheet scanning.
For OpenOffice this module uses Spreadsheet::ReadSXC
For Excel this module uses Spreadsheet::ParseExcel
Data structure
The data is returned as an array reference:
$ref = [
# Entry 0 is the overall control hash
{ sheets => 2,
sheet => {
"Sheet 1" => 1,
"Sheet 2" => 2,
},
type => "xls",
},
# Entry 1 is the first sheet
{ label => "Sheet 1",
maxrow => 2,
maxcol => 4,
cell => [ undef,
[ undef, 1 ],
[ undef, undef, undef, undef, undef, "Nugget" ],
],
A1 => 1,
B4 => "Nugget",
},
# Entry 2 is the second sheet
{ label => "Sheet 2",
:
:
To keep as close contact to spreadsheet users, row and column 1 have index 1 too in the cell
element of the sheet hash, so cell "A1" is the same as cell
[1, 1] (column first). To switch between the two, there are two helper functions available: cell2cr ()
and cr2cell ()
.
The cell
hash entry contains unformatted data, while the hash entries with the traditional labels contain the formatted values (if applicable).
The control hash (the first entry in the returned array ref), contains some spreadsheet metadata. The entry sheet
is there to be able to find the sheets when accessing them by name:
my %sheet2 = %{$ref->[$ref->[0]{sheet}{"Sheet 2"}]};
Functions
my $ref = ReadData ("file.xls");
my $ref = ReadData ("file.sxc");
my $ref = ReadData ("content.xml");
my $ref = ReadData ($content);
-
Tries to convert the given file or string to the data structure described above.
Currently ReadSXC does not preserve sheet order.
my $cell = cr2cell (col, row)
-
cr2cell ()
converts a(column, row)
pair (1 based) to the traditional cell notation:my $cell = cr2cell ( 4, 14); # $cell now "D14" my $cell = cr2cell (28, 4); # $cell now "AB4"
TODO
- Cell attributes
-
Future plans include cell attributes, available as for example:
{ label => "Sheet 1", maxrow => 2, maxcol => 4, cell => [ undef, [ undef, 1 ], [ undef, undef, undef, undef, undef, "Nugget" ], ], attr => [ undef, [ undef, { color => "Red", font => "Arial", size => "12", format => "## ###.##", align => "right", }, ] [ undef, undef, undef, undef, undef, { color => "#e2e2e2", font => "LetterGothic", size => "15", format => undef, align => "left", }, ] A1 => 1, B4 => "Nugget", },
- Options
-
Try to transparently support as many options as the encapsulated modules support regarding (un)formatted values, (date) formats, hidden columns rows or fields etc. These could be implemented like
attr
above but namesmeta
, or just be new values in theattr
hashes. - Other spreadsheet formats
-
I consider adding CSV
- Safety / flexibility
-
Make the different formats/modules just load if available and ignore if not available.
- OO-ify
-
Consider making the ref an object, though I currently don't see the big advantage (yet). Maybe I'll make it so that it is a hybrid functional / OO interface.
SEE ALSO
- Spreadsheet::ParseExcel
-
http://search.cpan.org/~kwitknr/
- Spreadsheet::ReadSXC
-
http://search.cpan.org/~terhechte/
- Text::CSV_XS, Text::CSV
-
http://search.cpan.org/~jwied/ http://search.cpan.org/~alancitt/
AUTHOR
H.Merijn Brand, <h.m.brand@xs4all.nl>
COPYRIGHT AND LICENSE
Copyright (C) 2005-2005 H.Merijn Brand
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
5 POD Errors
The following errors were encountered while parsing the POD:
- Around line 214:
Unterminated C<...> sequence
- Around line 216:
Unterminated C<...> sequence
- Around line 218:
Unterminated C<...> sequence
- Around line 220:
Unterminated C<...> sequence
- Around line 235:
Unknown directive: =iten