IronCalc Node.js
    Preparing search index...

    Class Model

    A workbook model implementing the "raw" low level API. Nothing is evaluated automatically: you need to call evaluate yourself. There is no undo/redo history and no diffs are produced.

    Index
    • Creates an empty workbook. locale, timezone and languageId default to "en", "UTC" and "en".

      Parameters

      • name: string
      • Optionallocale: string | null
      • Optionaltimezone: string | null
      • OptionallanguageId: string | null

      Returns Model

    • Adds a new sheet with the given name

      Parameters

      • sheetName: string

      Returns void

    • Clears the contents of a single cell, keeping the formatting

      Parameters

      • sheet: number
      • row: number
      • column: number

      Returns void

    • Parameters

      • sheet: number
      • column: number
      • columnCount: number

      Returns void

    • Deletes the default style of a column

      Parameters

      • sheet: number
      • column: number

      Returns void

    • Parameters

      • name: string
      • Optionalscope: number | null

      Returns void

    • Parameters

      • sheet: number
      • row: number
      • rowCount: number

      Returns void

    • Deletes the default style of a row

      Parameters

      • sheet: number
      • row: number

      Returns void

    • Parameters

      • sheet: number

      Returns void

    • Evaluates the workbook

      Returns void

    • Returns all non-empty cells as a list of [sheet, row, column] tuples

      Returns [number, number, number][]

    • Returns the content of a cell as the user would see it in the editor: the formula if there is one or the raw value otherwise

      Parameters

      • sheet: number
      • row: number
      • column: number

      Returns string

    • Returns the formula of a cell, if any

      Parameters

      • sheet: number
      • row: number
      • column: number

      Returns string | null

    • Returns the style of a cell

      Parameters

      • sheet: number
      • row: number
      • column: number

      Returns CellStyle

    • Returns the type of the content of a cell

      Parameters

      • sheet: number
      • row: number
      • column: number

      Returns CellType

    • Returns the value of a cell as a native JS value (null, string, number or boolean)

      Parameters

      • sheet: number
      • row: number
      • column: number

      Returns string | number | boolean | null

    • Returns the value of a cell referenced like "Sheet1!C4" as a native JS value (null, string, number or boolean)

      Parameters

      • cellRef: string

      Returns string | number | boolean | null

    • Returns the default style of a column, if any

      Parameters

      • sheet: number
      • column: number

      Returns CellStyle | null

    • Parameters

      • sheet: number
      • column: number

      Returns number

    • Returns the list of defined names as [{name, scope, formula}]. scope is omitted for globally scoped names.

      Returns DefinedName[]

    • Returns the formatted value of a cell (i.e. "$ 5.75")

      Parameters

      • sheet: number
      • row: number
      • column: number

      Returns string

    • Parameters

      • sheet: number

      Returns number

    • Parameters

      • sheet: number

      Returns number

    • Parameters

      • sheet: number
      • row: number

      Returns number

    • Returns the default style of a row, if any

      Parameters

      • sheet: number
      • row: number

      Returns CellStyle | null

    • Returns the bounds of all non-empty cells as [minRow, maxRow, minColumn, maxColumn]. For an empty sheet returns [1, 1, 1, 1].

      Parameters

      • sheet: number

      Returns [number, number, number, number]

    • Returns a markdown-like representation of the sheet, useful for debugging

      Parameters

      • sheet: number

      Returns string

    • Parameters

      • sheet: number
      • column: number
      • columnCount: number

      Returns void

    • Parameters

      • sheet: number
      • row: number
      • rowCount: number

      Returns void

    • Parameters

      • sheet: number
      • column: number

      Returns boolean

    • Returns true if the cell is empty

      Parameters

      • sheet: number
      • row: number
      • column: number

      Returns boolean

    • Parameters

      • sheet: number
      • row: number

      Returns boolean

    • Moves a column by delta positions

      Parameters

      • sheet: number
      • column: number
      • delta: number

      Returns void

    • Moves a row by delta positions

      Parameters

      • sheet: number
      • row: number
      • delta: number

      Returns void

    • Creates a new defined name. scope is a sheet index or null for global scope.

      Parameters

      • name: string
      • scope: number | null | undefined
      • formula: string

      Returns void

    • Adds a new sheet with an automatically generated name

      Returns void

    • Clears contents and formatting of all cells in the range

      Parameters

      • sheet: number
      • startRow: number
      • startColumn: number
      • endRow: number
      • endColumn: number

      Returns void

    • Clears the contents of all cells in the range, keeping the formatting

      Parameters

      • sheet: number
      • startRow: number
      • startColumn: number
      • endRow: number
      • endColumn: number

      Returns void

    • Parameters

      • sheet: number
      • newName: string

      Returns void

    • Saves the workbook to a file in the internal binary ic format

      Parameters

      • file: string

      Returns void

    • Saves the workbook to an xlsx file

      Parameters

      • file: string

      Returns void

    • Sets the style of a cell from a style object

      Parameters

      • sheet: number
      • row: number
      • column: number
      • style: CellStyle

      Returns void

    • Parameters

      • sheet: number
      • column: number
      • hidden: boolean

      Returns void

    • Sets the default style for a whole column

      Parameters

      • sheet: number
      • column: number
      • style: CellStyle

      Returns void

    • Parameters

      • sheet: number
      • column: number
      • width: number

      Returns void

    • Parameters

      • sheet: number
      • columnCount: number

      Returns void

    • Parameters

      • sheet: number
      • rowCount: number

      Returns void

    • Parameters

      • language: string

      Returns void

    • Parameters

      • locale: string

      Returns void

    • Parameters

      • sheet: number
      • row: number
      • height: number

      Returns void

    • Parameters

      • sheet: number
      • row: number
      • hidden: boolean

      Returns void

    • Sets the default style for a whole row

      Parameters

      Returns void

    • Sets the sheet tab color. Accepts null, "#RRGGBB" or [theme, tint]

      Parameters

      • sheet: number
      • Optionalcolor: Color | null

      Returns void

    • Sets the sheet visibility state: "visible", "hidden" or "veryHidden"

      Parameters

      • sheet: number
      • state: string

      Returns void

    • Parameters

      • sheet: number
      • showGridLines: boolean

      Returns void

    • Parameters

      • timezone: string

      Returns void

    • Sets an array (spill) formula in the range

      Parameters

      • sheet: number
      • row: number
      • column: number
      • width: number
      • height: number
      • formula: string

      Returns void

    • Sets an input in a cell, parsing it as a user would type it: "3.5" is a number, "Hello" a string, "=A1*2" a formula

      Parameters

      • sheet: number
      • row: number
      • column: number
      • value: string

      Returns void

    • Returns the workbook as bytes in the internal binary ic format

      Returns Uint8Array

    • Sets a boolean in a cell without input parsing

      Parameters

      • sheet: number
      • row: number
      • column: number
      • value: boolean

      Returns void

    • Sets a formula (i.e. "=A1*2") in a cell

      Parameters

      • sheet: number
      • row: number
      • column: number
      • formula: string

      Returns void

    • Sets a number in a cell without input parsing

      Parameters

      • sheet: number
      • row: number
      • column: number
      • value: number

      Returns void

    • Sets a string value in a cell without input parsing

      Parameters

      • sheet: number
      • row: number
      • column: number
      • value: string

      Returns void

    • Parameters

      • name: string
      • scope: number | null | undefined
      • newName: string
      • newScope: number | null | undefined
      • newFormula: string

      Returns void

    • Creates a model from bytes in the internal binary ic format. This is the same format produced by saveToIcalc and toBytes.

      Parameters

      • bytes: Uint8Array
      • OptionallanguageId: string | null

      Returns Model

    • Creates a model from an icalc file

      Parameters

      • fileName: string
      • OptionallanguageId: string | null

      Returns Model

    • Creates a model from an xlsx file

      Parameters

      • filePath: string
      • Optionallocale: string | null
      • Optionaltimezone: string | null
      • OptionallanguageId: string | null

      Returns Model