Common Methods
Quick reference for the most frequently used methods. Click any interface name for full documentation.
| Method | Description |
|---|---|
| createWorkbook() | Create a new empty workbook |
| openWorkbook(path) | Open an existing XLSX file |
| save(wb, path) | Save workbook to XLSX |
| wb.getActiveSheet() | Get the currently active worksheet |
| wb.getSheetByName(name) | Get a sheet by name |
| wb.calculate() | Recalculate all formulas |
| wb.batch(fn) | Group operations into a single undo step |
| ws.setCell(ref, value) | Set a cell value or formula |
| ws.getValue(ref) | Read a cell's computed value |
| ws.setRange(ref, data) | Write a 2D array to a range |
| ws.getRange(ref) | Read a range as a 2D array |
| ws.tables.add({range, name}) | Create a structured table |
| ws.charts.add({type, range}) | Insert a chart from data |
| ws.pivots.add({source, dest}) | Create a pivot table |
Workbook
Workbook
65 methods
wb.sheets
10 methods
wb.slicers
8 methods
wb.slicerStyles
9 methods
wb.timelineStyles
9 methods
wb.pivotTableStyles
5 methods
wb.functions
8 methods
wb.names
16 methods
wb.scenarios
8 methods
wb.history
9 methods
wb.tableStyles
7 methods
wb.cellStyles
7 methods
wb.properties
6 methods
wb.protection
4 methods
wb.security
8 methods
wb.notifications
9 methods
wb.theme
4 methods
wb.viewport
5 methods
wb.changes
1 method
wb.links
11 methods
Worksheet
Worksheet
80 methods
ws.cells
1 method
ws.whatIf
3 methods
ws.smartArt
21 methods
ws.changes
1 method
ws.formats
24 methods
ws.layout
30 methods
ws.view
16 methods
ws.structure
14 methods
ws.charts
56 methods
ws.objects
16 methods
ws.shapes
4 methods
ws.pictures
3 methods
ws.textBoxes
3 methods
ws.drawings
3 methods
ws.equations
5 methods
ws.wordArt
5 methods
ws.connectors
2 methods
ws.filters
26 methods
ws.formControls
10 methods
ws.conditionalFormats
15 methods
ws.validations
13 methods
ws.tables
50 methods
ws.pivots
66 methods
ws.slicers
17 methods
ws.sparklines
20 methods
ws.comments
30 methods
ws.customProperties
5 methods
ws.hyperlinks
6 methods
ws.outline
14 methods
ws.protection
16 methods
ws.print
19 methods
ws.settings
5 methods
ws.bindings
10 methods
ws.names
9 methods
ws.styles
3 methods
Types
585 type definitions. View all types →