Sheet

class Sheet(sheet=None)

A sheet object is a member of the sheets collection:

>>> import xlwings as xw
>>> wb = xw.Book()
>>> wb.sheets[0]
<Sheet [Book1]Sheet1>
>>> wb.sheets['Sheet1']
<Sheet [Book1]Sheet1>
>>> wb.sheets.add()
<Sheet [Book1]Sheet2>

Changed in version 0.9.0.

activate()

Activates the Sheet and returns it.

property api: Any: Returns the native object (pywin32 or appscript obj) of the engine being used.

Added in version 0.9.0.

autofit(axis=None)

Autofits the width of either columns, rows or both on a whole Sheet.

Parameters:: axis (str | None) – To autofit rows, use "rows" or "r". To autofit columns, use "columns" or "c". To autofit rows and columns, provide no arguments.

Examples

>>> import xlwings as xw
>>> wb = xw.Book()
>>> wb.sheets['Sheet1'].autofit('c')
>>> wb.sheets['Sheet1'].autofit('r')
>>> wb.sheets['Sheet1'].autofit()

Added in version 0.2.3.

property book: Book: Returns the Book of the specified Sheet. Read-only.

property cells: Range: Returns a Range object that represents all the cells on the Sheet (not just the cells that are currently in use).

Added in version 0.9.0.

property charts: Charts: See Charts

Added in version 0.9.0.

clear()

Clears the content and formatting of the whole sheet.

clear_contents()

Clears the content of the whole sheet but leaves the formatting.

clear_formats()

Clears the format of the whole sheet but leaves the content.

Added in version 0.26.2.

property comments: Comments: Threaded comments on this worksheet. In xlwings Lite, use await get_comments().

copy(before=None, after=None, name=None)

Copy a sheet to the current or a new Book. By default, it places the copied sheet after all existing sheets in the current Book. Returns the copied sheet.

Added in version 0.22.0.

Parameters:

before (Sheet | None) – The sheet object before which you want to place the sheet
after (Sheet | None) – The sheet object after which you want to place the sheet, by default it is placed after all existing sheets
name (str | None) – The sheet name of the copy

Return type:

Sheet

Examples

# Create two books and add a value to the first sheet of the first book
first_book = xw.Book()
second_book = xw.Book()
first_book.sheets[0]['A1'].value = 'some value'

# Copy to same Book with the default location and name
first_book.sheets[0].copy()

# Copy to same Book with custom sheet name
first_book.sheets[0].copy(name='copied')

# Copy to second Book requires to use before or after
first_book.sheets[0].copy(after=second_book.sheets[0])

delete()

Deletes the Sheet.

Added in version 0.6.0.

property freeze_panes: FreezePanes

Interface to freeze/unfreeze panes.

Examples

>>> mysheet.freeze_panes.freeze_at("A1")
>>> mysheet.freeze_panes.freeze_at(mysheet["A1"])
>>> mysheet.freeze_panes.freeze_at("A:A")
>>> mysheet.freeze_panes.freeze_at("1:1")
>>> mysheet.freeze_panes.unfreeze()

async get_comments()

Fetch this worksheet’s threaded comments.

Requires xlwings Lite.

Return type:: Comments

async get_used_range(values_only=False)

Returns the used range fetched from the current worksheet state, or None if the worksheet is empty according to values_only.

Parameters:: values_only (bool) – If True, only cells with values count as used. If False, cells with values or formatting count as used.
Return type:: Range | None

Unlike this method, used_range is a values-only snapshot in xlwings Lite and returns A1 for an empty worksheet for backward compatibility.

Requires xlwings Lite.

Added in version 0.37.5.

property index: int: Returns the index of the Sheet (1-based as in Excel).

async load(values=None)

(Re)loads the sheet’s data from Excel on demand.

Like Book.load, this loads only metadata by default on an async book and everything (including values) on a regular book. Pass values=True to also load this sheet’s cell values.

Requires xlwings Lite.

Return type:: Sheet

move(before=None, after=None)

Move a sheet within its current Book.

Provide exactly one of before or after. Both the sheet being moved and the target sheet must belong to the same Book.

Parameters:

before (Sheet | None) – The sheet before which you want to place this sheet.
after (Sheet | None) – The sheet after which you want to place this sheet.

Examples

book.sheets["Sheet3"].move(after=book.sheets["Sheet1"])

Added in version 0.37.5.

property name: str: Gets or sets the name of the Sheet.

property names: Names: Returns a names collection that represents all the sheet-specific names (names defined with the “SheetName!” prefix).

Added in version 0.9.0.

property notes: Notes: Notes on this worksheet, indexed by cell address or position.

property page_setup: PageSetup: Returns a PageSetup object.

Added in version 0.24.2.

property pictures: Pictures: See Pictures

Added in version 0.9.0.

property pivot_tables: PivotTables: See PivotTables

Added in version 0.37.3.

range(cell1, cell2=None)

Returns a Range object from the active sheet of the active book, see Range.

Added in version 0.9.0.

Return type:: Range

render_template(**data)

This method requires xlwings PRO.

Replaces all Jinja variables (e.g {{ myvar }}) in the sheet with the keyword argument that has the same name. Following variable types are supported:

strings, numbers, lists, simple dicts, NumPy arrays, Pandas DataFrames, PIL Image objects that have a filename and Matplotlib figures.

Added in version 0.22.0.

Parameters:: data (Any) – All key/value pairs that are used in the template.

Examples

>>> import xlwings as xw
>>> book = xw.Book()
>>> book.sheets[0]['A1:A2'].value = '{{ myvar }}'
>>> book.sheets[0].render_template(myvar='test')

select()

Selects the Sheet. Activates the book if it isn’t the active one.

Added in version 0.9.0.

property shapes: Shapes: See Shapes

Added in version 0.9.0.

property show_gridlines: bool

Gets or sets whether the sheet displays gridlines. This only affects what is shown on screen, not what is printed.

With classic xlwings (Python running locally), the sheet must be (temporarily) activated by xlwings, which means that you can’t use this with hidden sheets. xlwings Server and xlwings Lite don’t have this restriction.

Examples

>>> mysheet.show_gridlines = False

Added in version 0.37.3.

property tables: Tables: See Tables

Added in version 0.21.0.

to_html(path=None)

Export a Sheet as HTML page.

Parameters:: path (str | PathLike[str] | None) – Path where you want to save the HTML file. Defaults to Sheet name in the current working directory.

Added in version 0.28.1.

to_pdf(path=None, layout=None, show=False, quality='standard')

Exports the sheet to a PDF file.

Parameters:

path (str | PathLike[str] | None) – Path to the PDF file, defaults to the name of the sheet in the same directory of the workbook. For unsaved workbooks, it defaults to the current working directory instead.
layout (str | PathLike[str] | None) – This argument requires xlwings PRO. Path to a PDF file on which the report will be printed. This is ideal for headers and footers as well as borderless printing of graphics/artwork. The PDF file either needs to have only 1 page (every report page uses the same layout) or otherwise needs the same amount of pages as the report (each report page is printed on the respective page in the layout PDF). New in version 0.24.3.
show (bool) – Once created, open the PDF file with the default application. New in version 0.24.6.
quality (str) – Quality of the PDF file. Can either be 'standard' or 'minimum'. New in version 0.26.2.

Return type:

str

Examples

>>> wb = xw.Book()
>>> sheet = wb.sheets[0]
>>> sheet['A1'].value = 'PDF'
>>> sheet.to_pdf()