IronCalc

Contents:

• Installation
• Usage Examples
  • The two APIs
  • A styled report
  • Conditional formatting
  • Reading an xlsx file
  • Importing CSV data
  • Collaboration with diffs
• Top Level Methods
  • Creating models (raw API)
  • Creating models (user API)
  • Utilities
• Raw API Reference
  • Evaluation and persistence
  • Setting values
  • Getting values
  • Styles
  • Rows and columns
  • Sheets
  • Defined names
  • Workbook properties
• User API Reference
  • Constructors
  • Persistence
  • Collaboration
  • Undo, redo and evaluation
  • Cell values
  • Ranges
  • Styles
  • Named styles
  • Conditional formatting
  • Sheets
  • Rows and columns
  • Defined names
  • Selection
  • Clipboard
  • Workbook properties
• Objects
  • WorkbookError
  • CellType
  • Style dictionaries
  • Colors
  • Conditional formatting rules

IronCalc is a spreadsheet engine that allows you to create, modify and save spreadsheets.

A simple example that creates a model, sets a formula, evaluates it and gets the result back:

import ironcalc as ic

# The user API: evaluates automatically after every change
model = ic.UserModel("model")
model.set_user_input(0, 1, 1, "=21*2")
assert model.get_formatted_cell_value(0, 1, 1) == "42"

# The raw API: you must evaluate yourself
raw = ic.create("model")
raw.set_user_input(0, 1, 1, "=21*2")
raw.evaluate()
assert raw.get_formatted_cell_value(0, 1, 1) == "42"