Excel:...::Stock(3pm)

💖 Excel:...::Stock(3pm) 💖

okay bestie, sit down, hydrate, because we're talking about Stock — that's the Excel:...::Stock manual page, a whole class for writing Excel Stock charts. yes, real charts. in Excel. from Perl. we're iconic like that 🫶

---

✨ NAME ✨

Stock — a class for writing Excel Stock charts. that's it, that's the whole flex. 💅

---

✨ SYNOPSIS ✨

so the dream scenario is: you wanna make a simple Excel file with a Stock chart, and you're doing it with Excel::Writer::XLSX. here's the glow-up in code form:

#!/usr/bin/perl -w

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

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

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

# Add a series for each 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'
);

# Add the worksheet data the chart refers to.
# ... See the full example below.

__END__

see how there's a series for each High-Low-Close? that's not a coincidence, that's the whole point. keep reading, i'll explain. 😌

---

✨ DESCRIPTION ✨

this module implements Stock charts for Excel::Writer::XLSX. and the chart object? you don't just manifest it, you create it through the Workbook add_chart() method:

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

once the object exists — and she does exist — you can configure her with the following methods, which are the shared ones, common to all chart classes:

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

these are explained in detail in Excel::Writer::XLSX::Chart. literally go read it, it's giving textbook. as for the class-specific methods or settings — if there are any — they're explained right below. 👇

🌈 Stock Chart Methods 🌈

plot twist: there aren't currently any stock chart specific methods. none. zero. it's giving minimalism, honestly. check the TODO section of Excel::Writer::XLSX::Chart if you're curious about what's cooking.

but here's the tea you actually need 🍓: the default Stock chart is a High-Low-Close chart. so you must add a series for each of these data sources. all three of them. no skipping, no shortcuts, bestie. 💀

---

✨ EXAMPLE ✨

here's a complete example demonstrating most of the available features when creating a Stock chart. buckle up, it's a long one, but she serves. 👑

#!/usr/bin/perl

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

my $workbook    = Excel::Writer::XLSX->new( 'chart_stock.xlsx' );
my $worksheet   = $workbook->add_worksheet();
my $bold        = $workbook->add_format( bold => 1 );
my $date_format = $workbook->add_format( num_format => 'dd/mm/yyyy' );
my $chart       = $workbook->add_chart( type => 'stock', embedded => 1 );

# Add the worksheet data that the charts will refer to.
my $headings = [ 'Date', 'High', 'Low', 'Close' ];
my $data = [

    [ '2007-01-01T', '2007-01-02T', '2007-01-03T', '2007-01-04T', '2007-01-05T' ],
    [ 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( 'A1', $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( 'A:D', 11 );

# Add a series for each of the High-Low-Close columns.
$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',
);

# Add a chart title and some axis labels.
$chart->set_title ( name => 'High-Low-Close', );
$chart->set_x_axis( name => 'Date', );
$chart->set_y_axis( name => 'Share price', );

$worksheet->insert_chart( 'E9', $chart );

__END__

ngl, yes, use Excel::Writer::XLSX; shows up twice in there. keeping it 100% exactly as written, no edits, no notes. 🙈

---

✨ AUTHOR ✨

John McNamara jmcnamara@cpan.org — the legend, the moment, the blueprint. 🫶

---

✨ COPYRIGHT ✨

Copyright MM–MMXXV, 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. 💜

---

and that's the whole page, bestie!! 🎀 huge shoutout to perl v5.40.1 and the 2025-12-22 date stamp that closed us out — this manual page was, is, and forever will be, slay. periodt. 💅✨🦋