excel::writer::xlsx::chart::scatter(3pm) debian man page | unix.com

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

NAME
       Scatter - A class for writing Excel Scatter charts.

SYNOPSIS
       To create a simple Excel file with a Scatter 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 => 'scatter' );

	   # 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 Scatter charts for Excel::Writer::XLSX. The chart object is created via the Workbook "add_chart()" method:

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

       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.

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

	   markers_only (the default)
	   straight_with_markers
	   straight
	   smooth_with_markers
	   smooth

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

	   my $chart = $workbook->add_chart(
	       type    => 'scatter',
	       subtype => 'straight_with_markers'
	   );

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_scatter.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 => 'scatter', 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. Colors with white outline and shadow.
	   $chart->set_style( 10 );

	   # 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::Scatter(3pm)