File: //usr/local/share/man/man3/Spreadsheet::XLSX.3pm
.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Spreadsheet::XLSX 3"
.TH Spreadsheet::XLSX 3 "2024-03-09" "perl v5.26.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Spreadsheet::XLSX \- Perl extension for reading MS Excel 2007 files.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& use Text::Iconv;
\& my $converter = Text::Iconv\->new("utf\-8", "windows\-1251");
\&
\& # Text::Iconv is not really required.
\& # This can be any object with the convert method. Or nothing.
\&
\& use Spreadsheet::XLSX;
\&
\& my $excel = Spreadsheet::XLSX\->new(\*(Aqtest.xlsx\*(Aq, $converter);
\&
\& foreach my $sheet (@{$excel\->{Worksheet}}) {
\&
\& printf("Sheet: %s\en", $sheet\->{Name});
\&
\& $sheet\->{MaxRow} ||= $sheet\->{MinRow};
\&
\& foreach my $row ($sheet\->{MinRow} .. $sheet\->{MaxRow}) {
\&
\& $sheet\->{MaxCol} ||= $sheet\->{MinCol};
\&
\& foreach my $col ($sheet\->{MinCol} .. $sheet\->{MaxCol}) {
\&
\& my $cell = $sheet\->{Cells}[$row][$col];
\&
\& if ($cell) {
\& printf("( %s , %s ) => %s\en", $row, $col, $cell\->{Val});
\& }
\&
\& }
\&
\& }
\&
\& }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module is a (quick and dirty) emulation of Spreadsheet::ParseExcel for
Excel 2007 (.xlsx) file format. It supports styles and many of Excel's quirks,
but not all. It populates the classes from Spreadsheet::ParseExcel for interoperability;
including Workbook, Worksheet, and Cell.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "Spreadsheet::ParseXLSX" 2
.IX Item "Spreadsheet::ParseXLSX"
This module (Spradsheet::XLSX) has some serious issues with the way it uses regexs for parsing the \s-1XML.
I\s0 would strongly encourage switching to Spreadsheet::ParseXLSX which takes a more reliable approach.
.IP "Text::CSV_XS, Text::CSV_PP" 2
.IX Item "Text::CSV_XS, Text::CSV_PP"
.PD 0
.IP "Spreadsheet::ParseExcel" 2
.IX Item "Spreadsheet::ParseExcel"
.IP "Spreadsheet::ReadSXC" 2
.IX Item "Spreadsheet::ReadSXC"
.IP "Spreadsheet::BasicRead" 2
.IX Item "Spreadsheet::BasicRead"
.PD
for xlscat likewise functionality (Excel only)
.IP "Spreadsheet::ConvertAA" 2
.IX Item "Spreadsheet::ConvertAA"
for an alternative set of \f(CW\*(C`cell2cr()\*(C'\fR / \f(CW\*(C`cr2cell()\*(C'\fR pair
.IP "Spreadsheet::Perl" 2
.IX Item "Spreadsheet::Perl"
offers a Pure Perl implementation of a
spreadsheet engine. Users that want this format to be supported in
Spreadsheet::Read are hereby motivated to offer patches. It's not high
on my todo-list.
.IP "xls2csv" 2
.IX Item "xls2csv"
<https://metacpan.org/release/KEN/xls2csv\-1.07> offers an alternative for my \f(CW\*(C`xlscat \-c\*(C'\fR,
in the xls2csv tool, but this tool focusses on character encoding
transparency, and requires some other modules.
.IP "Spreadsheet::Read" 2
.IX Item "Spreadsheet::Read"
read the data from a spreadsheet (interface module)
.SH "AUTHOR"
.IX Header "AUTHOR"
Dmitry Ovsyanko, <do@eludia.ru>, http://eludia.ru/wiki/
.PP
Patches by:
.PP
.Vb 9
\& Steve Simms
\& Joerg Meltzer
\& Loreyna Yeung
\& Rob Polocz
\& Gregor Herrmann
\& H.Merijn Brand
\& endacoe
\& Pat Mariani
\& Sergey Pushkin
.Ve
.SH "ACKNOWLEDGEMENTS"
.IX Header "ACKNOWLEDGEMENTS"
.Vb 1
\& Thanks to TrackVia Inc. (http://www.trackvia.com) for paying for Rob Polocz working time.
.Ve
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2008 by Dmitry Ovsyanko
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.8 or,
at your option, any later version of Perl 5 you may have available.