GPWorksheet

Bases: Worksheet

Wrapper for an XlsxWriter.Worksheet object. Provides a method for writing a good practice table (GPTable) to a Worksheet.

write_cover(cover: Cover) -> list

Write a cover page to the Worksheet. Uses text from a Cover object and details of the Workbook contents.

Parameters:

Name	Type	Description	Default
cover	Cover	object containing cover sheet text	required

Returns:

Name	Type	Description
pos	list	position [row, col] immediately after the last written element

write_gptable(gptable: GPTable, auto_width: bool, reference_order: list = [], start_pos: list = None) -> None

Write data from a GPTable object to the worksheet using the workbook Theme object for formatting.

Parameters:

Name	Type	Description	Default
gptable	GPTable	object containing elements of the gptable to be written to the Worksheet	required
auto_width	bool	If True, automatically determine column widths from cell content.	required
reference_order	list	order of annotations in workbook must be provided if gptable uses annotations	[]
start_pos	list	[row, col] position to begin writing from, defaults to [0, 0]	None

Returns:

Type	Description
None