# API Reference

# Top-level functions

* [Top-level functions](top_level_functions.md)
  * [`load()`](top_level_functions.md#xlwings.load)
  * [`view()`](top_level_functions.md#xlwings.view)

# UDF decorators

* [UDF decorators](udf_decorators.md)
  * [`xlwings.func()`](udf_decorators.md#xlwings.func)
  * [`xlwings.script()`](udf_decorators.md#xlwings.script)
  * [`xlwings.arg()`](udf_decorators.md#xlwings.arg)
  * [`xlwings.ret()`](udf_decorators.md#xlwings.ret)

# xlwings Object Model

* [App](app.md)
  * [`App`](app.md#xlwings.App)
    * [`App.activate()`](app.md#xlwings.App.activate)
    * [`App.alert()`](app.md#xlwings.App.alert)
    * [`App.api`](app.md#xlwings.App.api)
    * [`App.books`](app.md#xlwings.App.books)
    * [`App.calculate()`](app.md#xlwings.App.calculate)
    * [`App.calculation`](app.md#xlwings.App.calculation)
    * [`App.cut_copy_mode`](app.md#xlwings.App.cut_copy_mode)
    * [`App.display_alerts`](app.md#xlwings.App.display_alerts)
    * [`App.enable_events`](app.md#xlwings.App.enable_events)
    * [`App.get_selection()`](app.md#xlwings.App.get_selection)
    * [`App.hwnd`](app.md#xlwings.App.hwnd)
    * [`App.interactive`](app.md#xlwings.App.interactive)
    * [`App.kill()`](app.md#xlwings.App.kill)
    * [`App.macro()`](app.md#xlwings.App.macro)
    * [`App.path`](app.md#xlwings.App.path)
    * [`App.pid`](app.md#xlwings.App.pid)
    * [`App.properties()`](app.md#xlwings.App.properties)
    * [`App.quit()`](app.md#xlwings.App.quit)
    * [`App.range()`](app.md#xlwings.App.range)
    * [`App.render_template()`](app.md#xlwings.App.render_template)
    * [`App.screen_updating`](app.md#xlwings.App.screen_updating)
    * [`App.selection`](app.md#xlwings.App.selection)
    * [`App.startup_path`](app.md#xlwings.App.startup_path)
    * [`App.status_bar`](app.md#xlwings.App.status_bar)
    * [`App.version`](app.md#xlwings.App.version)
    * [`App.visible`](app.md#xlwings.App.visible)
* [Apps](apps.md)
  * [`Apps`](apps.md#xlwings.main.Apps)
    * [`Apps.active`](apps.md#xlwings.main.Apps.active)
    * [`Apps.add()`](apps.md#xlwings.main.Apps.add)
    * [`Apps.cleanup()`](apps.md#xlwings.main.Apps.cleanup)
    * [`Apps.count`](apps.md#xlwings.main.Apps.count)
    * [`Apps.keys()`](apps.md#xlwings.main.Apps.keys)
* [Book](book.md)
  * [`Book`](book.md#xlwings.Book)
    * [`Book.activate()`](book.md#xlwings.Book.activate)
    * [`Book.api`](book.md#xlwings.Book.api)
    * [`Book.app`](book.md#xlwings.Book.app)
    * [`Book.caller()`](book.md#xlwings.Book.caller)
    * [`Book.close()`](book.md#xlwings.Book.close)
    * [`Book.flush()`](book.md#xlwings.Book.flush)
    * [`Book.fullname`](book.md#xlwings.Book.fullname)
    * [`Book.get_selection()`](book.md#xlwings.Book.get_selection)
    * [`Book.json()`](book.md#xlwings.Book.json)
    * [`Book.load()`](book.md#xlwings.Book.load)
    * [`Book.macro()`](book.md#xlwings.Book.macro)
    * [`Book.name`](book.md#xlwings.Book.name)
    * [`Book.names`](book.md#xlwings.Book.names)
    * [`Book.render_template()`](book.md#xlwings.Book.render_template)
    * [`Book.save()`](book.md#xlwings.Book.save)
    * [`Book.selection`](book.md#xlwings.Book.selection)
    * [`Book.set_mock_caller()`](book.md#xlwings.Book.set_mock_caller)
    * [`Book.sheet_names`](book.md#xlwings.Book.sheet_names)
    * [`Book.sheets`](book.md#xlwings.Book.sheets)
    * [`Book.sync()`](book.md#xlwings.Book.sync)
    * [`Book.to_pdf()`](book.md#xlwings.Book.to_pdf)
* [BookAsync](book_async.md)
  * [`BookAsync`](book_async.md#xlwings.BookAsync)
* [Books](books.md)
  * [`Books`](books.md#xlwings.main.Books)
    * [`Books.active`](books.md#xlwings.main.Books.active)
    * [`Books.add()`](books.md#xlwings.main.Books.add)
    * [`Books.get_active()`](books.md#xlwings.main.Books.get_active)
    * [`Books.open()`](books.md#xlwings.main.Books.open)
* [Characters](characters.md)
  * [`Characters`](characters.md#xlwings.main.Characters)
    * [`Characters.api`](characters.md#xlwings.main.Characters.api)
    * [`Characters.font`](characters.md#xlwings.main.Characters.font)
    * [`Characters.get_text()`](characters.md#xlwings.main.Characters.get_text)
    * [`Characters.text`](characters.md#xlwings.main.Characters.text)
* [Chart](chart.md)
  * [`Chart`](chart.md#xlwings.Chart)
    * [`Chart.api`](chart.md#xlwings.Chart.api)
    * [`Chart.chart_type`](chart.md#xlwings.Chart.chart_type)
    * [`Chart.delete()`](chart.md#xlwings.Chart.delete)
    * [`Chart.get_png()`](chart.md#xlwings.Chart.get_png)
    * [`Chart.height`](chart.md#xlwings.Chart.height)
    * [`Chart.left`](chart.md#xlwings.Chart.left)
    * [`Chart.name`](chart.md#xlwings.Chart.name)
    * [`Chart.parent`](chart.md#xlwings.Chart.parent)
    * [`Chart.set_source_data()`](chart.md#xlwings.Chart.set_source_data)
    * [`Chart.to_pdf()`](chart.md#xlwings.Chart.to_pdf)
    * [`Chart.to_png()`](chart.md#xlwings.Chart.to_png)
    * [`Chart.top`](chart.md#xlwings.Chart.top)
    * [`Chart.width`](chart.md#xlwings.Chart.width)
* [Charts](charts.md)
  * [`Charts`](charts.md#xlwings.main.Charts)
    * [`Charts.add()`](charts.md#xlwings.main.Charts.add)
* [Font](font.md)
  * [`Font`](font.md#xlwings.main.Font)
    * [`Font.api`](font.md#xlwings.main.Font.api)
    * [`Font.bold`](font.md#xlwings.main.Font.bold)
    * [`Font.color`](font.md#xlwings.main.Font.color)
    * [`Font.get_bold()`](font.md#xlwings.main.Font.get_bold)
    * [`Font.get_color()`](font.md#xlwings.main.Font.get_color)
    * [`Font.get_italic()`](font.md#xlwings.main.Font.get_italic)
    * [`Font.get_name()`](font.md#xlwings.main.Font.get_name)
    * [`Font.get_size()`](font.md#xlwings.main.Font.get_size)
    * [`Font.italic`](font.md#xlwings.main.Font.italic)
    * [`Font.name`](font.md#xlwings.main.Font.name)
    * [`Font.size`](font.md#xlwings.main.Font.size)
* [Name](name.md)
  * [`Name`](name.md#xlwings.Name)
    * [`Name.api`](name.md#xlwings.Name.api)
    * [`Name.delete()`](name.md#xlwings.Name.delete)
    * [`Name.name`](name.md#xlwings.Name.name)
    * [`Name.refers_to`](name.md#xlwings.Name.refers_to)
    * [`Name.refers_to_range`](name.md#xlwings.Name.refers_to_range)
* [Names](names.md)
  * [`Names`](names.md#xlwings.main.Names)
    * [`Names.add()`](names.md#xlwings.main.Names.add)
    * [`Names.api`](names.md#xlwings.main.Names.api)
    * [`Names.count`](names.md#xlwings.main.Names.count)
* [Note](note.md)
  * [`Note`](note.md#xlwings.main.Note)
    * [`Note.api`](note.md#xlwings.main.Note.api)
    * [`Note.delete()`](note.md#xlwings.main.Note.delete)
    * [`Note.get_text()`](note.md#xlwings.main.Note.get_text)
    * [`Note.text`](note.md#xlwings.main.Note.text)
* [PageSetup](page_setup.md)
  * [`PageSetup`](page_setup.md#xlwings.main.PageSetup)
    * [`PageSetup.api`](page_setup.md#xlwings.main.PageSetup.api)
    * [`PageSetup.print_area`](page_setup.md#xlwings.main.PageSetup.print_area)
* [Picture](picture.md)
  * [`Picture`](picture.md#xlwings.Picture)
    * [`Picture.api`](picture.md#xlwings.Picture.api)
    * [`Picture.delete()`](picture.md#xlwings.Picture.delete)
    * [`Picture.height`](picture.md#xlwings.Picture.height)
    * [`Picture.left`](picture.md#xlwings.Picture.left)
    * [`Picture.lock_aspect_ratio`](picture.md#xlwings.Picture.lock_aspect_ratio)
    * [`Picture.name`](picture.md#xlwings.Picture.name)
    * [`Picture.parent`](picture.md#xlwings.Picture.parent)
    * [`Picture.top`](picture.md#xlwings.Picture.top)
    * [`Picture.update()`](picture.md#xlwings.Picture.update)
    * [`Picture.width`](picture.md#xlwings.Picture.width)
* [Pictures](pictures.md)
  * [`Pictures`](pictures.md#xlwings.main.Pictures)
    * [`Pictures.add()`](pictures.md#xlwings.main.Pictures.add)
* [Range](range.md)
  * [`Range`](range.md#xlwings.Range)
    * [`Range.add_hyperlink()`](range.md#xlwings.Range.add_hyperlink)
    * [`Range.address`](range.md#xlwings.Range.address)
    * [`Range.adjust_indent()`](range.md#xlwings.Range.adjust_indent)
    * [`Range.api`](range.md#xlwings.Range.api)
    * [`Range.autofill()`](range.md#xlwings.Range.autofill)
    * [`Range.autofit()`](range.md#xlwings.Range.autofit)
    * [`Range.clear()`](range.md#xlwings.Range.clear)
    * [`Range.clear_contents()`](range.md#xlwings.Range.clear_contents)
    * [`Range.clear_formats()`](range.md#xlwings.Range.clear_formats)
    * [`Range.color`](range.md#xlwings.Range.color)
    * [`Range.column`](range.md#xlwings.Range.column)
    * [`Range.column_width`](range.md#xlwings.Range.column_width)
    * [`Range.columns`](range.md#xlwings.Range.columns)
    * [`Range.copy()`](range.md#xlwings.Range.copy)
    * [`Range.copy_from()`](range.md#xlwings.Range.copy_from)
    * [`Range.copy_picture()`](range.md#xlwings.Range.copy_picture)
    * [`Range.count`](range.md#xlwings.Range.count)
    * [`Range.current_region`](range.md#xlwings.Range.current_region)
    * [`Range.delete()`](range.md#xlwings.Range.delete)
    * [`Range.end()`](range.md#xlwings.Range.end)
    * [`Range.expand()`](range.md#xlwings.Range.expand)
    * [`Range.formula`](range.md#xlwings.Range.formula)
    * [`Range.formula2`](range.md#xlwings.Range.formula2)
    * [`Range.formula_array`](range.md#xlwings.Range.formula_array)
    * [`Range.get_address()`](range.md#xlwings.Range.get_address)
    * [`Range.get_color()`](range.md#xlwings.Range.get_color)
    * [`Range.get_column_width()`](range.md#xlwings.Range.get_column_width)
    * [`Range.get_current_region()`](range.md#xlwings.Range.get_current_region)
    * [`Range.get_formula()`](range.md#xlwings.Range.get_formula)
    * [`Range.get_formula_array()`](range.md#xlwings.Range.get_formula_array)
    * [`Range.get_height()`](range.md#xlwings.Range.get_height)
    * [`Range.get_hyperlink()`](range.md#xlwings.Range.get_hyperlink)
    * [`Range.get_left()`](range.md#xlwings.Range.get_left)
    * [`Range.get_merge_area()`](range.md#xlwings.Range.get_merge_area)
    * [`Range.get_merge_cells()`](range.md#xlwings.Range.get_merge_cells)
    * [`Range.get_number_format()`](range.md#xlwings.Range.get_number_format)
    * [`Range.get_row_height()`](range.md#xlwings.Range.get_row_height)
    * [`Range.get_table()`](range.md#xlwings.Range.get_table)
    * [`Range.get_top()`](range.md#xlwings.Range.get_top)
    * [`Range.get_value()`](range.md#xlwings.Range.get_value)
    * [`Range.get_width()`](range.md#xlwings.Range.get_width)
    * [`Range.get_wrap_text()`](range.md#xlwings.Range.get_wrap_text)
    * [`Range.group()`](range.md#xlwings.Range.group)
    * [`Range.has_array`](range.md#xlwings.Range.has_array)
    * [`Range.height`](range.md#xlwings.Range.height)
    * [`Range.hyperlink`](range.md#xlwings.Range.hyperlink)
    * [`Range.insert()`](range.md#xlwings.Range.insert)
    * [`Range.last_cell`](range.md#xlwings.Range.last_cell)
    * [`Range.left`](range.md#xlwings.Range.left)
    * [`Range.merge()`](range.md#xlwings.Range.merge)
    * [`Range.merge_area`](range.md#xlwings.Range.merge_area)
    * [`Range.merge_cells`](range.md#xlwings.Range.merge_cells)
    * [`Range.name`](range.md#xlwings.Range.name)
    * [`Range.note`](range.md#xlwings.Range.note)
    * [`Range.number_format`](range.md#xlwings.Range.number_format)
    * [`Range.offset()`](range.md#xlwings.Range.offset)
    * [`Range.options()`](range.md#xlwings.Range.options)
    * [`Range.paste()`](range.md#xlwings.Range.paste)
    * [`Range.raw_value`](range.md#xlwings.Range.raw_value)
    * [`Range.resize()`](range.md#xlwings.Range.resize)
    * [`Range.row`](range.md#xlwings.Range.row)
    * [`Range.row_height`](range.md#xlwings.Range.row_height)
    * [`Range.rows`](range.md#xlwings.Range.rows)
    * [`Range.select()`](range.md#xlwings.Range.select)
    * [`Range.shape`](range.md#xlwings.Range.shape)
    * [`Range.sheet`](range.md#xlwings.Range.sheet)
    * [`Range.size`](range.md#xlwings.Range.size)
    * [`Range.table`](range.md#xlwings.Range.table)
    * [`Range.to_pdf()`](range.md#xlwings.Range.to_pdf)
    * [`Range.to_png()`](range.md#xlwings.Range.to_png)
    * [`Range.top`](range.md#xlwings.Range.top)
    * [`Range.ungroup()`](range.md#xlwings.Range.ungroup)
    * [`Range.unmerge()`](range.md#xlwings.Range.unmerge)
    * [`Range.value`](range.md#xlwings.Range.value)
    * [`Range.width`](range.md#xlwings.Range.width)
    * [`Range.wrap_text`](range.md#xlwings.Range.wrap_text)
* [RangeColumns](range_columns.md)
  * [`RangeColumns`](range_columns.md#xlwings.RangeColumns)
    * [`RangeColumns.autofit()`](range_columns.md#xlwings.RangeColumns.autofit)
    * [`RangeColumns.count`](range_columns.md#xlwings.RangeColumns.count)
* [RangeRows](range_rows.md)
  * [`RangeRows`](range_rows.md#xlwings.RangeRows)
    * [`RangeRows.autofit()`](range_rows.md#xlwings.RangeRows.autofit)
    * [`RangeRows.count`](range_rows.md#xlwings.RangeRows.count)
* [Reports](reports.md)
  * [`Image`](reports.md#xlwings.reports.Image)
  * [`Markdown`](reports.md#xlwings.reports.Markdown)
  * [`MarkdownStyle`](reports.md#xlwings.reports.MarkdownStyle)
  * [`formatter()`](reports.md#xlwings.reports.formatter)
  * [`render_template()`](reports.md#xlwings.reports.render_template)
* [Shape](shape.md)
  * [`Shape`](shape.md#xlwings.Shape)
    * [`Shape.activate()`](shape.md#xlwings.Shape.activate)
    * [`Shape.api`](shape.md#xlwings.Shape.api)
    * [`Shape.delete()`](shape.md#xlwings.Shape.delete)
    * [`Shape.get_text()`](shape.md#xlwings.Shape.get_text)
    * [`Shape.height`](shape.md#xlwings.Shape.height)
    * [`Shape.left`](shape.md#xlwings.Shape.left)
    * [`Shape.name`](shape.md#xlwings.Shape.name)
    * [`Shape.parent`](shape.md#xlwings.Shape.parent)
    * [`Shape.scale_height()`](shape.md#xlwings.Shape.scale_height)
    * [`Shape.scale_width()`](shape.md#xlwings.Shape.scale_width)
    * [`Shape.text`](shape.md#xlwings.Shape.text)
    * [`Shape.top`](shape.md#xlwings.Shape.top)
    * [`Shape.type`](shape.md#xlwings.Shape.type)
    * [`Shape.width`](shape.md#xlwings.Shape.width)
* [Shapes](shapes.md)
  * [`Shapes`](shapes.md#xlwings.main.Shapes)
* [Sheet](sheet.md)
  * [`Sheet`](sheet.md#xlwings.Sheet)
    * [`Sheet.activate()`](sheet.md#xlwings.Sheet.activate)
    * [`Sheet.api`](sheet.md#xlwings.Sheet.api)
    * [`Sheet.autofit()`](sheet.md#xlwings.Sheet.autofit)
    * [`Sheet.book`](sheet.md#xlwings.Sheet.book)
    * [`Sheet.cells`](sheet.md#xlwings.Sheet.cells)
    * [`Sheet.charts`](sheet.md#xlwings.Sheet.charts)
    * [`Sheet.clear()`](sheet.md#xlwings.Sheet.clear)
    * [`Sheet.clear_contents()`](sheet.md#xlwings.Sheet.clear_contents)
    * [`Sheet.clear_formats()`](sheet.md#xlwings.Sheet.clear_formats)
    * [`Sheet.copy()`](sheet.md#xlwings.Sheet.copy)
    * [`Sheet.delete()`](sheet.md#xlwings.Sheet.delete)
    * [`Sheet.freeze_panes`](sheet.md#xlwings.Sheet.freeze_panes)
    * [`Sheet.index`](sheet.md#xlwings.Sheet.index)
    * [`Sheet.load()`](sheet.md#xlwings.Sheet.load)
    * [`Sheet.name`](sheet.md#xlwings.Sheet.name)
    * [`Sheet.names`](sheet.md#xlwings.Sheet.names)
    * [`Sheet.page_setup`](sheet.md#xlwings.Sheet.page_setup)
    * [`Sheet.pictures`](sheet.md#xlwings.Sheet.pictures)
    * [`Sheet.range()`](sheet.md#xlwings.Sheet.range)
    * [`Sheet.render_template()`](sheet.md#xlwings.Sheet.render_template)
    * [`Sheet.select()`](sheet.md#xlwings.Sheet.select)
    * [`Sheet.shapes`](sheet.md#xlwings.Sheet.shapes)
    * [`Sheet.tables`](sheet.md#xlwings.Sheet.tables)
    * [`Sheet.to_html()`](sheet.md#xlwings.Sheet.to_html)
    * [`Sheet.to_pdf()`](sheet.md#xlwings.Sheet.to_pdf)
    * [`Sheet.used_range`](sheet.md#xlwings.Sheet.used_range)
    * [`Sheet.visible`](sheet.md#xlwings.Sheet.visible)
* [Sheets](sheets.md)
  * [`Sheets`](sheets.md#xlwings.main.Sheets)
    * [`Sheets.active`](sheets.md#xlwings.main.Sheets.active)
    * [`Sheets.add()`](sheets.md#xlwings.main.Sheets.add)
    * [`Sheets.get_active()`](sheets.md#xlwings.main.Sheets.get_active)
* [Table](table.md)
  * [`Table`](table.md#xlwings.main.Table)
    * [`Table.api`](table.md#xlwings.main.Table.api)
    * [`Table.data_body_range`](table.md#xlwings.main.Table.data_body_range)
    * [`Table.display_name`](table.md#xlwings.main.Table.display_name)
    * [`Table.header_row_range`](table.md#xlwings.main.Table.header_row_range)
    * [`Table.insert_row_range`](table.md#xlwings.main.Table.insert_row_range)
    * [`Table.name`](table.md#xlwings.main.Table.name)
    * [`Table.parent`](table.md#xlwings.main.Table.parent)
    * [`Table.range`](table.md#xlwings.main.Table.range)
    * [`Table.resize()`](table.md#xlwings.main.Table.resize)
    * [`Table.show_autofilter`](table.md#xlwings.main.Table.show_autofilter)
    * [`Table.show_headers`](table.md#xlwings.main.Table.show_headers)
    * [`Table.show_table_style_column_stripes`](table.md#xlwings.main.Table.show_table_style_column_stripes)
    * [`Table.show_table_style_first_column`](table.md#xlwings.main.Table.show_table_style_first_column)
    * [`Table.show_table_style_last_column`](table.md#xlwings.main.Table.show_table_style_last_column)
    * [`Table.show_table_style_row_stripes`](table.md#xlwings.main.Table.show_table_style_row_stripes)
    * [`Table.show_totals`](table.md#xlwings.main.Table.show_totals)
    * [`Table.table_style`](table.md#xlwings.main.Table.table_style)
    * [`Table.totals_row_range`](table.md#xlwings.main.Table.totals_row_range)
    * [`Table.update()`](table.md#xlwings.main.Table.update)
* [Tables](tables.md)
  * [`Tables`](tables.md#xlwings.main.Tables)
    * [`Tables.add()`](tables.md#xlwings.main.Tables.add)