Class TableSheet

Readonly engine

Readonly options

address

• address(displayRow, columnIndex): undefined | string

• The address of a cell ("B3"), undefined for a row number or checkbox column.

  Parameters

  • displayRow: number

    display index

  • columnIndex: number

    model column

  Returns undefined | string

  the address

allowsColumnDrag

• allowsColumnDrag(): boolean

• False for arrays (moving a column moves the data of every row – the references would point elsewhere); object rows: the column letter belongs to the property and moves with it.

  Returns boolean

  true if columns may be dragged

cellOfAddress

• cellOfAddress(address): undefined | [number, number]

• The cell of an address: display row (-1 if a filter hides it) and model column; undefined if invalid.

  Parameters

  • address: string

    "B3", "$B$3"

  Returns undefined | [number, number]

  display row and model column

cellValue

• cellValue(row, col): unknown

• The value of a cell by physical row and engine column (the rows are checked first).

  Parameters

  • row: number

    physical row

  • col: number

    engine column

  Returns unknown

  the value

cellsWritten

• cellsWritten(changes): void

• Cells were written (their inputs changed): the engine compiles their formulas again and recalculates the dependent cells – before the table repaints.

  Parameters

  • changes: readonly CellChangeIf<any>[]

    the written cells (row object or display index, model column)

  Returns void

copyOf

• copyOf(displayRow, columnIndex, input, value): unknown

• The copy of a cell inside the table: a CopiedFormula for a formula cell, otherwise value.

  Parameters

  • displayRow: number

    display index

  • columnIndex: number

    model column

  • input: unknown

    the cell's input

  • value: unknown

    the cell's value

  Returns unknown

  the copy

dependents

• dependents(displayRow, columnIndex): [number, number][]

• The formula cells that read a cell directly (display row, model column; hidden rows left out).

  Parameters

  • displayRow: number

    display index

  • columnIndex: number

    model column

  Returns [number, number][]

  the dependents

destroy

• destroy(): void

• Detaches the sheet from the body (table destroyed).

  Returns void

displayRow

• displayRow(physicalRow): number

• The display row of a physical row, -1 if a filter hides it.

  Parameters

  • physicalRow: number

    the row in getAllRows() / the array

  Returns number

  the display index

engineColumn

• engineColumn(columnIndex): undefined | number

• Parameters

  • columnIndex: number

  Returns undefined | number

  the engine column (A = 0) of a model column

evaluate

• evaluate(source): unknown

• Calculates a formula once against the sheet.

  Parameters

  • source: string

    the formula

  Returns unknown

  the result

inputAt

• inputAt(row, col): unknown

• The input of a cell by physical row and engine column (also of a row a filter hides).

  Parameters

  • row: number

    physical row

  • col: number

    engine column

  Returns unknown

  the input

isFormulaColumnIndex

• isFormulaColumnIndex(columnIndex): boolean

• True if the column may hold formulas.

  Parameters

  • columnIndex: number

  Returns boolean

isFormulaInput

• isFormulaInput(columnIndex, value): value is string

• True if a written value is a formula: text with = in a formula column (it skips editInputPipe and validate).

  Parameters

  • columnIndex: number

    model column

  • value: unknown

    the written value

  Returns value is string

  true for a formula

isFormulaProperty

• isFormulaProperty(property): boolean

• True if the column of this property may hold formulas.

  Parameters

  • property: string

  Returns boolean

modelColumn

• modelColumn(engineColumn): number

• Parameters

  • engineColumn: number

  Returns number

  the model column of an engine column, -1 if there is none

moveFormula

• moveFormula(input, fromRow, fromCol, toDisplayRow, toColumnIndex): undefined | string

• A formula moved from one cell to another (fill handle, paste): relative references move by the physical distance.

  Parameters

  • input: string

    the formula (with =)

  • fromRow: number

    physical row of the source

  • fromCol: number

    engine column of the source

  • toDisplayRow: number

    display row of the target

  • toColumnIndex: number

    model column of the target

  Returns undefined | string

  the moved formula, undefined if the target holds no formulas

physicalRow

• physicalRow(displayRow): undefined | number

• The physical row of a display row (undefined if there is none).

  Parameters

  • displayRow: number

    display index

  Returns undefined | number

  the row in getAllRows() / the array

precedents

• precedents(displayRow, columnIndex): string[]

• The cells and ranges a formula reads, as addresses (["B2", "C2", "D2:D4", "A:A"]).

  Parameters

  • displayRow: number

    display index

  • columnIndex: number

    model column

  Returns string[]

  the addresses (empty for a value cell)

recalculate

• recalculate(): void

• Recalculates everything (data changed outside the table) – TableApi.recalculate.

  Returns void

rowCount

• rowCount(): number

• Returns number

  the number of physical rows

rowsArray

• rowsArray(): undefined | unknown[]

• Returns undefined | unknown[]

  the rows array of an object or array body (not of a sheet)

syntaxError

• syntaxError(input): undefined | string

• The message of a syntax error of a formula, undefined if it parses.

  Parameters

  • input: string

    the formula text (with =)

  Returns undefined | string

  the message

valueAt

• valueAt(row, columnIndex, input): unknown

• The value of a cell of an array row (AreaModelArrayOfArrays): the result for a formula, otherwise input.

  Parameters

  • row: unknown

  • columnIndex: number

  • input: string

  Returns unknown

valueOfProperty

• valueOfProperty(row, property, input): unknown

• The value of a property of a row object: the result for a formula, otherwise input.

  Parameters

  • row: unknown

  • property: string

  • input: string

  Returns unknown

writeInput

• writeInput(row, col, value): void

• Writes an input directly into the data (no events, no recalculation) – formulas adjusted after inserting or deleting rows. row is a physical row or the row itself (object or array).

  Parameters

  • row: number | object

    physical row or row

  • col: number

    engine column

  • value: unknown

    the input

  Returns void

Static create

• create(tableModel, options): undefined | TableSheet

• The cell formulas of a table model – undefined (with a warning) for a body that is not flat.

  Parameters

  • tableModel: TableModelIf

    the model

  • options: CellFormulaOptionsIf

    complete options

  Returns undefined | TableSheet

  the sheet, attached to the body