198 lines
5.3 KiB
Python
198 lines
5.3 KiB
Python
###############################################################################
|
|
#
|
|
# Chartsheet - A class for writing the Excel XLSX Worksheet file.
|
|
#
|
|
# SPDX-License-Identifier: BSD-2-Clause
|
|
#
|
|
# Copyright (c) 2013-2025, John McNamara, jmcnamara@cpan.org
|
|
#
|
|
|
|
from . import worksheet
|
|
from .drawing import Drawing
|
|
|
|
|
|
class Chartsheet(worksheet.Worksheet):
|
|
"""
|
|
A class for writing the Excel XLSX Chartsheet file.
|
|
|
|
|
|
"""
|
|
|
|
###########################################################################
|
|
#
|
|
# Public API.
|
|
#
|
|
###########################################################################
|
|
|
|
def __init__(self):
|
|
"""
|
|
Constructor.
|
|
|
|
"""
|
|
|
|
super().__init__()
|
|
|
|
self.is_chartsheet = True
|
|
self.drawing = None
|
|
self.chart = None
|
|
self.charts = []
|
|
self.zoom_scale_normal = 0
|
|
self.orientation = 0
|
|
self.protection = False
|
|
|
|
def set_chart(self, chart):
|
|
"""
|
|
Set the chart object for the chartsheet.
|
|
Args:
|
|
chart: Chart object.
|
|
Returns:
|
|
chart: A reference to the chart object.
|
|
"""
|
|
chart.embedded = False
|
|
chart.protection = self.protection
|
|
self.chart = chart
|
|
self.charts.append([0, 0, chart, 0, 0, 1, 1])
|
|
return chart
|
|
|
|
def protect(self, password="", options=None):
|
|
"""
|
|
Set the password and protection options of the worksheet.
|
|
|
|
Args:
|
|
password: An optional password string.
|
|
options: A dictionary of worksheet objects to protect.
|
|
|
|
Returns:
|
|
Nothing.
|
|
|
|
"""
|
|
# This method is overridden from parent worksheet class.
|
|
|
|
# Chartsheets only allow a reduced set of protect options.
|
|
copy = {}
|
|
|
|
if not options:
|
|
options = {}
|
|
|
|
if options.get("objects") is None:
|
|
copy["objects"] = False
|
|
else:
|
|
# Objects are default on for chartsheets, so reverse state.
|
|
copy["objects"] = not options["objects"]
|
|
|
|
if options.get("content") is None:
|
|
copy["content"] = True
|
|
else:
|
|
copy["content"] = options["content"]
|
|
|
|
copy["sheet"] = False
|
|
copy["scenarios"] = True
|
|
|
|
# If objects and content are both off then the chartsheet isn't
|
|
# protected, unless it has a password.
|
|
if password == "" and copy["objects"] and not copy["content"]:
|
|
return
|
|
|
|
if self.chart:
|
|
self.chart.protection = True
|
|
else:
|
|
self.protection = True
|
|
|
|
# Call the parent method.
|
|
super().protect(password, copy)
|
|
|
|
###########################################################################
|
|
#
|
|
# Private API.
|
|
#
|
|
###########################################################################
|
|
def _assemble_xml_file(self):
|
|
# Assemble and write the XML file.
|
|
|
|
# Write the XML declaration.
|
|
self._xml_declaration()
|
|
|
|
# Write the root worksheet element.
|
|
self._write_chartsheet()
|
|
|
|
# Write the worksheet properties.
|
|
self._write_sheet_pr()
|
|
|
|
# Write the sheet view properties.
|
|
self._write_sheet_views()
|
|
|
|
# Write the sheetProtection element.
|
|
self._write_sheet_protection()
|
|
|
|
# Write the printOptions element.
|
|
self._write_print_options()
|
|
|
|
# Write the worksheet page_margins.
|
|
self._write_page_margins()
|
|
|
|
# Write the worksheet page setup.
|
|
self._write_page_setup()
|
|
|
|
# Write the headerFooter element.
|
|
self._write_header_footer()
|
|
|
|
# Write the drawing element.
|
|
self._write_drawings()
|
|
|
|
# Write the legacyDrawingHF element.
|
|
self._write_legacy_drawing_hf()
|
|
|
|
# Close the worksheet tag.
|
|
self._xml_end_tag("chartsheet")
|
|
|
|
# Close the file.
|
|
self._xml_close()
|
|
|
|
def _prepare_chart(self, index, chart_id, drawing_id):
|
|
# Set up chart/drawings.
|
|
|
|
self.chart.id = chart_id - 1
|
|
|
|
self.drawing = Drawing()
|
|
self.drawing.orientation = self.orientation
|
|
|
|
self.external_drawing_links.append(
|
|
["/drawing", "../drawings/drawing" + str(drawing_id) + ".xml"]
|
|
)
|
|
|
|
self.drawing_links.append(
|
|
["/chart", "../charts/chart" + str(chart_id) + ".xml"]
|
|
)
|
|
|
|
###########################################################################
|
|
#
|
|
# XML methods.
|
|
#
|
|
###########################################################################
|
|
|
|
def _write_chartsheet(self):
|
|
# Write the <worksheet> element. This is the root element.
|
|
|
|
schema = "http://schemas.openxmlformats.org/"
|
|
xmlns = schema + "spreadsheetml/2006/main"
|
|
xmlns_r = schema + "officeDocument/2006/relationships"
|
|
|
|
attributes = [("xmlns", xmlns), ("xmlns:r", xmlns_r)]
|
|
|
|
self._xml_start_tag("chartsheet", attributes)
|
|
|
|
def _write_sheet_pr(self):
|
|
# Write the <sheetPr> element for Sheet level properties.
|
|
attributes = []
|
|
|
|
if self.filter_on:
|
|
attributes.append(("filterMode", 1))
|
|
|
|
if self.fit_page or self.tab_color:
|
|
self._xml_start_tag("sheetPr", attributes)
|
|
self._write_tab_color()
|
|
self._write_page_set_up_pr()
|
|
self._xml_end_tag("sheetPr")
|
|
else:
|
|
self._xml_empty_tag("sheetPr", attributes)
|