paper-xlsxAPI referencewriter.excel

WorksheetWriter

paper-xlsx 0.2.1 API reference

WorksheetWriter(ws, out=None)

Attributes

`out`

attributeout

= out

`ws`

attributews

= ws

`xf`

attributexf

= self.get_stream()

Functions

`cleanup`

funccleanup()

Remove tempfile

`close`

funcclose()

Close the context manager

`get_stream`

funcget_stream()

`read`

funcread()

Close the context manager and return serialised XML

`rows`

funcrows()

Return all rows, and any cells that they contain

`write`

funcwrite()

High level

`write_breaks`

funcwrite_breaks()

`write_cols`

funcwrite_cols()

`write_dimensions`

funcwrite_dimensions()

Write worksheet size if known

`write_drawings`

funcwrite_drawings()

`write_filter`

funcwrite_filter()

`write_format`

funcwrite_format()

`write_formatting`

funcwrite_formatting()

`write_header`

funcwrite_header()

`write_hyperlinks`

funcwrite_hyperlinks()

`write_legacy`

funcwrite_legacy()

Comments & VBA controls use VML and require an additional element that is no longer in the specification.

`write_margins`

funcwrite_margins()

`write_merged_cells`

funcwrite_merged_cells()

`write_page`

funcwrite_page()

`write_print`

funcwrite_print()

`write_properties`

funcwrite_properties()

`write_protection`

funcwrite_protection()

`write_row`

funcwrite_row(xf, row, row_idx)

paramxf

paramrow

paramrow_idx

`write_rows`

funcwrite_rows()

`write_scenarios`

funcwrite_scenarios()

`write_sort`

funcwrite_sort()

As per discusion with the OOXML Working Group global sort state is not required. openpyxl never reads it from existing files

`write_tables`

funcwrite_tables()

`write_tail`

funcwrite_tail()

Write all elements after the rows calc properties protection protected ranges # scenarios filters sorts # always ignored data consolidation # custom views # merged cells phonetic properties # conditional formatting data validation hyperlinks print options page margins page setup header row breaks col breaks custom properties # cell watches # ignored errors # smart tags # drawing drawingHF # background # OLE objects # controls # web publishing # tables

`write_top`

funcwrite_top()

Write all elements up to rows: properties dimensions views format cols

`write_validations`

funcwrite_validations()

`write_views`

funcwrite_views()

WorkbookWriter

paper-xlsx 0.2.1 API reference

openpyxl.writer.theme

paper-xlsx 0.2.1 API reference