—package
Excel::Writer::XLSX::Chart::Radar;
###############################################################################
#
# Radar - A class for writing Excel Radar charts.
#
# Used in conjunction with Excel::Writer::XLSX::Chart.
#
# See formatting note in Excel::Writer::XLSX::Chart.
#
# Copyright 2000-2020, 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;
our
@ISA
=
qw(Excel::Writer::XLSX::Chart)
;
our
$VERSION
=
'1.07'
;
###############################################################################
#
# new()
#
#
sub
new {
my
$class
=
shift
;
my
$self
= Excel::Writer::XLSX::Chart->new(
@_
);
$self
->{_subtype} =
$self
->{_subtype} ||
'marker'
;
if
(
$self
->{_subtype} eq
'marker'
) {
$self
->{_default_marker} = {
type
=>
'none'
};
}
# Override and reset the default axis values.
$self
->{_x_axis}->{_defaults}->{major_gridlines} = {
visible
=> 1 };
$self
->set_x_axis();
# Hardcode major_tick_mark for now until there is an accessor.
$self
->{_y_axis}->{_major_tick_mark} =
'cross'
;
# Set the available data label positions for this chart type.
$self
->{_label_position_default} =
'center'
;
$self
->{_label_positions} = {
center
=>
'ctr'
};
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:radarChart element.
$self
->_write_radar_chart(
@_
);
}
##############################################################################
#
# _write_radar_chart()
#
# Write the <c:radarChart> element.
#
sub
_write_radar_chart {
my
$self
=
shift
;
my
%args
=
@_
;
my
@series
;
if
(
$args
{primary_axes} ) {
@series
=
$self
->_get_primary_axes_series;
}
else
{
@series
=
$self
->_get_secondary_axes_series;
}
return
unless
scalar
@series
;
$self
->xml_start_tag(
'c:radarChart'
);
# Write the c:radarStyle element.
$self
->_write_radar_style();
# Write the series elements.
$self
->_write_series(
$_
)
for
@series
;
# Write the c:axId elements
$self
->_write_axis_ids(
%args
);
$self
->xml_end_tag(
'c:radarChart'
);
}
##############################################################################
#
# _write_radar_style()
#
# Write the <c:radarStyle> element.
#
sub
_write_radar_style {
my
$self
=
shift
;
my
$val
=
'marker'
;
if
(
$self
->{_subtype} eq
'filled'
) {
$val
=
'filled'
;
}
my
@attributes
= (
'val'
=>
$val
);
$self
->xml_empty_tag(
'c:radarStyle'
,
@attributes
);
}
1;
__END__
=head1 NAME
Radar - A class for writing Excel Radar charts.
=head1 SYNOPSIS
To create a simple Excel file with a Radar 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 => 'radar' );
# 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__
=head1 DESCRIPTION
This module implements Radar charts for L<Excel::Writer::XLSX>. The chart object is created via the Workbook C<add_chart()> method:
my $chart = $workbook->add_chart( type => 'radar' );
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 Radar Chart Methods
The C<Radar> chart module also supports the following sub-types:
with_markers
filled
These can be specified at creation time via the C<add_chart()> Worksheet method:
my $chart = $workbook->add_chart( type => 'radar', subtype => 'filled' );
=head1 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_radar.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 ],
[ 30, 60, 70, 50, 40, 30 ],
[ 25, 40, 50, 30, 50, 40 ],
];
$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 => 'radar', 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__
=begin html
<p>This will produce a chart that looks like this:</p>
<p><center><img src="http://jmcnamara.github.io/excel-writer-xlsx/images/examples/radar1.jpg" width="483" height="291" alt="Chart example." /></center></p>
=end html
=head1 AUTHOR
John McNamara jmcnamara@cpan.org
=head1 COPYRIGHT
Copyright MM-MMXX, 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.