/usr/share/perl5/Excel/Writer/XLSX/Chart/Stock.pm is in libexcel-writer-xlsx-perl 0.47-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 | package Excel::Writer::XLSX::Chart::Stock;
###############################################################################
#
# Stock - A class for writing Excel Stock charts.
#
# Used in conjunction with Excel::Writer::XLSX::Chart.
#
# See formatting note in Excel::Writer::XLSX::Chart.
#
# Copyright 2000-2012, John McNamara, jmcnamara@cpan.org
#
# Documentation after __END__
#
# perltidy with the following options: -mbl=2 -pt=0 -nola
use 5.008002;
use strict;
use warnings;
use Carp;
use Excel::Writer::XLSX::Chart;
our @ISA = qw(Excel::Writer::XLSX::Chart);
our $VERSION = '0.47';
###############################################################################
#
# new()
#
#
sub new {
my $class = shift;
my $self = Excel::Writer::XLSX::Chart->new( @_ );
bless $self, $class;
return $self;
}
##############################################################################
#
# _write_chart_type()
#
# Override the virtual superclass method with a chart specific method.
#
sub _write_chart_type {
my $self = shift;
# Write the c:stockChart element.
$self->_write_stock_chart();
}
##############################################################################
#
# _write_stock_chart()
#
# Write the <c:stockChart> element.
#
sub _write_stock_chart {
my $self = shift;
# Add default formatting to the series data.
$self->_modify_series_formatting();
$self->{_writer}->startTag( 'c:stockChart' );
# Write the series elements.
$self->_write_series();
$self->{_writer}->endTag( 'c:stockChart' );
}
##############################################################################
#
# _write_series()
#
# Over-ridden to add hi_low_lines(). TODO. Refactor up into the SUPER class.
#
# Write the series elements.
#
sub _write_series {
my $self = shift;
# Write each series with subelements.
my $index = 0;
for my $series ( @{ $self->{_series} } ) {
$self->_write_ser( $index++, $series );
}
# Write the c:hiLowLines element.
$self->_write_hi_low_lines();
# Write the c:marker element.
$self->_write_marker_value();
# Generate the axis ids.
$self->_add_axis_id();
$self->_add_axis_id();
# Write the c:axId element.
$self->_write_axis_id( $self->{_axis_ids}->[0] );
$self->_write_axis_id( $self->{_axis_ids}->[1] );
}
##############################################################################
#
# _write_plot_area()
#
# Write the <c:plotArea> element.
#
sub _write_plot_area {
my $self = shift;
$self->{_writer}->startTag( 'c:plotArea' );
# Write the c:layout element.
$self->_write_layout();
# Write the subclass chart type element.
$self->_write_chart_type();
# Write the c:dateAx element.
$self->_write_date_axis();
# Write the c:catAx element.
$self->_write_val_axis();
$self->{_writer}->endTag( 'c:plotArea' );
}
##############################################################################
#
# _modify_series_formatting()
#
# Add default formatting to the series data.
#
sub _modify_series_formatting {
my $self = shift;
my $index = 0;
for my $series ( @{ $self->{_series} } ) {
if ( $index % 4 != 3 ) {
if ( !$series->{_line}->{_defined} ) {
$series->{_line} = {
width => 2.25,
none => 1,
_defined => 1,
};
}
if ( !$series->{_marker} ) {
if ( $index % 4 == 2 ) {
$series->{_marker} = { type => 'dot', size => 3 };
}
else {
$series->{_marker} = { type => 'none' };
}
}
}
$index++;
}
}
1;
__END__
=head1 NAME
Stock - A class for writing Excel Stock charts.
=head1 SYNOPSIS
To create a simple Excel file with a Stock chart using Excel::Writer::XLSX:
#!/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__
=head1 DESCRIPTION
This module implements Stock charts for L<Excel::Writer::XLSX>. The chart object is created via the Workbook C<add_chart()> method:
my $chart = $workbook->add_chart( type => 'stock' );
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 L<Excel::Writer::XLSX::Chart>. Class specific methods or settings, if any, are explained below.
=head1 Stock Chart Methods
There aren't currently any stock chart specific methods. See the TODO section of L<Excel::Writer::XLSX::Chart>.
The default Stock chart is an High-Low-Close chart. A series must be added for each of these data sources.
=head1 EXAMPLE
Here is a complete example that demonstrates most of the available features when creating a Stock chart.
#!/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__
=begin html
<p>This will produce a chart that looks like this:</p>
<p><center><img src="http://homepage.eircom.net/~jmcnamara/perl/images/2007/stock1.jpg" width="483" height="291" alt="Chart example." /></center></p>
=end html
=head1 AUTHOR
John McNamara jmcnamara@cpan.org
=head1 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.
|