CellInputSnapshot | @sheetwrite/core

@sheetwrite/coreinterface

View-aware editable snapshot of one cell, for hosts building a detached formula bar or cell inspector. address is the translated data address — the correct target for Grid.applyTransaction even under an active sort/filter view — while the (row, col) inputs of Grid.getCellInput are active-sheet view coordinates.

Package: @sheetwrite/core
Source: packages/core/src/types/grid.ts#L337

Members 3

address Underlying data address, suitable for a set patch.

readonly address: CellAddressinterface CellAddress {
  sheet: SheetId;
  row: number;
  col: number;
}interface CellAddress {
  sheet: SheetId;
  row: number;
  col: number;
}interface CellAddress {
  sheet: SheetId;
  row: number;
  col: number;
}Zero-based address of one cell on a stable sheet ID.API reference →;

text Formula source when the cell is a formula, else the literal display text.

readonly text: string;

format Column input format, for parseCellInput.

readonly format: CellFormattype CellFormat = "text" | "number" | "date" | "currency";type CellFormat = "text" | "number" | "date" | "currency";type CellFormat =
  | "text"
  | "number"
  | "date"
  | "currency";How a column's cells are typed, parsed, and rendered: text verbatim, number via its numberFormat, date as an Excel-style serial (see date-serial.ts) rendered by a date numberFormat, and currency as a plain number rendered by a currency numberFormat (e.g. $#,##0.00).API reference →;

Declaration

View full TypeScript declaration

export interface CellInputSnapshot {
  readonly address: CellAddressinterface CellAddress {
  sheet: SheetId;
  row: number;
  col: number;
}interface CellAddress {
  sheet: SheetId;
  row: number;
  col: number;
}interface CellAddress {
  sheet: SheetId;
  row: number;
  col: number;
}Zero-based address of one cell on a stable sheet ID.API reference →;
  readonly text: string;
  readonly format: CellFormattype CellFormat = "text" | "number" | "date" | "currency";type CellFormat = "text" | "number" | "date" | "currency";type CellFormat =
  | "text"
  | "number"
  | "date"
  | "currency";How a column's cells are typed, parsed, and rendered: text verbatim, number via its numberFormat, date as an Excel-style serial (see date-serial.ts) rendered by a date numberFormat, and currency as a plain number rendered by a currency numberFormat (e.g. $#,##0.00).API reference →;
}