api.rst

API Documentation

The xlwings object model is very similar to the one used by Excel VBA but the hierarchy is flattened. An example:

VBA:

Workbooks("Book1").Sheets("Sheet1").Range("A1").Value = "Some Text"

xlwings:

wb = Workbook("Book1")

Range("Sheet1", "A1").value = "Some Text"

.. module:: xlwings

Application

.. autoclass:: Application
    :members:

Workbook

In order to use xlwings, instantiating a workbook object is always the first thing to do:

.. autoclass:: Workbook
    :members:

Sheet

Sheet objects allow you to interact with anything directly related to a Sheet. However, to specify the Sheet in a Range or Chart object, do it as follows: Range('Sheet1', 'A1').value.

.. autoclass:: Sheet
    :members:

Range

The xlwings Range object represents a block of contiguous cells in Excel.

.. autoclass:: Range
    :members:

Chart

Note

The chart object is currently still lacking a lot of important methods/attributes.

.. autoclass:: Chart
    :members: