spreadsheet::parseexcel::workbook(3pm) [debian man page]

Spreadsheet::ParseExcel::Workbook(3pm)			User Contributed Perl Documentation		    Spreadsheet::ParseExcel::Workbook(3pm)

NAME

       Spreadsheet::ParseExcel::Workbook - A class for Workbooks.

SYNOPSIS

       See the documentation for Spreadsheet::ParseExcel.

DESCRIPTION

       This module is used in conjunction with Spreadsheet::ParseExcel. See the documentation for Spreadsheet::ParseExcel.

Methods
       The following Workbook methods are available:

	   $workbook->worksheets()
	   $workbook->worksheet()
	   $workbook->worksheet_count()
	   $workbook->get_filename()
	   $workbook->get_print_areas()
	   $workbook->get_print_titles()
	   $workbook->using_1904_date()

   worksheets()
       The "worksheets()" method returns an array of Worksheet objects. This was most commonly used to iterate over the worksheets in a workbook:

	   for my $worksheet ( $workbook->worksheets() ) {
	       ...
	   }

   worksheet()
       The "worksheet()" method returns a single "Worksheet" object using either its name or index:

	   $worksheet = $workbook->worksheet('Sheet1');
	   $worksheet = $workbook->worksheet(0);

       Returns "undef" if the sheet name or index doesn't exist.

   worksheet_count()
       The "worksheet_count()" method returns the number of Woksheet objects in the Workbook.

	   my $worksheet_count = $workbook->worksheet_count();

   get_filename()
       The "get_filename()" method returns the name of the Excel file of "undef" if the data was read from a filehandle rather than a file.

	   my $filename = $workbook->get_filename();

   get_print_areas()
       The "get_print_areas()" method returns an array ref of print areas.

	   my $print_areas = $workbook->get_print_areas();

       Each print area is as follows:

	   [ $start_row, $start_col, $end_row, $end_col ]

       Returns undef if there are no print areas.

   get_print_titles()
       The "get_print_titles()" method returns an array ref of print title hash refs.

	   my $print_titles = $workbook->get_print_titles();

       Each print title array ref is as follows:

	   {
	       Row    => [ $start_row, $end_row ],
	       Column => [ $start_col, $end_col ],
	   }

       Returns undef if there are no print titles.

   using_1904_date()
       The "using_1904_date()" method returns true if the Excel file is using the 1904 date epoch instead of the 1900 epoch.

	   my $using_1904_date = $workbook->using_1904_date();

	The Windows version of Excel generally uses the 1900 epoch while the Mac version of Excel generally uses the 1904 epoch.

       Returns 0 if the 1900 epoch is in use.

AUTHOR

       Maintainer 0.40+: John McNamara jmcnamara@cpan.org

       Maintainer 0.27-0.33: Gabor Szabo szabgab@cpan.org

       Original author: Kawai Takanori kwitknr@cpan.org

COPYRIGHT

       Copyright (c) 2009-2010 John McNamara

       Copyright (c) 2006-2008 Gabor Szabo

       Copyright (c) 2000-2006 Kawai Takanori

       All rights reserved.

       You may distribute under the terms of either the GNU General Public License or the Artistic License, as specified in the Perl README file.

perl v5.10.1							    2010-09-17				    Spreadsheet::ParseExcel::Workbook(3pm)

Excel::Writer::XLSX::Chart::Column(3pm) 		User Contributed Perl Documentation		   Excel::Writer::XLSX::Chart::Column(3pm)

NAME

       Column - A class for writing Excel Column charts.

SYNOPSIS

       To create a simple Excel file with a Column chart using Excel::Writer::XLSX:

	   #!/usr/bin/perl

	   use strict;
	   use warnings;
	   use Excel::Writer::XLSX;

	   my $workbook  = Excel::Writer::XLSX->new( 'chart.xlsx' );
	   my $worksheet = $workbook->add_worksheet();

	   my $chart	 = $workbook->add_chart( type => 'column' );

	   # Configure the chart.
	   $chart->add_series(
	       categories => '=Sheet1!$A$2:$A$7',
	       values	  => '=Sheet1!$B$2:$B$7',
	   );

	   # Add the worksheet data the chart refers to.
	   my $data = [
	       [ 'Category', 2, 3, 4, 5, 6, 7 ],
	       [ 'Value',    1, 4, 5, 2, 1, 5 ],
	   ];

	   $worksheet->write( 'A1', $data );

	   __END__

DESCRIPTION

       This module implements Column charts for Excel::Writer::XLSX. The chart object is created via the Workbook "add_chart()" method:

	   my $chart = $workbook->add_chart( type => 'column' );

       Once the object is created it can be configured via the following methods that are common to all chart classes:

	   $chart->add_series();
	   $chart->set_x_axis();
	   $chart->set_y_axis();
	   $chart->set_title();

       These methods are explained in detail in Excel::Writer::XLSX::Chart. Class specific methods or settings, if any, are explained below.

Column Chart Methods
       The "Column" chart module also supports the following sub-types:

	   stacked
	   percent_stacked

       These can be specified at creation time via the "add_chart()" Worksheet method:

	   my $chart = $workbook->add_chart( type => 'column', subtype => 'stacked' );

EXAMPLE

       Here is a complete example that demonstrates most of the available features when creating a chart.

	   #!/usr/bin/perl

	   use strict;
	   use warnings;
	   use Excel::Writer::XLSX;

	   my $workbook  = Excel::Writer::XLSX->new( 'chart_column.xlsx' );
	   my $worksheet = $workbook->add_worksheet();
	   my $bold	 = $workbook->add_format( bold => 1 );

	   # Add the worksheet data that the charts will refer to.
	   my $headings = [ 'Number', 'Batch 1', 'Batch 2' ];
	   my $data = [
	       [ 2, 3, 4, 5, 6, 7 ],
	       [ 10, 40, 50, 20, 10, 50 ],
	       [ 30, 60, 70, 50, 40, 30 ],

	   ];

	   $worksheet->write( 'A1', $headings, $bold );
	   $worksheet->write( 'A2', $data );

	   # Create a new chart object. In this case an embedded chart.
	   my $chart = $workbook->add_chart( type => 'column', embedded => 1 );

	   # Configure the first series.
	   $chart->add_series(
	       name	  => '=Sheet1!$B$1',
	       categories => '=Sheet1!$A$2:$A$7',
	       values	  => '=Sheet1!$B$2:$B$7',
	   );

	   # Configure second series. Note alternative use of array ref to define
	   # ranges: [ $sheetname, $row_start, $row_end, $col_start, $col_end ].
	   $chart->add_series(
	       name	  => '=Sheet1!$C$1',
	       categories => [ 'Sheet1', 1, 6, 0, 0 ],
	       values	  => [ 'Sheet1', 1, 6, 2, 2 ],
	   );

	   # Add a chart title and some axis labels.
	   $chart->set_title ( name => 'Results of sample analysis' );
	   $chart->set_x_axis( name => 'Test number' );
	   $chart->set_y_axis( name => 'Sample length (mm)' );

	   # Set an Excel chart style. Blue colors with white outline and shadow.
	   $chart->set_style( 11 );

	   # Insert the chart into the worksheet (with an offset).
	   $worksheet->insert_chart( 'D2', $chart, 25, 10 );

	   __END__

AUTHOR

       John McNamara jmcnamara@cpan.org

COPYRIGHT

       Copyright MM-MMXII, John McNamara.

       All Rights Reserved. This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.

perl v5.10.1							    2012-04-02				   Excel::Writer::XLSX::Chart::Column(3pm)