Module @sheetxl/sdk
SDK
A vectorized, columnar, scriptable, embeddable spreadsheet.
A high-performance, embeddable spreadsheet engine designed for building data-driven applications and integrating spreadsheet functionality into existing systems. It handles even extremely large and sparse datasets, while providing a powerful calculation engine and a flexible API. As part of the SheetXL eco system, it seamlessly integrates with ready-to-use UI components and data import/export tools.
Learn more about SheetXL.
| Feature | Excel API (JS/Python) | Google Sheets API | pandas | DuckDB | Jupyter Notebooks | NumPy | Sigma Computing | SheetXL 🚀 |
|---|---|---|---|---|---|---|---|---|
| Spreadsheet-Like? | ✅ Yes | ✅ Yes | ❌ No UI (table-based) | ❌ No UI | ❌ No real spreadsheet UI | ❌ No UI, array-based | ❌ No true spreadsheet UI | ✅ Yes (Excel-like UI) |
| Vectorized Operations? | ❌ Mostly scalar | ❌ Mostly scalar | ✅ Fully vectorized | ✅ Columnar, vectorized | ✅ Can use pandas/NumPy | ✅ Fully vectorized | ❌ SQL-based (not vectorized) | ✅ Fully vectorized, columnar |
| Embeddable? | ❌ Not easily embeddable | ✅ Web-based | ❌ Not embeddable | ✅ Can be embedded | ❌ Not embeddable | ❌ Not a spreadsheet | ✅ Cloud-based | ✅ Fully embeddable |
| Data Science Capabilities? | ⚠️ Limited (Python only) | ❌ No real data science | ✅ Strong data science | ✅ SQL-based analytics | ✅ Python data science | ✅ Scientific computing | ✅ BI analytics | ✅ Python & JS scripting |
Advantages
- The “Handoff Tax” → IT departments rewrite spreadsheets into web apps, but they lack true spreadsheet functionality. SheetXL removes this tax.
- Excel’s API is scalar → Most spreadsheet APIs are slow because they weren’t built for large-scale, vectorized calculations.
- BI tools don’t let you “program” the UI → Sigma, Looker, Tableau work for dashboards, but aren’t true programmable spreadsheets.
- NumPy is fast, but has no spreadsheet UI → SheetXL gives NumPy performance inside a familiar spreadsheet.
- Embeddability is a game-changer → Unlike Excel/Google Sheets, SheetXL is built for web apps, with seamless integration.
Namespaces
- AbstractMovableContent
- AutoFill
- Condition
- DateUtils
- FontUtils
- FormulaText
- FunctionDeclarations
- GeomUtils
- IAnchored
- IAutoFill
- IBorders
- IButton
- ICalculation
- ICaptioned
- ICell
- ICellContainerOptions
- ICellHeader
- ICellHeaderRange
- ICellHeaderRanges
- ICellProtection
- ICellRange
- ICellRanges
- IChart
- ICheckBox
- ICollection
- IColor
- IComment
- ICommentCollection
- ICondition
- IConditionalFormat
- IConditionalFormatCollection
- IDataValidation
- IDataValidationCollection
- IDropDown
- IEffect
- IEmbeddedPart
- IExternalBook
- IExternalBookCollection
- IFill
- IFilter
- IFont
- IFontCollection
- IFormControl
- IFunctionCollection
- IGeometry
- IGroup
- IGroupBox
- IHistory
- IHyperlink
- ILabel
- ILinked
- IListBox
- IListControl
- IListener
- IModule
- IModuleCollection
- IMovable
- IMovableCollection
- IMovableSelection
- INamed
- INamedCollection
- INamedFormulasCollection
- INamedStyleCollection
- IOptionButton
- IOutline
- IPerson
- IPicture
- IPivotTable
- IPrint
- IProperties
- IProtectedRange
- IProtectedRangeCollection
- IProtection
- IRangedControl
- IRangeSelection
- IResource
- IResourceCollection
- IRichText
- IScript
- IScrollBar
- IShape
- ISheet
- ISheetCollection
- ISheetHeader
- ISheetProtection
- ISheetView
- ISlicer
- ISort
- ISpinner
- IStringCollection
- IStroke
- IStyle
- IStyleCollection
- IStyledFont
- ITable
- ITableCollection
- ITableStyle
- ITableStyleCollection
- IText
- ITextBoxAlignment
- ITextFrame
- ITheme
- IThemeCollection
- ITransaction
- ITypes
- IWorkbook
- IWorkbookIO
- IWorkbookProtection
- IWorkbookView
- MovableContentRegistry
- NamedStyleCollection
- NumberFormat
- ScriptingApi
- ShapeStyleUtils
- Sort
- TableStyleCollection
- TextRotation
- TextStacked
- TextUtils
- TransactionSaveStateManager
- Tuple
Classes
- AbstractCollection
- AbstractMovableContent
- ArrayBackingStore
- Color
- Condition
- ExternalRangeClipboardItem
- NamedStyleCollection
- PersonCollection
- RangeClipboardItem
- Registry
- Resource
- ResourceCollection
- Sheet
- StringCollection
- StyleCollection
- Table
- TableStyleCollection
- Theme
- ThemeCollection
- TransactionConflictError
- TransactionSaveStateManager
- TransactionStore
- TransactionUndoManager
- Workbook
- WorkbookOrigin
- WorkbookView
Interfaces
- BuiltInStyleNameDisplay
- ExternalScopeParts
- FunctionHelpModule
- IAnchored
- IBorders
- IButton
- ICalculation
- ICaptioned
- ICell
- ICellContainerOptions
- ICellHeader
- ICellHeaderRange
- ICellHeaderRanges
- ICellProtection
- ICellRange
- ICellRanges
- ICellRegion
- ICellRegions
- IChart
- IChartCollection
- ICheckBox
- ICollection
- IColor
- IComment
- ICommentCollection
- ICondition
- IConditionalFormat
- IConditionalFormatCollection
- IDataValidation
- IDataValidationCollection
- IDropDown
- IEffect
- IEmbeddedPart
- IExternalBook
- IExternalBookCollection
- IFill
- IFilter
- IFormControl
- IFunctionCollection
- IGeometry
- IGroup
- IGroupBox
- IHyperlink
- ILabel
- ILinked
- IListBox
- IListControl
- IModule
- IModuleCollection
- IMovable
- IMovableCollection
- IMovableSelection
- INamed
- INamedCollection
- INamedFormulasCollection
- INamedRange
- INamedStyleCollection
- IOptionButton
- IOutline
- IPerson
- IPersonCollection
- IPicture
- IPivotTable
- IPivotTableCollection
- IProtectedRange
- IProtectedRangeCollection
- IProtection
- IRangedControl
- IRangeSelection
- IRegisterable
- IResource
- IResourceCollection
- IScript
- IScrollBar
- IShape
- ISheet
- ISheetCollection
- ISheetHeader
- ISheetProtection
- ISheetView
- ISort
- ISpinner
- IStringCollection
- IStroke
- IStyle
- IStyleCollection
- IStyledFont
- ITable
- ITableCollection
- ITableStyle
- ITableStyleCollection
- ITextBoxAlignment
- ITextFrame
- ITheme
- IThemeCollection
- ITransaction
- IWorkbook
- IWorkbookIO
- IWorkbookProtection
- IWorkbookView
- LanguagePack
- SRSpecifiers
- WorkbookOriginOptions
Functions
- builtInStyleNameDisplay
- externalBookClosedName
- externalBookFileName
- externalBookLocation
- externalBookOpenName
- getBuiltInFunctionNames
- getLanguagePack
- getLocaleProfile
- getScriptingApi
- getScriptingDeclarations
- getScriptRuntime
- localizeBoolean
- localizeErrorLabel
- makeLocaleProfile
- parseBooleanLocal
- parseErrorLocal
- parseExternalScope
- parseFormulaLiteral
- registerSdkLocales
- sourceEntryFromPath
- withScriptRuntime