{
    "content": [
        {
            "type": "text",
            "text": "# Spreadsheet::ParseExcel::Worksheet (perldoc)\n\n## NAME\n\nSpreadsheet::ParseExcel::Worksheet - A class for Worksheets.\n\n## SYNOPSIS\n\nSee the documentation for Spreadsheet::ParseExcel.\n\n## DESCRIPTION\n\nThis module is used in conjunction with Spreadsheet::ParseExcel. See the documentation for\nSpreadsheet::ParseExcel.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **Methods**\n- **AUTHOR**\n- **COPYRIGHT**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "Spreadsheet::ParseExcel::Worksheet",
        "section": "",
        "mode": "perldoc",
        "summary": "Spreadsheet::ParseExcel::Worksheet - A class for Worksheets.",
        "synopsis": "See the documentation for Spreadsheet::ParseExcel.",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 3,
                "subsections": []
            },
            {
                "name": "Methods",
                "lines": 320,
                "subsections": []
            },
            {
                "name": "AUTHOR",
                "lines": 8,
                "subsections": []
            },
            {
                "name": "COPYRIGHT",
                "lines": 13,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "Spreadsheet::ParseExcel::Worksheet - A class for Worksheets.\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "See the documentation for Spreadsheet::ParseExcel.\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "This module is used in conjunction with Spreadsheet::ParseExcel. See the documentation for\nSpreadsheet::ParseExcel.\n",
                "subsections": []
            },
            "Methods": {
                "content": "The \"Spreadsheet::ParseExcel::Worksheet\" class encapsulates the properties of an Excel\nworksheet. It has the following methods:\n\n$worksheet->getcell()\n$worksheet->rowrange()\n$worksheet->colrange()\n$worksheet->getname()\n$worksheet->gethpagebreaks()\n$worksheet->getvpagebreaks()\n$worksheet->getmergedareas()\n$worksheet->getrowheights()\n$worksheet->getcolwidths()\n$worksheet->getdefaultrowheight()\n$worksheet->getdefaultcolwidth()\n$worksheet->getheader()\n$worksheet->getfooter()\n$worksheet->getmarginleft()\n$worksheet->getmarginright()\n$worksheet->getmargintop()\n$worksheet->getmarginbottom()\n$worksheet->getmarginheader()\n$worksheet->getmarginfooter()\n$worksheet->getpaper()\n$worksheet->getstartpage()\n$worksheet->getprintorder()\n$worksheet->getprintscale()\n$worksheet->getfittopages()\n$worksheet->isportrait()\n$worksheet->iscenteredhorizontally()\n$worksheet->iscenteredvertically()\n$worksheet->isprintgridlines()\n$worksheet->isprintrowcolheaders()\n$worksheet->isprintblackandwhite()\n$worksheet->isprintdraft()\n$worksheet->isprintcomments()\n\ngetcell($row, $col)\nReturn the \"Cell\" object at row $row and column $col if it is defined. Otherwise returns undef.\n\nmy $cell = $worksheet->getcell($row, $col);\n\nrowrange()\nReturns a two-element list \"($min, $max)\" containing the minimum and maximum defined rows in the\nworksheet. If there is no row defined $max is smaller than $min.\n\nmy ( $rowmin, $rowmax ) = $worksheet->rowrange();\n\ncolrange()\nReturns a two-element list \"($min, $max)\" containing the minimum and maximum of defined columns\nin the worksheet. If there is no column defined $max is smaller than $min.\n\nmy ( $colmin, $colmax ) = $worksheet->colrange();\n\ngetname()\nThe \"getname()\" method returns the name of the worksheet.\n\nmy $name = $worksheet->getname();\n\ngethpagebreaks()\nThe \"gethpagebreaks()\" method returns an array ref of row numbers where a horizontal page\nbreak occurs.\n\nmy $hpagebreaks = $worksheet->gethpagebreaks();\n\nReturns \"undef\" if there are no pagebreaks.\n\ngetvpagebreaks()\nThe \"getvpagebreaks()\" method returns an array ref of column numbers where a vertical page\nbreak occurs.\n\nmy $vpagebreaks = $worksheet->getvpagebreaks();\n\nReturns \"undef\" if there are no pagebreaks.\n\ngetmergedareas()\nThe \"getmergedareas()\" method returns an array ref of cells that are merged.\n\nmy $mergedareas = $worksheet->getmergedareas();\n\nEach merged area is represented as follows:\n\n[ $startrow, $startcol, $endrow, $endcol]\n\nReturns \"undef\" if there are no merged areas.\n\ngetrowheights()\nThe \"getrowheights()\" method returns an arrayref of row heights in scalar context, and an\narray in list context.\n\nmy $rowheights = $worksheet->getrowheights();\n\nReturns \"undef\" if the property isn't set.\n\ngetcolwidths()\nThe \"getcolwidths()\" method returns an arrayref of column widths in scalar context, and an\narray in list context.\n\nmy $colwidths = $worksheet->getcolwidths();\n\nReturns \"undef\" if the property isn't set.\n\ngetdefaultrowheight()\nThe \"getdefaultrowheight()\" method returns the default row height for the worksheet.\nGenerally 12.75.\n\nmy $defaultrowheight = $worksheet->getdefaultrowheight();\n\ngetdefaultcolwidth()\nThe \"getdefaultcolwidth()\" method returns the default column width for the worksheet.\nGenerally 8.43.\n\nmy $defaultcolwidth = $worksheet->getdefaultcolwidth();\n\ngetheader()\nThe \"getheader()\" method returns the worksheet header string. This string can contain control\ncodes for alignment and font properties. Refer to the Excel on-line help on headers and footers\nor to the Spreadsheet::WriteExcel documentation for setheader().\n\nmy $header = $worksheet->getheader();\n\nReturns \"undef\" if the property isn't set.\n\ngetfooter()\nThe \"getfooter()\" method returns the worksheet footer string. This string can contain control\ncodes for alignment and font properties. Refer to the Excel on-line help on headers and footers\nor to the Spreadsheet::WriteExcel documentation for setheader().\n\nmy $footer = $worksheet->getfooter();\n\nReturns \"undef\" if the property isn't set.\n\ngetmarginleft()\nThe \"getmarginleft()\" method returns the left margin of the worksheet in inches.\n\nmy $marginleft = $worksheet->getmarginleft();\n\nReturns \"undef\" if the property isn't set.\n\ngetmarginright()\nThe \"getmarginright()\" method returns the right margin of the worksheet in inches.\n\nmy $marginright = $worksheet->getmarginright();\n\nReturns \"undef\" if the property isn't set.\n\ngetmargintop()\nThe \"getmargintop()\" method returns the top margin of the worksheet in inches.\n\nmy $margintop = $worksheet->getmargintop();\n\nReturns \"undef\" if the property isn't set.\n\ngetmarginbottom()\nThe \"getmarginbottom()\" method returns the bottom margin of the worksheet in inches.\n\nmy $marginbottom = $worksheet->getmarginbottom();\n\nReturns \"undef\" if the property isn't set.\n\ngetmarginheader()\nThe \"getmarginheader()\" method returns the header margin of the worksheet in inches.\n\nmy $marginheader = $worksheet->getmarginheader();\n\nReturns a default value of 0.5 if not set.\n\ngetmarginfooter()\nThe \"getmarginfooter()\" method returns the footer margin of the worksheet in inches.\n\nmy $marginfooter = $worksheet->getmarginfooter();\n\nReturns a default value of 0.5 if not set.\n\ngetpaper()\nThe \"getpaper()\" method returns the printer paper size.\n\nmy $paper = $worksheet->getpaper();\n\nThe value corresponds to the formats shown below:\n\nIndex   Paper format            Paper size\n=====   ============            ==========\n0     Printer default         -\n1     Letter                  8 1/2 x 11 in\n2     Letter Small            8 1/2 x 11 in\n3     Tabloid                 11 x 17 in\n4     Ledger                  17 x 11 in\n5     Legal                   8 1/2 x 14 in\n6     Statement               5 1/2 x 8 1/2 in\n7     Executive               7 1/4 x 10 1/2 in\n8     A3                      297 x 420 mm\n9     A4                      210 x 297 mm\n10     A4 Small                210 x 297 mm\n11     A5                      148 x 210 mm\n12     B4                      250 x 354 mm\n13     B5                      182 x 257 mm\n14     Folio                   8 1/2 x 13 in\n15     Quarto                  215 x 275 mm\n16     -                       10x14 in\n17     -                       11x17 in\n18     Note                    8 1/2 x 11 in\n19     Envelope  9             3 7/8 x 8 7/8\n20     Envelope 10             4 1/8 x 9 1/2\n21     Envelope 11             4 1/2 x 10 3/8\n22     Envelope 12             4 3/4 x 11\n23     Envelope 14             5 x 11 1/2\n24     C size sheet            -\n25     D size sheet            -\n26     E size sheet            -\n27     Envelope DL             110 x 220 mm\n28     Envelope C3             324 x 458 mm\n29     Envelope C4             229 x 324 mm\n30     Envelope C5             162 x 229 mm\n31     Envelope C6             114 x 162 mm\n32     Envelope C65            114 x 229 mm\n33     Envelope B4             250 x 353 mm\n34     Envelope B5             176 x 250 mm\n35     Envelope B6             176 x 125 mm\n36     Envelope                110 x 230 mm\n37     Monarch                 3.875 x 7.5 in\n38     Envelope                3 5/8 x 6 1/2 in\n39     Fanfold                 14 7/8 x 11 in\n40     German Std Fanfold      8 1/2 x 12 in\n41     German Legal Fanfold    8 1/2 x 13 in\n256    User defined\n\nThe two most common paper sizes are \"1 = \"US Letter\"\" and \"9 = A4\". Returns 9 by default.\n\ngetstartpage()\nThe \"getstartpage()\" method returns the page number that printing will start from.\n\nmy $startpage = $worksheet->getstartpage();\n\nReturns 0 if the property isn't set.\n\ngetprintorder()\nThe \"getprintorder()\" method returns 0 if the worksheet print \"page order\" is \"Down then over\"\n(the default) or 1 if it is \"Over then down\".\n\nmy $printorder = $worksheet->getprintorder();\n\ngetprintscale()\nThe \"getprintscale()\" method returns the workbook scale for printing. The print scale factor\ncan be in the range 10 .. 400.\n\nmy $printscale = $worksheet->getprintscale();\n\nReturns 100 by default.\n\ngetfittopages()\nThe \"getfittopages()\" method returns the number of pages wide and high that the printed\nworksheet page will fit to.\n\nmy ($pageswide, $pageshigh) = $worksheet->getfittopages();\n\nReturns (0, 0) if the property isn't set.\n\nisportrait()\nThe \"isportrait()\" method returns true if the worksheet has been set for printing in portrait\nmode.\n\nmy $isportrait = $worksheet->isportrait();\n\nReturns 0 if the worksheet has been set for printing in horizontal mode.\n\niscenteredhorizontally()\nThe \"iscenteredhorizontally()\" method returns true if the worksheet has been centered\nhorizontally for printing.\n\nmy $iscenteredhorizontally = $worksheet->iscenteredhorizontally();\n\nReturns 0 if the property isn't set.\n\niscenteredvertically()\nThe \"iscenteredvertically()\" method returns true if the worksheet has been centered vertically\nfor printing.\n\nmy $iscenteredvertically = $worksheet->iscenteredvertically();\n\nReturns 0 if the property isn't set.\n\nisprintgridlines()\nThe \"isprintgridlines()\" method returns true if the worksheet print \"gridlines\" option is\nturned on.\n\nmy $isprintgridlines = $worksheet->isprintgridlines();\n\nReturns 0 if the property isn't set.\n\nisprintrowcolheaders()\nThe \"isprintrowcolheaders()\" method returns true if the worksheet print \"row and column\nheadings\" option is turned on.\n\nmy $isprintrowcolheaders = $worksheet->isprintrowcolheaders();\n\nReturns 0 if the property isn't set.\n\nisprintblackandwhite()\nThe \"isprintblackandwhite()\" method returns true if the worksheet print \"black and white\"\noption is turned on.\n\nmy $isprintblackandwhite = $worksheet->isprintblackandwhite();\n\nReturns 0 if the property isn't set.\n\nisprintdraft()\nThe \"isprintdraft()\" method returns true if the worksheet print \"draft\" option is turned on.\n\nmy $isprintdraft = $worksheet->isprintdraft();\n\nReturns 0 if the property isn't set.\n\nisprintcomments()\nThe \"isprintcomments()\" method returns true if the worksheet print \"comments\" option is turned\non.\n\nmy $isprintcomments = $worksheet->isprintcomments();\n\nReturns 0 if the property isn't set.\n",
                "subsections": []
            },
            "AUTHOR": {
                "content": "Current maintainer 0.60+: Douglas Wilson dougw@cpan.org\n\nMaintainer 0.40-0.59: John McNamara jmcnamara@cpan.org\n\nMaintainer 0.27-0.33: Gabor Szabo szabgab@cpan.org\n\nOriginal author: Kawai Takanori kwitknr@cpan.org\n",
                "subsections": []
            },
            "COPYRIGHT": {
                "content": "Copyright (c) 2014 Douglas Wilson\n\nCopyright (c) 2009-2013 John McNamara\n\nCopyright (c) 2006-2008 Gabor Szabo\n\nCopyright (c) 2000-2006 Kawai Takanori\n\nAll rights reserved.\n\nYou may distribute under the terms of either the GNU General Public License or the Artistic\nLicense, as specified in the Perl README file.\n",
                "subsections": []
            }
        }
    }
}