.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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.  | will give a
.\" real vertical bar.  \*(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-|\(bv\*(Tr
.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" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Spreadsheet::WriteExcel::Chart::Stock 3"
.TH Spreadsheet::WriteExcel::Chart::Stock 3 "2010-02-03" "perl v5.8.4" "User Contributed Perl Documentation"
.SH "NAME"
Stock \- A writer class for Excel Stock charts.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
To create a simple Excel file with a Stock chart using Spreadsheet::WriteExcel:
.PP
.Vb 1
\&    #!/usr/bin/perl -w
.Ve
.PP
.Vb 2
\&    use strict;
\&    use Spreadsheet::WriteExcel;
.Ve
.PP
.Vb 2
\&    my $workbook  = Spreadsheet::WriteExcel->new( 'chart.xls' );
\&    my $worksheet = $workbook->add_worksheet();
.Ve
.PP
.Vb 1
\&    my $chart     = $workbook->add_chart( type => 'stock' );
.Ve
.PP
.Vb 5
\&    # Add a series for each Open-High-Low-Close.
\&    $chart->add_series( categories => '=Sheet1!$A$2:$A$6', values => '=Sheet1!$B$2:$B$6' );
\&    $chart->add_series( categories => '=Sheet1!$A$2:$A$6', values => '=Sheet1!$C$2:$C$6' );
\&    $chart->add_series( categories => '=Sheet1!$A$2:$A$6', values => '=Sheet1!$D$2:$D$6' );
\&    $chart->add_series( categories => '=Sheet1!$A$2:$A$6', values => '=Sheet1!$E$2:$E$6' );
.Ve
.PP
.Vb 2
\&    # Add the worksheet data the chart refers to.
\&    # ... See the full example below.
.Ve
.PP
.Vb 1
\&    __END__
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module implements Stock charts for Spreadsheet::WriteExcel. The chart object is created via the Workbook \f(CW\*(C`add_chart()\*(C'\fR method:
.PP
.Vb 1
\&    my $chart = $workbook->add_chart( type => 'stock' );
.Ve
.PP
Once the object is created it can be configured via the following methods that are common to all chart classes:
.PP
.Vb 4
\&    $chart->add_series();
\&    $chart->set_x_axis();
\&    $chart->set_y_axis();
\&    $chart->set_title();
.Ve
.PP
These methods are explained in detail in Spreadsheet::WriteExcel::Chart. Class specific methods or settings, if any, are explained below.
.SH "Stock Chart Methods"
.IX Header "Stock Chart Methods"
There aren't currently any stock chart specific methods. See the \s-1TODO\s0 section of Spreadsheet::WriteExcel::Chart.
.PP
The default Stock chart is an Open-High-Low-Close chart. A series must be added for each of these data sources.
.PP
The default Stock chart is in black and white. User defined colours will be added at a later stage.
.SH "EXAMPLE"
.IX Header "EXAMPLE"
Here is a complete example that demonstrates most of the available features when creating a Stock chart.
.PP
.Vb 1
\&    #!/usr/bin/perl -w
.Ve
.PP
.Vb 2
\&    use strict;
\&    use Spreadsheet::WriteExcel;
.Ve
.PP
.Vb 4
\&    my $workbook    = Spreadsheet::WriteExcel->new( 'chart_stock_ex.xls' );
\&    my $worksheet   = $workbook->add_worksheet();
\&    my $bold        = $workbook->add_format( bold => 1 );
\&    my $date_format = $workbook->add_format( num_format => 'dd/mm/yyyy' );
.Ve
.PP
.Vb 9
\&    # Add the worksheet data that the charts will refer to.
\&    my $headings = [ 'Date', 'Open', 'High', 'Low', 'Close' ];
\&    my @data = (
\&        [ '2009-08-23', 110.75, 113.48, 109.05, 109.40 ],
\&        [ '2009-08-24', 111.24, 111.60, 103.57, 104.87 ],
\&        [ '2009-08-25', 104.96, 108.00, 103.88, 106.00 ],
\&        [ '2009-08-26', 104.95, 107.95, 104.66, 107.91 ],
\&        [ '2009-08-27', 108.10, 108.62, 105.69, 106.15 ],
\&    );
.Ve
.PP
.Vb 1
\&    $worksheet->write( 'A1', $headings, $bold );
.Ve
.PP
.Vb 9
\&    my $row = 1;
\&    for my $data ( @data ) {
\&        $worksheet->write( $row, 0, $data->[0], $date_format );
\&        $worksheet->write( $row, 1, $data->[1] );
\&        $worksheet->write( $row, 2, $data->[2] );
\&        $worksheet->write( $row, 3, $data->[3] );
\&        $worksheet->write( $row, 4, $data->[4] );
\&        $row++;
\&    }
.Ve
.PP
.Vb 2
\&    # Create a new chart object. In this case an embedded chart.
\&    my $chart = $workbook->add_chart( type => 'stock', embedded => 1 );
.Ve
.PP
.Vb 6
\&    # Add a series for each of the Open-High-Low-Close columns.
\&    $chart->add_series(
\&        categories => '=Sheet1!$A$2:$A$6',
\&        values     => '=Sheet1!$B$2:$B$6',
\&        name       => 'Open',
\&    );
.Ve
.PP
.Vb 5
\&    $chart->add_series(
\&        categories => '=Sheet1!$A$2:$A$6',
\&        values     => '=Sheet1!$C$2:$C$6',
\&        name       => 'High',
\&    );
.Ve
.PP
.Vb 5
\&    $chart->add_series(
\&        categories => '=Sheet1!$A$2:$A$6',
\&        values     => '=Sheet1!$D$2:$D$6',
\&        name       => 'Low',
\&    );
.Ve
.PP
.Vb 5
\&    $chart->add_series(
\&        categories => '=Sheet1!$A$2:$A$6',
\&        values     => '=Sheet1!$E$2:$E$6',
\&        name       => 'Close',
\&    );
.Ve
.PP
.Vb 4
\&    # Add a chart title and some axis labels.
\&    $chart->set_title( name => 'Open-High-Low-Close', );
\&    $chart->set_x_axis( name => 'Date', );
\&    $chart->set_y_axis( name => 'Share price', );
.Ve
.PP
.Vb 2
\&    # Insert the chart into the worksheet (with an offset).
\&    $worksheet->insert_chart( 'F2', $chart, 25, 10 );
.Ve
.PP
.Vb 1
\&    __END__
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
John McNamara jmcnamara@cpan.org
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright \s-1MM\-MMX\s0, John McNamara.
.PP
All Rights Reserved. This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.