Document

class ixion.Document

Class Document represents an entire document which consists of one or more Sheet objects.

Document.sheet_names

A read-only attribute that provides a tuple of the names of the sheets that belong to the document. The order of the sheet names signifies the order of the sheets in the document.

Document.append_sheet(sheet_name)

Append a new sheet to the document object and return the newly created Sheet object. The sheet name will become the name of the sheet object being appended. Each Sheet object must have a name, and the name must be unique within the document.

Parameters:sheet_name (str) – name of the sheet to be appended to the document. Return type:ixion.Sheet Returns:appended sheet object.

Document.get_sheet(arg)

Get a sheet object either by the position or by the name. When the arg is an integer, it returns the sheet object at specified position (0-based). When the arg is a string, it returns the sheet object whose name matches the specified string.

Parameters:arg – either the name of a sheet if it’s of type str, or the index of a sheet if it’s of type int. Return type:ixion.Sheet Returns:sheet object representing the specified sheet.

Warning

Prefer passing a sheet index to get_sheet() than passing a sheet name. When passing a sheet name as an argument, the current get_sheet() implementation has to iterate through the sheet objects in the document to find a matching one.

Document.calculate([threads])

Calculate all formula cells within the document that are marked “dirty” i.e. either those formula cells whose direct or indirect references have changed their values, or those formula cells that have been entered into the document.

Parameters:threads (int) – (optional) number of threads to use for the calculation besides the main thread. Set this to 0 if you want the calculation to be performed on the main thread only. The value of 0 is assumed if this value is not specified.