.\" Automatically generated by Pod::Man 4.07 (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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Excel::Writer::XLSX::Chart::Stock 3pm"
.TH Excel::Writer::XLSX::Chart::Stock 3pm "2019-02-25" "perl v5.24.1" "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"
Stock \- A class for writing Excel Stock charts.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
To create a simple Excel file with a Stock chart using Excel::Writer::XLSX:
.PP
.Vb 1
\&    #!/usr/bin/perl \-w
\&
\&    use strict;
\&    use Excel::Writer::XLSX;
\&
\&    my $workbook  = Excel::Writer::XLSX\->new( \*(Aqchart.xlsx\*(Aq );
\&    my $worksheet = $workbook\->add_worksheet();
\&
\&    my $chart = $workbook\->add_chart( type => \*(Aqstock\*(Aq );
\&
\&    # Add a series for each High\-Low\-Close.
\&    $chart\->add_series(
\&        categories => \*(Aq=Sheet1!$A$2:$A$6\*(Aq,
\&        values     => \*(Aq=Sheet1!$B$2:$B$6\*(Aq
\&    );
\&
\&    $chart\->add_series(
\&        categories => \*(Aq=Sheet1!$A$2:$A$6\*(Aq,
\&        values     => \*(Aq=Sheet1!$C$2:$C$6\*(Aq
\&    );
\&
\&    $chart\->add_series(
\&        categories => \*(Aq=Sheet1!$A$2:$A$6\*(Aq,
\&        values     => \*(Aq=Sheet1!$D$2:$D$6\*(Aq
\&    );
\&
\&    # Add the worksheet data the chart refers to.
\&    # ... See the full example below.
\&
\&    _\|_END_\|_
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module implements Stock charts for Excel::Writer::XLSX. 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 => \*(Aqstock\*(Aq );
.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 Excel::Writer::XLSX::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 Excel::Writer::XLSX::Chart.
.PP
The default Stock chart is a High-Low-Close chart. A series must be added for each of these data sources.
.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
\&
\&    use strict;
\&    use warnings;
\&    use Excel::Writer::XLSX;
\&    use Excel::Writer::XLSX;
\&
\&    my $workbook    = Excel::Writer::XLSX\->new( \*(Aqchart_stock.xlsx\*(Aq );
\&    my $worksheet   = $workbook\->add_worksheet();
\&    my $bold        = $workbook\->add_format( bold => 1 );
\&    my $date_format = $workbook\->add_format( num_format => \*(Aqdd/mm/yyyy\*(Aq );
\&    my $chart       = $workbook\->add_chart( type => \*(Aqstock\*(Aq, embedded => 1 );
\&
\&
\&    # Add the worksheet data that the charts will refer to.
\&    my $headings = [ \*(AqDate\*(Aq, \*(AqHigh\*(Aq, \*(AqLow\*(Aq, \*(AqClose\*(Aq ];
\&    my $data = [
\&
\&        [ \*(Aq2007\-01\-01T\*(Aq, \*(Aq2007\-01\-02T\*(Aq, \*(Aq2007\-01\-03T\*(Aq, \*(Aq2007\-01\-04T\*(Aq, \*(Aq2007\-01\-05T\*(Aq ],
\&        [ 27.2,  25.03, 19.05, 20.34, 18.5 ],
\&        [ 23.49, 19.55, 15.12, 17.84, 16.34 ],
\&        [ 25.45, 23.05, 17.32, 20.45, 17.34 ],
\&
\&    ];
\&
\&    $worksheet\->write( \*(AqA1\*(Aq, $headings, $bold );
\&
\&    for my $row ( 0 .. 4 ) {
\&        $worksheet\->write_date_time( $row+1, 0, $data\->[0]\->[$row], $date_format );
\&        $worksheet\->write( $row+1, 1, $data\->[1]\->[$row] );
\&        $worksheet\->write( $row+1, 2, $data\->[2]\->[$row] );
\&        $worksheet\->write( $row+1, 3, $data\->[3]\->[$row] );
\&
\&    }
\&
\&    $worksheet\->set_column( \*(AqA:D\*(Aq, 11 );
\&
\&    # Add a series for each of the High\-Low\-Close columns.
\&    $chart\->add_series(
\&        categories => \*(Aq=Sheet1!$A$2:$A$6\*(Aq,
\&        values     => \*(Aq=Sheet1!$B$2:$B$6\*(Aq,
\&    );
\&
\&    $chart\->add_series(
\&        categories => \*(Aq=Sheet1!$A$2:$A$6\*(Aq,
\&        values     => \*(Aq=Sheet1!$C$2:$C$6\*(Aq,
\&    );
\&
\&    $chart\->add_series(
\&        categories => \*(Aq=Sheet1!$A$2:$A$6\*(Aq,
\&        values     => \*(Aq=Sheet1!$D$2:$D$6\*(Aq,
\&    );
\&
\&    # Add a chart title and some axis labels.
\&    $chart\->set_title ( name => \*(AqHigh\-Low\-Close\*(Aq, );
\&    $chart\->set_x_axis( name => \*(AqDate\*(Aq, );
\&    $chart\->set_y_axis( name => \*(AqShare price\*(Aq, );
\&
\&
\&    $worksheet\->insert_chart( \*(AqE9\*(Aq, $chart );
\&
\&    _\|_END_\|_
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
John McNamara jmcnamara@cpan.org
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright MM-MMXIX, 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.