---
title: Workbook Object
sidebar_position: 4
---

SheetJS workbook objects represent collections of worksheets and associated
workbook-level metadata.

For a given workbook object `wb`:

`wb.SheetNames` is an ordered list of the sheets in the workbook.

`wb.Sheets` is an object whose keys are worksheet names (from `SheetNames`) and
whose values are worksheet objects.

`wb.Workbook` stores [workbook-level attributes](#workbook-level-attributes).

When reading a file, `wb.bookType` is the determined book type.

## File Properties

`wb.Props` is an object storing the standard properties.

`wb.Custprops` stores custom properties.

["File Properties"](/docs/csf/features/props) covers the feature in more detail.

## Workbook-Level Attributes

`wb.Workbook` stores workbook-level attributes.

### Defined Names

`wb.Workbook.Names` is an array of defined name objects. Defined names are
discussed in more detail in ["Defined Names"](/docs/csf/features/names)

### Workbook Views

`wb.Workbook.Views` is an array of workbook view objects which have the keys:

| Key             | Description                                         |
|:----------------|:----------------------------------------------------|
| `RTL`           | If true, display right-to-left                      |

### Miscellaneous Workbook Properties

`wb.Workbook.WBProps` holds other workbook properties:

| Key             | Description                                                |
|:----------------|:-----------------------------------------------------------|
| `CodeName`      | [VBA Workbook Name](/docs/csf/features/vba)                |
| `date1904`      | epoch: 0/false for 1900 system, 1/true for 1904            |
| `filterPrivacy` | Warn or strip personally identifying info on save          |

### Sheet Metadata

`wb.Workbook.Sheets` is an array of sheet metadata objects which have the keys:

| Key             | Description                                         |
|:----------------|:----------------------------------------------------|
| `Hidden`        | [Sheet Visibility](/docs/csf/features/visibility)   |
| `CodeName`      | [VBA Sheet Code Name](/docs/csf/features/vba)       |