Theme

Defines format attributes for table elements for use with XlsxWriter.

For valid values, see XlsxWriter Format properties: https://xlsxwriter.readthedocs.io/format.html#format-methods-and-format-properties.

Attributes:

Name Type Description
cover_title_format dict
cover_subtitle_format dict
cover_text_format dict
title_format dict
subtitle_format dict
instructions_format dict
scope_format dict
column_heading_format dict
index_1_format dict
index_2_format dict
index_3_format dict
data_format dict
source_format dict
legend_format dict
description_order list
apply_config(config: Union[Dict[str, Any], str]) -> None

Update multiple Theme attributes using a YAML or dictionary config. This enables extension of build in Themes.

print_attributes() -> None

Print all current format attributes and values to the console.

update_column_heading_format(format_dict: Dict[str, Any]) -> None

Update the column_heading_format attribute. Where keys already exist, existing items are replaced.

update_cover_subtitle_format(format_dict: Dict[str, Any]) -> None

Update the cover_subtitle_format attribute. Where keys already exist, existing items are replaced.

update_cover_text_format(format_dict: Dict[str, Any]) -> None

Update the cover_text_format attribute. Where keys already exist, existing items are replaced.

update_cover_title_format(format_dict: Dict[str, Any]) -> None

Update the cover_title_format attribute. Where keys already exist, existing items are replaced.

update_data_format(format_dict: Dict[str, Any]) -> None

Update the data_format attribute. Where keys already exist, existing items are replaced.

update_description_order(order_list: List[str]) -> None

Update the description_order attribute. Overrides existing order.

update_index_1_format(format_dict: Dict[str, Any]) -> None

Update the index_1_format attribute. Where keys already exist, existing items are replaced.

update_index_2_format(format_dict: Dict[str, Any]) -> None

Update the index_2_format attribute. Where keys already exist, existing items are replaced.

update_index_3_format(format_dict: Dict[str, Any]) -> None

Update the index_3_format attribute. Where keys already exist, existing items are replaced.

update_instructions_format(format_dict: Dict[str, Any]) -> None

Update the instructions_format attribute. Where keys already exist, existing items are replaced.

update_legend_format(format_dict: Dict[str, Any]) -> None

Update the legend_format attribute. Where keys already exist, existing items are replaced.

update_location_format(format_dict: Dict[str, Any]) -> None

Update the location_format attribute. Where keys already exist, existing items are replaced.

update_scope_format(format_dict: Dict[str, Any]) -> None

Update the scope_format attribute. Where keys already exist, existing items are replaced.

update_source_format(format_dict: Dict[str, Any]) -> None

Update the source_format attribute. Where keys already exist, existing items are replaced.

update_subtitle_format(format_dict: Dict[str, Any]) -> None

Update the subtitle_format attribute. Where keys already exist, existing items are replaced.

update_title_format(format_dict: Dict[str, Any]) -> None

Update the title_format attribute. Where keys already exist, existing items are replaced.