Shortcuts on this page
r m x toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1###############################################################################
2#
3# ChartDoughnut - A class for writing the Excel XLSX Doughnut charts.
4#
5# SPDX-License-Identifier: BSD-2-Clause
6#
7# Copyright (c) 2013-2025, John McNamara, jmcnamara@cpan.org
8#
10from warnings import warn
12from . import chart_pie
15class ChartDoughnut(chart_pie.ChartPie):
16 """
17 A class for writing the Excel XLSX Doughnut charts.
20 """
22 ###########################################################################
23 #
24 # Public API.
25 #
26 ###########################################################################
28 def __init__(self):
29 """
30 Constructor.
32 """
33 super().__init__()
35 self.vary_data_color = 1
36 self.rotation = 0
37 self.hole_size = 50
39 def set_hole_size(self, size):
40 """
41 Set the Doughnut chart hole size.
43 Args:
44 size: 10 <= size <= 90.
46 Returns:
47 Nothing.
49 """
50 if size is None:
51 return
53 # Ensure the size is in Excel's range.
54 if size < 10 or size > 90:
55 warn("Chart hole size '{size}' outside Excel range: 10 <= size <= 90")
56 return
58 self.hole_size = int(size)
60 ###########################################################################
61 #
62 # Private API.
63 #
64 ###########################################################################
66 def _write_chart_type(self, args):
67 # Override the virtual superclass method with a chart specific method.
68 # Write the c:doughnutChart element.
69 self._write_doughnut_chart()
71 ###########################################################################
72 #
73 # XML methods.
74 #
75 ###########################################################################
77 def _write_doughnut_chart(self):
78 # Write the <c:doughnutChart> element. Over-ridden method to remove
79 # axis_id code since Doughnut charts don't require val and cat axes.
80 self._xml_start_tag("c:doughnutChart")
82 # Write the c:varyColors element.
83 self._write_vary_colors()
85 # Write the series elements.
86 for data in self.series:
87 self._write_ser(data)
89 # Write the c:firstSliceAng element.
90 self._write_first_slice_ang()
92 # Write the c:holeSize element.
93 self._write_c_hole_size()
95 self._xml_end_tag("c:doughnutChart")
97 def _write_c_hole_size(self):
98 # Write the <c:holeSize> element.
99 attributes = [("val", self.hole_size)]
101 self._xml_empty_tag("c:holeSize", attributes)