Skip to content

Commit

Permalink
Add support for leader lines to all chart types.
Browse files Browse the repository at this point in the history
  • Loading branch information
@jmcnamara
jmcnamara committed Sep 30, 2023
1 parent 05a9705 commit 829088f
Show file tree
Hide file tree
Showing 5 changed files with 142 additions and 36 deletions.
26 changes: 21 additions & 5 deletions lib/Excel/Writer/XLSX/Chart.pm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6085,16 +6085,32 @@ sub _write_separator {
#
# _write_show_leader_lines()
#
# Write the <c:showLeaderLines> element.
# Write the <c:showLeaderLines> element. This is different for Pie/Doughnut
# charts. Other chart types only supported leader lines after Excel 2015 via
# an extension element.
#
sub _write_show_leader_lines {

my $self = shift;
my $val = 1;
my $self = shift;
my $color = shift;

my @attributes = ( 'val' => $val );
my $uri = '{CE6537A1-D6FC-4f65-9D91-7224C49458BB}';
my $xmlns_c_15 = 'http://schemas.microsoft.com/office/drawing/2012/chart';

$self->xml_empty_tag( 'c:showLeaderLines', @attributes );

my @attributes1 = (
'uri' => $uri,
'xmlns:c15' => $xmlns_c_15,
);

my @attributes2 = ( 'val' => 1 );


$self->xml_start_tag( 'c:extLst' );
$self->xml_start_tag( 'c:ext', @attributes1 );
$self->xml_empty_tag( 'c15:showLeaderLines', @attributes2 );
$self->xml_end_tag( 'c:ext' );
$self->xml_end_tag( 'c:extLst' );
}


Expand Down
21 changes: 21 additions & 0 deletions lib/Excel/Writer/XLSX/Chart/Pie.pm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -349,6 +349,27 @@ sub _write_first_slice_ang {
1;


##############################################################################
#
# _write_show_leader_lines()
#
# Write the <c:showLeaderLines> element. This is for Pie/Doughnut charts.
# Other chart types only supported leader lines after Excel 2015 via an
# extension element.
#
sub _write_show_leader_lines {

my $self = shift;
my $val = 1;

my @attributes = ( 'val' => $val );

$self->xml_empty_tag( 'c:showLeaderLines', @attributes );
}




__END__
Expand Down
39 changes: 8 additions & 31 deletions t/chart/sub_write_d_lbls.t
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@ use TestFunctions '_new_object';
use strict;
use warnings;
use Excel::Writer::XLSX::Chart;
use Excel::Writer::XLSX::Chart::Pie;

use Test::More tests => 18;
use Test::More tests => 17;


###############################################################################
Expand Down Expand Up @@ -284,7 +285,7 @@ $expected = '<c:dLbls><c:showVal val="1"/><c:showLeaderLines val="1"/></c:dLbls>

$arg{data_labels} = { value => 1, leader_lines => 1 };

$chart = _new_object( \$got, 'Excel::Writer::XLSX::Chart' );
$chart = _new_object( \$got, 'Excel::Writer::XLSX::Chart::Pie' );
$chart->{_label_positions} = {
center => 'ctr',
right => 'r',
Expand All @@ -309,7 +310,7 @@ $expected = '<c:dLbls><c:showVal val="1"/><c:showLeaderLines val="1"/></c:dLbls>

$arg{data_labels} = { value => 1, leader_lines => 1, position => '' };

$chart = _new_object( \$got, 'Excel::Writer::XLSX::Chart' );
$chart = _new_object( \$got, 'Excel::Writer::XLSX::Chart::Pie' );
$chart->{_label_positions} = {
center => 'ctr',
right => 'r',
Expand All @@ -334,7 +335,7 @@ $expected = '<c:dLbls><c:dLblPos val="ctr"/><c:showVal val="1"/><c:showLeaderLin

$arg{data_labels} = { value => 1, leader_lines => 1, position => 'center' };

$chart = _new_object( \$got, 'Excel::Writer::XLSX::Chart' );
$chart = _new_object( \$got, 'Excel::Writer::XLSX::Chart::Pie' );

$chart->{_label_positions} = {
center => 'ctr',
Expand All @@ -360,7 +361,7 @@ $expected = '<c:dLbls><c:dLblPos val="inEnd"/><c:showVal val="1"/><c:showLeaderL

$arg{data_labels} = { value => 1, leader_lines => 1, position => 'inside_end' };

$chart = _new_object( \$got, 'Excel::Writer::XLSX::Chart' );
$chart = _new_object( \$got, 'Excel::Writer::XLSX::Chart::Pie' );
$chart->{_label_positions} = {
center => 'ctr',
inside_base => 'inBase',
Expand All @@ -384,7 +385,7 @@ $expected = '<c:dLbls><c:dLblPos val="outEnd"/><c:showVal val="1"/><c:showLeader

$arg{data_labels} = { value => 1, leader_lines => 1, position => 'outside_end' };

$chart = _new_object( \$got, 'Excel::Writer::XLSX::Chart' );
$chart = _new_object( \$got, 'Excel::Writer::XLSX::Chart::Pie' );
$chart->{_label_positions} = {
center => 'ctr',
inside_base => 'inBase',
Expand All @@ -399,30 +400,6 @@ $chart->_write_d_lbls( $labels );
is( $got, $expected, $caption );


###############################################################################
#
# Test the _write_d_lbls() method. Pie chart. Postion = best_fit
#
$caption = " \tChart: _write_d_lbls()";
$expected = '<c:dLbls><c:dLblPos val="bestFit"/><c:showVal val="1"/><c:showLeaderLines val="1"/></c:dLbls>';

$arg{data_labels} = { value => 1, leader_lines => 1, position => 'best_fit' };

$chart = _new_object( \$got, 'Excel::Writer::XLSX::Chart' );
$chart->{_label_positions} = {
center => 'ctr',
inside_base => 'inBase',
inside_end => 'inEnd',
outside_end => 'outEnd',
best_fit => 'bestFit',
};

$labels = $chart->_get_labels_properties( $arg{data_labels} );

$chart->_write_d_lbls( $labels );

is( $got, $expected, $caption );


###############################################################################
#
Expand All @@ -433,7 +410,7 @@ $expected = '<c:dLbls><c:showPercent val="1"/><c:showLeaderLines val="1"/></c:dL

$arg{data_labels} = { leader_lines => 1, percentage => 1 };

$chart = _new_object( \$got, 'Excel::Writer::XLSX::Chart' );
$chart = _new_object( \$got, 'Excel::Writer::XLSX::Chart::Pie' );

$labels = $chart->_get_labels_properties( $arg{data_labels} );

Expand Down
92 changes: 92 additions & 0 deletions t/regression/chart_data_labels51.t
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
###############################################################################
#
# Tests the output of Excel::Writer::XLSX against Excel generated files.
#
# Copyright 2000-2023, John McNamara, [email protected]
#
# SPDX-License-Identifier: Artistic-1.0-Perl OR GPL-1.0-or-later
#

use lib 't/lib';
use TestFunctions qw(_compare_xlsx_files _is_deep_diff);
use strict;
use warnings;

use Test::More tests => 1;

###############################################################################
#
# Tests setup.
#
my $filename = 'chart_data_labels51.xlsx';
my $dir = 't/regression/';
my $got_filename = $dir . "ewx_$filename";
my $exp_filename = $dir . 'xlsx_files/' . $filename;

my $ignore_members = [];

my $ignore_elements = {};


###############################################################################
#
# Test the creation of a simple Excel::Writer::XLSX file.
#
use Excel::Writer::XLSX;

my $workbook = Excel::Writer::XLSX->new( $got_filename );
my $worksheet = $workbook->add_worksheet();
my $chart = $workbook->add_chart( type => 'column', embedded => 1 );

# For testing, copy the randomly generated axis ids in the target xlsx file.
$chart->{_axis_ids} = [ 45848832, 47718784 ];

my $data = [
[ 1, 2, 3, 4, 5 ],
[ 2, 4, 6, 8, 10 ],
[ 3, 6, 9, 12, 15 ],

];

$worksheet->write( 'A1', $data );

$chart->add_series(
values => '=Sheet1!$A$1:$A$5',
data_labels => { value => 1, position => 'outside_end', leader_lines => 1 },
);

$chart->add_series(
values => '=Sheet1!$B$1:$B$5',
data_labels => { value => 1, position => 'inside_base' },
);

$chart->add_series( values => '=Sheet1!$C$1:$C$5' );

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

$workbook->close();


###############################################################################
#
# Compare the generated and existing Excel files.
#

my ( $got, $expected, $caption ) = _compare_xlsx_files(

$got_filename,
$exp_filename,
$ignore_members,
$ignore_elements,
);

_is_deep_diff( $got, $expected, $caption );


###############################################################################
#
# Cleanup.
#
unlink $got_filename;

__END__
Binary file added t/regression/xlsx_files/chart_data_labels51.xlsx
View file
Binary file not shown.

0 comments on commit 829088f

Please sign in to comment.