Worksheet

Returns a dictionary of cells with array formulae and the cells in array

Return a list of column ranges where more than one column

Produces all cells in the worksheet, by column (see iter_cols)

Returns the result of calculate_dimension

The maximum column index containing data (1-based)

:type: int

The maximum row index containing data (1-based)

:type: int

Return a copy of cell ranges

The minimum column index containing data (1-based)

:type: int

The minimum row index containing data (1-based)

:type: int

The print area for the worksheet, or None if not set. To set, supply a range like 'A1:D4' or a list of ranges.

Columns to be printed at the left side of every page (ex: 'A:C')

Rows to be printed at the top of every page (ex: '1:3')

Produces all cells in the worksheet, by row (see iter_rows)

:type: generator

Produces all cell values in the worksheet, by row

:type: generator

Convenience access by Excel style coordinates

The key can be a single cell coordinate 'A1', a range of cells 'A1:D25', individual rows or columns 'A', 4 or ranges of rows or columns 'A:D', 4:10.

Single cells will always be created if they do not exist.

Returns either a single cell or a tuple of rows or columns.

Add a chart to the sheet Optionally provide a cell for the top-left anchor

Add a data-validation object to the sheet. The data-validation object defines the type of data-validation to be applied and the cell or range of cells it should apply to.

Add an image to the sheet. Optionally provide a cell for the top-left anchor

Check for duplicate name in definedNames and other worksheet tables before adding table.

The data-validation vocabulary for cell (address string or Cell), or None when no list-type validation covers it (paper-xlsx).

Append one row to a supported named table atomically.

Return the minimum bounding range for all cells containing data (ex. 'A1:M24')

:rtype: string

Returns a cell object based on the given coordinates.

Usage: cell(row=15, column=1, value=5)

Calling cell creates cells in memory when they are first accessed.

Delete column or columns from col==idx

Under preserve=True on a loaded sheet, references into the shifted range are rewritten and an AddressRemap is returned; a delete that would strand a reference refuses with UnsupportedStructureError and changes nothing. Stock loads and added sheets keep upstream behaviour and return None.

Delete row or rows from row==idx

Under preserve=True on a loaded sheet, references into the shifted range are rewritten and an AddressRemap is returned; a delete that would strand a reference (or drop cells a chart or name still points at) refuses with UnsupportedStructureError and changes nothing. Stock loads and added sheets keep upstream behaviour and return None.

Insert column or columns before col==idx

Under preserve=True on a loaded sheet, references into the shifted range are rewritten and an AddressRemap is returned; a shift that would strand a reference refuses with UnsupportedStructureError and changes nothing. Stock loads and added sheets keep upstream behaviour and return None.

Insert row or rows before row==idx

Under preserve=True on a loaded sheet the fork rewrites every reference that points into the shifted range (formulas, defined names, chart series) and returns an AddressRemap so pre-edit addresses can be remapped; a shift that would strand a reference it cannot rewrite refuses with UnsupportedStructureError and changes nothing. Stock loads and in-session-added sheets keep the upstream behaviour — references are NOT updated — and return None.

Produces cells from the worksheet, by column. Specify the iteration range using indices of rows and columns.

If no indices are specified the range starts at A1.

If no cells are in the worksheet an empty tuple will be returned.

Produces cells from the worksheet, by row. Specify the iteration range using indices of rows and columns.

If no indices are specified the range starts at A1.

If no cells are in the worksheet an empty tuple will be returned.

Set merge on a cell range. Range is a cell range (e.g. A1:E1)

Move a cell range by the number of rows and/or columns: down if rows > 0 and up if rows < 0 right if cols > 0 and left if cols < 0 Existing cells will be overwritten. Formulae and references will not be updated.

Under preserve=True the move lands as tracked cell edits and refuses with UnsupportedStructureError (changing nothing) when it cannot keep the sheet coherent — e.g. merged ranges, tables, conditional formatting or data validation intersecting either rectangle, or outside formulas that reference the moved block.

Replace one loaded image while preserving its drawing anchor.

Set printer settings

Remove merge on a cell range. Range is a cell range (e.g. A1:E1)