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 xlsxwriter 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) -> None:
29 """
30 Constructor.
32 """
33 super().__init__()
35 self.rotation = 0
36 self.hole_size = 50
38 def set_hole_size(self, size: int) -> None:
39 """
40 Set the Doughnut chart hole size.
42 Args:
43 size: 10 <= size <= 90.
45 Returns:
46 Nothing.
48 """
49 if size is None:
50 return
52 # Ensure the size is in Excel's range.
53 if size < 10 or size > 90:
54 warn("Chart hole size '{size}' outside Excel range: 10 <= size <= 90")
55 return
57 self.hole_size = int(size)
59 ###########################################################################
60 #
61 # Private API.
62 #
63 ###########################################################################
65 def _write_chart_type(self, args) -> None:
66 # Override the virtual superclass method with a chart specific method.
67 # Write the c:doughnutChart element.
68 self._write_doughnut_chart()
70 ###########################################################################
71 #
72 # XML methods.
73 #
74 ###########################################################################
76 def _write_doughnut_chart(self) -> None:
77 # Write the <c:doughnutChart> element. Over-ridden method to remove
78 # axis_id code since Doughnut charts don't require val and cat axes.
79 self._xml_start_tag("c:doughnutChart")
81 # Write the c:varyColors element.
82 self._write_vary_colors()
84 # Write the series elements.
85 for data in self.series:
86 self._write_ser(data)
88 # Write the c:firstSliceAng element.
89 self._write_first_slice_ang()
91 # Write the c:holeSize element.
92 self._write_c_hole_size()
94 self._xml_end_tag("c:doughnutChart")
96 def _write_c_hole_size(self) -> None:
97 # Write the <c:holeSize> element.
98 attributes = [("val", self.hole_size)]
100 self._xml_empty_tag("c:holeSize", attributes)