Cells & Data

Cells are the building blocks of worksheets. Each cell holds a value and optional style.

#Cell Values

JSON

{
  "worksheets": [
    {
      "name": "Sheet1",
      "rows": [{ "cells": [{ "value": "Hello" }, { "value": 42 }, { "value": true }] }]
    }
  ]
}

TypeScript

import { generateWorkbook } from "@office-open/xlsx";

const buffer = await generateWorkbook({
  worksheets: [
    {
      name: "Sheet1",
      rows: [{ cells: [{ value: "Hello" }, { value: 42 }, { value: true }] }],
    },
  ],
});

Supported value types:

Type	Example	Description
`string`	`{ value: "Hello" }`	Shared string reference
`number`	`{ value: 42 }`	Inline numeric value
`boolean`	`{ value: true }`	Boolean value (0/1)
`Date`	`{ value: new Date("2024-01-01") }`	Serial number
`null`	`{ value: null }`	Empty cell (skipped)

#Styled Cells

Apply styles directly to cells:

JSON

{
  "worksheets": [
    {
      "name": "Sheet1",
      "rows": [
        {
          "cells": [
            {
              "value": "Header",
              "style": {
                "font": { "bold": true },
                "fill": { "foregroundColor": { "rgb": "FF4472C4" } }
              }
            },
            { "value": 100, "style": { "numFmt": "#,##0" } }
          ]
        }
      ]
    }
  ]
}

TypeScript

{
  cells: [
    { value: "Header", style: { font: { bold: true }, fill: { foregroundColor: { rgb: "FF4472C4" } } } },
    { value: 100, style: { numFmt: "#,##0" } },
  ],
}

See Styles for the full list of style options.

#Row Heights

Set custom row heights:

JSON

{
  "worksheets": [
    {
      "name": "Sheet1",
      "rows": [{ "cells": [{ "value": "Tall row" }], "height": 30 }]
    }
  ]
}

TypeScript

{
  cells: [{ value: "Tall row" }],
  height: 30, // Height in points
}

#Hidden Rows

JSON

{
  "worksheets": [
    {
      "name": "Sheet1",
      "rows": [
        { "cells": [{ "value": "Visible" }] },
        { "cells": [{ "value": "Hidden" }], "hidden": true }
      ]
    }
  ]
}

TypeScript

{
  cells: [{ value: "Visible" }],
},
{
  cells: [{ value: "Hidden" }],
  hidden: true,
},

#Number Formats

Common number format patterns:

Pattern	Input	Display
`#,##0`	1234	1,234
`#,##0.00`	1234.5	1,234.50
`0%`	0.85	85%
`yyyy-mm-dd`	Date	2024-01-01

#Cell Options Reference

Option	Type	Description
`value`	`string \| number \| boolean \| Date \| RichTextOptions \| null`	Cell value (auto-reference when omitted)
`reference`	`string`	Explicit cell reference, e.g. `"A1"`
`style`	`StyleOptions` \| `number`	Cell style, or the raw cellXfs index as a round-trip fallback (see Styles)
`formula`	`FormulaOptions`	Cell formula; `value` is the cached result

#Row Options Reference

Option	Type	Description
`cells`	`CellOptions[]`	Array of cells
`height`	`number \| UniversalMeasure`	Row height in points or UniversalMeasure
`hidden`	`boolean`	Hide the row