Sheet¶
- 类 Sheet(表格中设置部署密钥=None, 实现=None)¶
工作表对象是
sheets
集合访问它们:>>> 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>
在版本 0.9.0 中更改。
- 激活()¶
激活工作表并返回它。
- 属性 api¶
返回所使用引擎的原生对象 (
pywin32
或appscript
obj) 使用的引擎的成员。在版本 0.9.0 中添加。
- autofit(轴线=None)¶
自动调整整个工作表的列宽、行高或两者。
参数¶
- 轴线字符串,默认为 None
若要自动调整行高,请使用以下之一:
rows
或r
若要自动调整列宽,请使用以下之一:
columns
或c
若要自动调整行高和列宽,请不提供参数。
示例¶
>>> import xlwings as xw >>> wb = xw.Book() >>> wb.sheets['Sheet1'].autofit('c') >>> wb.sheets['Sheet1'].autofit('r') >>> wb.sheets['Sheet1'].autofit()
添加于版本 0.2.3。
- 属性 工作簿¶
返回指定工作表的工作簿。只读。
- 属性 单元格¶
返回一个表示工作表上所有单元格的范围对象(不仅仅是当前使用的单元格)。
在版本 0.9.0 中添加。
- clear()¶
清除整个工作表的内容和格式。
- clear_contents()¶
清除整个工作表的内容但保留格式。
- clear_formats()¶
清除整个工作表的格式但保留内容。
添加于版本 0.26.2。
- copy(之前=None, 之后=None, 名称=None)¶
将工作表复制到当前工作簿或新工作簿中。默认情况下,会将复制的工作表放置在当前工作簿中所有现有工作表之后。返回复制的工作表。
在版本0.22.0中添加。
参数¶
- 之前工作表对象,默认为 None
您希望在其之前放置工作表的工作表对象。
- 之后工作表对象,默认为 None
您希望在其之后放置工作表的工作表对象,默认是放置在所有现有工作表之后。
- 名称字符串,默认值为 None
复制工作表的名称。
返回值¶
- 工作表对象:工作表
复制的工作表。
示例¶
# 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])
- 删除()¶
删除工作表。
添加于版本 0.6.0。
- 属性 冻结窗格¶
冻结/解冻窗格的接口。
示例¶
>>> 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()
- 属性 索引¶
返回工作表的索引(基于1,与Excel相同)。
- 属性 名称¶
获取或设置工作表的名称。
- 属性 名称¶
返回一个表示所有特定于工作表的名称的集合对象(定义时带有“SheetName!”前缀)。
在版本 0.9.0 中添加。
- 属性 页面设置¶
返回一个 PageSetup 对象。
添加于版本 0.24.2。
- 渲染模板(**数据)¶
此方法需要 xlwingsPRO.
替换书中的所有 Jinja 变量(例如
{{ myvar }}
) 使用具有相同名称的关键字参数在工作表中获取或设置该值。支持以下变量类型:字符串、数字、列表、简单字典、NumPy 数组、Pandas DataFrame、具有文件名的 PIL 图像对象和 Matplotlib 图形。
在版本0.22.0中添加。
参数¶
- 数据:kwargs
模板中使用的所有键/值对。
示例¶
>>> import xlwings as xw >>> book = xw.Book() >>> book.sheets[0]['A1:A2'].value = '{{ myvar }}' >>> book.sheets[0].render_template(myvar='test')
- 选择范围。仅在活动书中有效。()¶
选择工作表。如果工作簿不是活动的,则激活它。
在版本 0.9.0 中添加。
- 转换为 HTML(路径=None)¶
将工作表导出为 HTML 页面。
参数¶
- 路径字符串或路径类似对象,默认为 None
要保存 HTML 文件的路径。默认为当前工作目录中的工作表名称。
在版本 0.28.1 中添加。
- 导出为 PDF(路径=None, 布局=None, 显示=False, 质量='标准')¶
将工作表导出为 PDF 文件。
参数¶
- 路径字符串或路径类似对象,默认为 None
PDF 文件的路径,默认为工作簿所在目录中的工作表名称。对于未保存的工作簿,默认使用当前工作目录。
- 布局字符串或路径类似对象,默认为 None
此参数需要 xlwingsPRO.
用于打印报告的 PDF 文件路径。这是理想的选择页眉和页脚以及无边框打印图形/艺术品。PDF 文件要么需要只有一页(每页报告页面使用相同的布局),或者需要与报告相同的页数(每页报告页面打印在相应的布局 PDF 页面上)。
在版本0.24.3中添加。
- 显示布尔值,默认为False
创建后,使用默认应用程序打开 PDF 文件。
在版本0.24.6中添加。
- 质量字符串,默认值
'standard'
PDF 文件的质量。可以是
'standard'
或'minimum'
.添加于版本 0.26.2。
示例¶
>>> wb = xw.Book() >>> sheet = wb.sheets[0] >>> sheet['A1'].value = 'PDF' >>> sheet.to_pdf()
在版本 0.22.3 中添加。
- 属性 可见性¶
获取或设置工作表的可见性(布尔值)。
在版本0.21.1中添加。