SheetXL - v0.3.20
    Preparing search index...

    Module @sheetxl/sdk

    SDK

    SheetXL

    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
    1. The β€œHandoff Tax” β†’ IT departments rewrite spreadsheets into web apps, but they lack true spreadsheet functionality. SheetXL removes this tax.
    2. Excel’s API is scalar β†’ Most spreadsheet APIs are slow because they weren’t built for large-scale, vectorized calculations.
    3. BI tools don’t let you β€œprogram” the UI β†’ Sigma, Looker, Tableau work for dashboards, but aren’t true programmable spreadsheets.
    4. NumPy is fast, but has no spreadsheet UI β†’ SheetXL gives NumPy performance inside a familiar spreadsheet.
    5. Embeddability is a game-changer β†’ Unlike Excel/Google Sheets, SheetXL is built for web apps, with seamless integration.

    Namespaces

    AutoFill
    BufferUtils
    Calculation
    CommonMessages
    CommonUtils
    CoordUtils
    FormulaError
    GeomUtils
    IAnchored
    IAutoFill
    IAutoFilter
    IAutoSort
    IBorder
    ICalculation
    ICell
    ICellHeader
    ICellHeaderRange
    ICellProtection
    ICellRange
    ICellRanges
    IChart
    ICollection
    IColor
    IComment
    IConditionalFormat
    IConditionalFormatCollection
    IFill
    IFont
    IFontCollection
    IFunction
    IFunctionCollection
    IHistory
    IListener
    ImageUtils
    IModule
    IMovable
    IMovableCollection
    IMovableSelection
    INamed
    INamedCollection
    InternalClipboard
    IPicture
    IPrint
    IProperties
    IProtection
    IRange
    IRangeSelection
    IResource
    IResourceCollection
    IRichData
    IScript
    ISheet
    ISheetCollection
    ISheetHeader
    ISheetProtection
    ISheetView
    ISort
    IStringCollection
    IStyle
    IStyleCollection
    IStyledFont
    ITable
    ITableCollection
    ITableStyle
    IText
    ITextBoxAlignment
    ITextFrame
    ITheme
    IThemeCollection
    ITransaction
    ITypes
    IWorkbook
    IWorkbookProtection
    IWorkbookView
    NumberFormat
    Picture
    ReferenceableClipboard
    Sort
    TextUtils
    Tuple
    TypedObject
    TypesUtils

    Classes

    Calculation
    ChainedError
    Color
    Deferred
    ExternalRangeClipboardItem
    InternalClipboard
    NotImplementedError
    NullNotAllowedError
    Observable
    OutOfBoundsError
    PartialError
    Picture
    RangeClipboardItem
    Resource
    ResourceCollection
    Sheet
    StringCollection
    StubbedFormulaContext
    StyleCollection
    Table
    Theme
    ThemeCollection
    TransactionStore
    TransactionUndoManager
    TypedError
    UndoManager
    UserError
    Workbook
    WorkbookView

    Interfaces

    Bounds
    CellCoords
    Dimensions
    DimensionsFlags
    EditMode
    FetchArgs
    IAnchored
    IAutoFilter
    IAutoSort
    IBorder
    ICalculation
    ICell
    ICellContainerOptions
    ICellHeader
    ICellHeaderRange
    ICellProtection
    ICellRange
    ICellRanges
    IChart
    ICollection
    IColor
    IComment
    IConditionalFormat
    IConditionalFormatCollection
    IFill
    IFormulaContext
    IFunction
    IFunctionCollection
    IModule
    IMovable
    IMovableCollection
    IMovableSelection
    INamed
    INamedCollection
    IPicture
    IProtection
    IRange
    IRangeSelection
    IReferenceRange
    IRepeatableOperation
    IResource
    IResourceCollection
    IRichData
    IRuntime
    IScript
    ISheet
    ISheetCollection
    ISheetHeader
    ISheetProtection
    ISheetView
    IStringCollection
    IStyle
    IStyleCollection
    IStyledFont
    ITable
    ITableCollection
    ITableStyle
    ITextBoxAlignment
    ITextFrame
    ITheme
    IThemeCollection
    ITransaction
    IUndoOperation
    IWorkbook
    IWorkbookProtection
    IWorkbookView
    JSONSerializable
    JSONSerializableAsync
    Point
    RangeCoords
    RangedValue
    Rectangle
    ReferenceableClipboard
    RemoveListener
    RunCoords
    SelectionCoords
    Subscriber
    TaskProgress
    TextMeasurerOptions
    TopLeft
    TypedObject

    Type Aliases

    JSScalar
    JSScalarUpdate
    Scalar
    ScalarUpdate

    Variables

    AnchorLocation
    ClipboardUtils
    Direction
    FormulaContext
    LicenseManager
    MimeType
    RangeOrientation
    RangeOrientations
    ScalarType

    Functions

    JSONStableStringify