Skip to content
Apiary

CellCSF

type CellCSF = object;

Plain JavaScript objects representing cell contents.

Properties

Section titled “Properties”

f?

Section titled “f?”
optional f?: string | null;

Formula text (e.g. ‘SUM(A1:A4)‘)

F?

Section titled “F?”
optional F?: string;

Spill range of the cell (e.g. ‘A2:B4’).

Given a cell A1 that spills into A1:C2, every cell in the range (including the A1 cell) should have an F value of ‘A1:C2’.

ft?

Section titled “ft?”
optional ft?: "a";

Formula type: ‘a’ = array formula, or absent to mean single-cell formula, in CSF versions after we introduce this our .xlsx processor. Before that CSF version change, this is always absent in CSF delivered from the GRID API.

href?

Section titled “href?”
optional href?: string | null;

A URL to an external resource

s?

Section titled “s?”
optional s?: CellStyle | null;

Styles/theme of the cell

si?

Section titled “si?”
optional si?: number;

Style index (into styles array, present in API responses but replaced by s by assigning from styles array to individual cells on load

t?

Section titled “t?”
optional t?: "b" | "e" | "n" | "d" | "s" | "z";

Cell value type. Corresponds to the types given by SheetJS and Headless API

b = boolean e = error n = number d = date s = string z = null/blank

This property is optional as it is redundant in all cases except for errors and dates.

v?

Section titled “v?”
optional v?:
  | string
  | number
  | boolean
  | FormulaError
  | null;

Value held by the cell; this is either a formula result or a literal value. Note that a string representing an error value (such as #VALUE!) is interpreted as that error value (with no detail message) when we populate cells from CSF. Yes, this does mean that we cannot currently represent such string values in CSF!

z?

Section titled “z?”
optional z?: string | null;

Cell’s user-assigned number format

zf?

Section titled “zf?”
optional zf?: string | null;

Cell’s formula-assigned number format, propagated from other cells