# Copyright (c) 2010-2024 fastpyxl
"""Worksheet Properties"""
from fastpyxl.styles.colors import Color
from fastpyxl.typed_serialisable.base import Serialisable
from fastpyxl.typed_serialisable.errors import FieldValidationError
from fastpyxl.typed_serialisable.fields import Field
def _color_converter(value):
if value is None:
return None
if isinstance(value, Color):
return value
if isinstance(value, str):
return Color(rgb=value)
raise FieldValidationError(f"tabColor rejected value {value!r}")
[docs]
class Outline(Serialisable):
tagname = "outlinePr"
applyStyles: bool | None = Field.attribute(expected_type=bool, allow_none=True, default=None)
summaryBelow: bool | None = Field.attribute(expected_type=bool, allow_none=True, default=None)
summaryRight: bool | None = Field.attribute(expected_type=bool, allow_none=True, default=None)
showOutlineSymbols: bool | None = Field.attribute(expected_type=bool, allow_none=True, default=None)
def __init__(self,
applyStyles=None,
summaryBelow=None,
summaryRight=None,
showOutlineSymbols=None
):
self.applyStyles = applyStyles
self.summaryBelow = summaryBelow
self.summaryRight = summaryRight
self.showOutlineSymbols = showOutlineSymbols
[docs]
class PageSetupProperties(Serialisable):
tagname = "pageSetUpPr"
autoPageBreaks: bool | None = Field.attribute(expected_type=bool, allow_none=True, default=None)
fitToPage: bool | None = Field.attribute(expected_type=bool, allow_none=True, default=None)
def __init__(self, autoPageBreaks=None, fitToPage=None):
self.autoPageBreaks = autoPageBreaks
self.fitToPage = fitToPage
[docs]
class WorksheetProperties(Serialisable):
tagname = "sheetPr"
codeName: str | None = Field.attribute(expected_type=str, allow_none=True, default=None)
enableFormatConditionsCalculation: bool | None = Field.attribute(expected_type=bool, allow_none=True, default=None)
filterMode: bool | None = Field.attribute(expected_type=bool, allow_none=True, default=None)
published: bool | None = Field.attribute(expected_type=bool, allow_none=True, default=None)
syncHorizontal: bool | None = Field.attribute(expected_type=bool, allow_none=True, default=None)
syncRef: str | None = Field.attribute(expected_type=str, allow_none=True, default=None)
syncVertical: bool | None = Field.attribute(expected_type=bool, allow_none=True, default=None)
transitionEvaluation: bool | None = Field.attribute(expected_type=bool, allow_none=True, default=None)
transitionEntry: bool | None = Field.attribute(expected_type=bool, allow_none=True, default=None)
tabColor: Color | None = Field.element(expected_type=Color, allow_none=True, converter=_color_converter, default=None)
outlinePr: Outline | None = Field.element(expected_type=Outline, allow_none=True, default=None)
pageSetUpPr: PageSetupProperties | None = Field.element(expected_type=PageSetupProperties, allow_none=True, default=None)
xml_order = ("tabColor", "outlinePr", "pageSetUpPr")
def __init__(self,
codeName=None,
enableFormatConditionsCalculation=None,
filterMode=None,
published=None,
syncHorizontal=None,
syncRef=None,
syncVertical=None,
transitionEvaluation=None,
transitionEntry=None,
tabColor=None,
outlinePr=None,
pageSetUpPr=None
):
self.codeName = codeName
self.enableFormatConditionsCalculation = enableFormatConditionsCalculation
self.filterMode = filterMode
self.published = published
self.syncHorizontal = syncHorizontal
self.syncRef = syncRef
self.syncVertical = syncVertical
self.transitionEvaluation = transitionEvaluation
self.transitionEntry = transitionEntry
self.tabColor = tabColor
if outlinePr is None:
self.outlinePr = Outline(summaryBelow=True, summaryRight=True)
else:
self.outlinePr = outlinePr
if pageSetUpPr is None:
pageSetUpPr = PageSetupProperties()
self.pageSetUpPr = pageSetUpPr
