pyopenxlsx documentation

pyopenxlsx is a high-performance Python binding for the OpenXLSX-NX C++ library.

API Documentation

• Workbook API
  • Creating and Loading
  • Properties
  • Methods
  • Advanced Example: Modifying Document Metadata
• Worksheet API
  • Properties
  • Data Access & Modification Methods
  • Formatting & View Methods
  • Hyperlinks & Comments
  • Ranges & Merging
  • Tables & Shapes
  • Advanced I/O
  • Documented in Other Modules
  • Advanced Example: Data Parsing and High-Speed Bulk Write
• Cell, Range, and Column API
  • Cell
  • Range
  • Column
  • Advanced Example: Formulas and Merging
• Styles API
  • Components
  • Applying Styles
  • Advanced Properties & Getters/Setters
  • Advanced Example: Complex Financial Styling
• Data Validation API
  • Core Concepts
  • Enums
  • Properties and Methods of DataValidation
  • DataValidations Collection
  • Advanced Example: Dependent Dropdowns (Cascading Validation)
• Tables (ListObjects) API
  • Creating a Table
  • Table Properties
  • Table Columns
  • Totals Row
  • Table Slicers
  • Advanced Table Properties
• Pivot Tables API
  • Code Example
  • XLPivotTableOptions Fluent Methods
  • XLSlicerOptions Configuration
• Rich Text & Comments API
  • Rich Text
  • Comments
• Async Operations API
  • Async Context Managers
  • Available Async Methods
• Conditional Formatting API
  • Adding a Rule
  • Supported Rule Types
  • Managing Rules
• Streams API (High Performance I/O)
  • Stream Writer
  • Use Cases
• Charts API
  • Adding a Chart
  • Supported Chart Types (XLChartType)
• Page Setup & Printing API
  • Example Configuration
• Images and Shapes API
  • Inserting an Image
  • Extracting Images
  • Advanced Binary Data Access
  • Inserting Vector Shapes
• Formula Engine API
  • FormulaEngine
• Comments API
  • Adding Legacy Comments
  • Threaded Comments
• Encryption and Protection API
  • Workbook Encryption (Password Protection)
  • Worksheet Protection
• Pandas Integration API
  • Exporting a DataFrame (Writing to Excel)
  • Importing to a DataFrame (Reading from Excel)
  • Async Pandas Operations

API Reference

• API Reference
  • Alignment
  • Border
  • Cell
  • Column
  • DataValidation
  • DataValidations
  • Fill
  • Font
  • Formula
  • FormulaEngine
  • ImageInfo
  • PageMargins
  • PageSetup
  • PrintOptions
  • Protection
  • PythonMergeCells
  • Range
  • Side
  • Style
  • Table
  • Workbook
  • Worksheet
  • XLAlignment
  • XLAlignmentStyle
  • XLAppProperties
  • XLBorder
  • XLBorders
  • XLCellFormat
  • XLCellFormats
  • XLCellRange
  • XLCellReference
  • XLColor
  • XLComment
  • XLComments
  • XLContentItem
  • XLContentType
  • XLContentTypes
  • XLDataValidationErrorStyle
  • XLDataValidationOperator
  • XLDataValidationType
  • XLDateTime
  • XLDefinedName
  • XLDefinedNames
  • XLDocument
  • XLDrawing
  • XLFill
  • XLFillType
  • XLFills
  • XLFont
  • XLFontSchemeStyle
  • XLFonts
  • XLIMEMode
  • XLLineStyle
  • XLMergeCells
  • XLNumberFormat
  • XLNumberFormats
  • XLPageOrientation
  • XLPane
  • XLPaneState
  • XLPatternType
  • XLProperties
  • XLProperty
  • XLRichText
  • XLRichTextRun
  • XLShape
  • XLShapeClientData
  • XLShapeStyle
  • XLSheetState
  • XLStreamReader
  • XLStreamWriter
  • XLStyles
  • XLUnderlineStyle
  • XLVerticalAlignRunStyle
  • XLWorkbook
  • is_date_format()
  • load_workbook()
  • load_workbook_async()