API Reference

Top-level functions

• Top-level functions
  • load()
  • view()

UDF decorators

• UDF decorators
  • xlwings.func()
  • xlwings.sub()
  • xlwings.arg()
  • xlwings.ret()

xlwings Object Model

• App
  • App
    • App.activate()
    • App.alert()
    • App.api
    • App.books
    • App.calculate()
    • App.calculation
    • App.cut_copy_mode
    • App.display_alerts
    • App.enable_events
    • App.hwnd
    • App.interactive
    • App.kill()
    • App.macro()
    • App.path
    • App.pid
    • App.properties()
    • App.quit()
    • App.range()
    • App.render_template()
    • App.screen_updating
    • App.selection
    • App.startup_path
    • App.status_bar
    • App.version
    • App.visible
• Apps
  • Apps
    • Apps.active
    • Apps.add()
    • Apps.cleanup()
    • Apps.count
    • Apps.keys()
• Book
  • Book
    • Book.activate()
    • Book.api
    • Book.app
    • Book.caller()
    • Book.close()
    • Book.fullname
    • Book.json()
    • Book.macro()
    • Book.name
    • Book.names
    • Book.render_template()
    • Book.save()
    • Book.selection
    • Book.set_mock_caller()
    • Book.sheet_names
    • Book.sheets
    • Book.to_pdf()
• Books
  • Books
    • Books.active
    • Books.add()
    • Books.open()
• Characters
  • Characters
    • Characters.api
    • Characters.font
    • Characters.text
• Chart
  • Chart
    • Chart.api
    • Chart.chart_type
    • Chart.delete()
    • Chart.height
    • Chart.left
    • Chart.name
    • Chart.parent
    • Chart.set_source_data()
    • Chart.to_pdf()
    • Chart.to_png()
    • Chart.top
    • Chart.width
• Charts
  • Charts
    • Charts.add()
    • Charts.api
    • Charts.count
• Font
  • Font
    • Font.api
    • Font.bold
    • Font.color
    • Font.italic
    • Font.name
    • Font.size
• Name
  • Name
    • Name.api
    • Name.delete()
    • Name.name
    • Name.refers_to
    • Name.refers_to_range
• Names
  • Names
    • Names.add()
    • Names.api
    • Names.count
• Note
  • Note
    • Note.api
    • Note.delete()
    • Note.text
• PageSetup
  • PageSetup
    • PageSetup.api
    • PageSetup.print_area
• Picture
  • Picture
    • Picture.api
    • Picture.delete()
    • Picture.height
    • Picture.left
    • Picture.lock_aspect_ratio
    • Picture.name
    • Picture.parent
    • Picture.top
    • Picture.update()
    • Picture.width
• Pictures
  • Pictures
    • Pictures.add()
    • Pictures.api
    • Pictures.count
• Range
  • Range
    • Range.add_hyperlink()
    • Range.address
    • Range.api
    • Range.autofill()
    • Range.autofit()
    • Range.clear()
    • Range.clear_contents()
    • Range.clear_formats()
    • Range.color
    • Range.column
    • Range.column_width
    • Range.columns
    • Range.copy()
    • Range.copy_picture()
    • Range.count
    • Range.current_region
    • Range.delete()
    • Range.end()
    • Range.expand()
    • Range.formula
    • Range.formula2
    • Range.formula_array
    • Range.get_address()
    • Range.has_array
    • Range.height
    • Range.hyperlink
    • Range.insert()
    • Range.last_cell
    • Range.left
    • Range.merge()
    • Range.merge_area
    • Range.merge_cells
    • Range.name
    • Range.note
    • Range.number_format
    • Range.offset()
    • Range.options()
    • Range.paste()
    • Range.raw_value
    • Range.resize()
    • Range.row
    • Range.row_height
    • Range.rows
    • Range.select()
    • Range.shape
    • Range.sheet
    • Range.size
    • Range.table
    • Range.to_pdf()
    • Range.to_png()
    • Range.top
    • Range.unmerge()
    • Range.value
    • Range.width
    • Range.wrap_text
• RangeColumns
  • RangeColumns
    • RangeColumns.autofit()
    • RangeColumns.count
• RangeRows
  • RangeRows
    • RangeRows.autofit()
    • RangeRows.count
• Reports
  • Image
  • Markdown
  • MarkdownStyle
  • formatter()
  • render_template()
• Shape
  • Shape
    • Shape.activate()
    • Shape.api
    • Shape.delete()
    • Shape.height
    • Shape.left
    • Shape.name
    • Shape.parent
    • Shape.scale_height()
    • Shape.scale_width()
    • Shape.text
    • Shape.top
    • Shape.type
    • Shape.width
• Shapes
  • Shapes
    • Shapes.api
    • Shapes.count
• Sheet
  • Sheet
    • Sheet.activate()
    • Sheet.api
    • Sheet.autofit()
    • Sheet.book
    • Sheet.cells
    • Sheet.charts
    • Sheet.clear()
    • Sheet.clear_contents()
    • Sheet.clear_formats()
    • Sheet.copy()
    • Sheet.delete()
    • Sheet.index
    • Sheet.name
    • Sheet.names
    • Sheet.page_setup
    • Sheet.pictures
    • Sheet.range()
    • Sheet.render_template()
    • Sheet.select()
    • Sheet.shapes
    • Sheet.tables
    • Sheet.to_html()
    • Sheet.to_pdf()
    • Sheet.used_range
    • Sheet.visible
• Sheets
  • Sheets
    • Sheets.active
    • Sheets.add()
• Table
  • Table
    • Table.api
    • Table.data_body_range
    • Table.display_name
    • Table.header_row_range
    • Table.insert_row_range
    • Table.name
    • Table.parent
    • Table.range
    • Table.resize()
    • Table.show_autofilter
    • Table.show_headers
    • Table.show_table_style_column_stripes
    • Table.show_table_style_first_column
    • Table.show_table_style_last_column
    • Table.show_table_style_row_stripes
    • Table.show_totals
    • Table.table_style
    • Table.totals_row_range
    • Table.update()
• Tables
  • Tables
    • Tables.add()