> ## Documentation Index
> Fetch the complete documentation index at: https://docs.reducto.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Other classes: Other

## `Book`

What every facade handle of one workbook shares.

Not exported by name. You get it from the API.

### Book properties

| Name | Type | Description |
| - | - | - |
| `chartHandles` | `Map<string, ExcelChart>` | read-only One handle per chart, keyed by worksheet id and drawing object id. |
| `model` | `Workbook` | read-only |
| `tableHandles` | `Map<number, ExcelTable>` | read-only One handle per table id, shared by every collection. |
| `userEmail` | `string` | The new comments' author email, empty when unknown. |
| `userName` | `string` | The author of new notes and comments; Office.js uses the signed-in user. |
| `worksheetAt` | `(index: number) => ExcelWorksheet` | The worksheet handle of a sheet index; the collection installs it. |
| `normalFont` | `NormalFont` | read-only The font that sets the column character width. |
| `styles` | `StyleBook` | read-only |

### `Book.theme()`

```ts theme={null}
theme(): string[]
```

Theme colours in SpreadsheetML slot order.

### `Book.themeFaces()`

```ts theme={null}
themeFaces(): ThemeFaces
```

The theme's body and heading faces, which built-in cell styles use.

## `CustomProperty`

`Excel.CustomProperty`: one user-defined property; keys are matched ignoring case.

Import from `@reductoai/xlsx/officejs`.

### CustomProperty properties

| Name | Type | Description |
| - | - | - |
| `key` | `string` | read-only |
| `type` | `DocumentPropertyType` | read-only |
| `value` | `CustomPropertyValue` | |

### `CustomProperty.delete()`

```ts theme={null}
delete(): void
```

### `CustomProperty.set()`

```ts theme={null}
set(
  properties: CustomProperty | UpdateData<CustomProperty>,
  options?: UpdateOptions,
): void
```

Sets several properties at once; a navigation member takes a nested batch.

## `CustomPropertyCollection`

`Excel.CustomPropertyCollection`: docProps/custom.xml.

Import from `@reductoai/xlsx/officejs`.

### CustomPropertyCollection properties

| Name | Type | Description |
| - | - | - |
| `items` | `CustomProperty[]` | read-only |

### `CustomPropertyCollection.add()`

```ts theme={null}
add(key: string, value: CustomPropertyValue): CustomProperty
```

Adds a property, or sets the value of the one with this key.

### `CustomPropertyCollection.deleteAll()`

```ts theme={null}
deleteAll(): void
```

### `CustomPropertyCollection.getCount()`

```ts theme={null}
getCount(): { value: number }
```

### `CustomPropertyCollection.getItem()`

```ts theme={null}
getItem(key: string): CustomProperty
```

### `CustomPropertyCollection.getItemOrNullObject()`

```ts theme={null}
getItemOrNullObject(key: string): CustomProperty & { isNullObject: boolean }
```

## `CustomXmlPart`

`Excel.CustomXmlPart`: a `customXml/itemN.xml` part the workbook relates.

Import from `@reductoai/xlsx/officejs`.

### CustomXmlPart properties

| Name | Type | Description |
| - | - | - |
| `id` | `string` | read-only |
| `namespaceUri` | `string` | read-only |

### `CustomXmlPart.delete()`

```ts theme={null}
delete(): void
```

### `CustomXmlPart.getXml()`

```ts theme={null}
getXml(): ClientResult<string>
```

### `CustomXmlPart.setXml()`

```ts theme={null}
setXml(xml: string): void
```

## `CustomXmlPartCollection`

`Excel.CustomXmlPartCollection`: `customXml/itemN.xml` with their `itemPropsN.xml`.

Import from `@reductoai/xlsx/officejs`.

### CustomXmlPartCollection properties

| Name | Type | Description |
| - | - | - |
| `items` | `CustomXmlPart[]` | read-only |

### `CustomXmlPartCollection.add()`

```ts theme={null}
add(xml: string): CustomXmlPart
```

### `CustomXmlPartCollection.getByNamespace()`

```ts theme={null}
getByNamespace(namespaceUri: string): CustomXmlPartScopedCollection
```

### `CustomXmlPartCollection.getCount()`

```ts theme={null}
getCount(): ClientResult<number>
```

### `CustomXmlPartCollection.getItem()`

```ts theme={null}
getItem(id: string): CustomXmlPart
```

### `CustomXmlPartCollection.getItemOrNullObject()`

```ts theme={null}
getItemOrNullObject(id: string): Nullable<CustomXmlPart>
```

## `CustomXmlPartScopedCollection`

`Excel.CustomXmlPartScopedCollection`: the parts whose root is in one namespace.

Import from `@reductoai/xlsx/officejs`.

### CustomXmlPartScopedCollection properties

| Name | Type | Description |
| - | - | - |
| `items` | `CustomXmlPart[]` | read-only |

### `CustomXmlPartScopedCollection.getCount()`

```ts theme={null}
getCount(): ClientResult<number>
```

### `CustomXmlPartScopedCollection.getItem()`

```ts theme={null}
getItem(id: string): CustomXmlPart
```

### `CustomXmlPartScopedCollection.getItemOrNullObject()`

```ts theme={null}
getItemOrNullObject(id: string): Nullable<CustomXmlPart>
```

### `CustomXmlPartScopedCollection.getOnlyItem()`

```ts theme={null}
getOnlyItem(): CustomXmlPart
```

### `CustomXmlPartScopedCollection.getOnlyItemOrNullObject()`

```ts theme={null}
getOnlyItemOrNullObject(): Nullable<CustomXmlPart>
```

## `DocumentProperties`

`Excel.DocumentProperties`: docProps/core.xml and app.xml; a part is added on first write.

Import from `@reductoai/xlsx/officejs`.

### DocumentProperties properties

| Name | Type | Description |
| - | - | - |
| `author` | `string` | |
| `category` | `string` | |
| `comments` | `string` | |
| `company` | `string` | |
| `creationDate` | `Date \| undefined` | read-only Undefined when the file records no creation date. |
| `custom` | `CustomPropertyCollection` | read-only |
| `keywords` | `string` | |
| `lastAuthor` | `string` | read-only |
| `manager` | `string` | |
| `revisionNumber` | `number` | |
| `subject` | `string` | |
| `title` | `string` | |

### `DocumentProperties.set()`

```ts theme={null}
set(
  properties: DocumentProperties | UpdateData<DocumentProperties>,
  options?: UpdateOptions,
): void
```

Sets several properties at once; a navigation member takes a nested batch.

## `RangeAreasCollection`

`Excel.RangeAreasCollection`.

Import from `@reductoai/xlsx/officejs`.

### RangeAreasCollection properties

| Name | Type | Description |
| - | - | - |
| `items` | `RangeAreas[]` | read-only |

### `RangeAreasCollection.getCount()`

```ts theme={null}
getCount(): ClientResult<number>
```

### `RangeAreasCollection.getItemAt()`

```ts theme={null}
getItemAt(index: number): RangeAreas
```

## `RangeCollection`

`Excel.RangeCollection`: the rectangles of a `RangeAreas`, in order.

Import from `@reductoai/xlsx/officejs`.

### RangeCollection properties

| Name | Type | Description |
| - | - | - |
| `items` | `ExcelRange[]` | read-only |

### `RangeCollection.getCount()`

```ts theme={null}
getCount(): ClientResult<number>
```

### `RangeCollection.getItemAt()`

```ts theme={null}
getItemAt(index: number): ExcelRange
```

## `Store`

Not exported by name. You get it from the API.

### Store properties

| Name | Type | Description |
| - | - | - |
| `sheet` | `ExcelWorksheet` | read-only |

### `Store.edit()`

```ts theme={null}
edit(name: string, change: (set: ScenarioSet, at: number) => void): void
```

### `Store.find()`

```ts theme={null}
find(name: string): number
```

### `Store.read()`

```ts theme={null}
read(): ScenarioSet
```

### `Store.write()`

```ts theme={null}
write(set: ScenarioSet): void
```

## `WorkbookRangeAreas`

`Excel.WorkbookRangeAreas`: cells on one or more sheets.

Import from `@reductoai/xlsx/officejs`.

### WorkbookRangeAreas properties

| Name | Type | Description |
| - | - | - |
| `addresses` | `string[]` | read-only |
| `areas` | `RangeAreasCollection` | read-only |
| `ranges` | `RangeCollection` | read-only |

### `WorkbookRangeAreas.getRangeAreasBySheet()`

```ts theme={null}
getRangeAreasBySheet(key: string): RangeAreas
```

By worksheet name or id.

### `WorkbookRangeAreas.getRangeAreasOrNullObjectBySheet()`

```ts theme={null}
getRangeAreasOrNullObjectBySheet(key: string): Nullable<RangeAreas>
```

## `WorksheetCustomProperty`

`Excel.WorksheetCustomProperty`: a key and a text value stored with the sheet.

Import from `@reductoai/xlsx/officejs`.

### WorksheetCustomProperty properties

| Name | Type | Description |
| - | - | - |
| `key` | `string` | read-only |
| `value` | `string` | |

### `WorksheetCustomProperty.delete()`

```ts theme={null}
delete(): void
```

### `WorksheetCustomProperty.set()`

```ts theme={null}
set(properties: { value?: string }): void
```

## `WorksheetCustomPropertyCollection`

`Excel.WorksheetCustomPropertyCollection`: keys are unique regardless of case.

Import from `@reductoai/xlsx/officejs`.

### WorksheetCustomPropertyCollection properties

| Name | Type | Description |
| - | - | - |
| `items` | `WorksheetCustomProperty[]` | read-only |

### `WorksheetCustomPropertyCollection.add()`

```ts theme={null}
add(key: string, value: string): WorksheetCustomProperty
```

Adds `key`, or sets its value when the sheet already has it.

### `WorksheetCustomPropertyCollection.getCount()`

```ts theme={null}
getCount(): ClientResult<number>
```

### `WorksheetCustomPropertyCollection.getItem()`

```ts theme={null}
getItem(key: string): WorksheetCustomProperty
```

### `WorksheetCustomPropertyCollection.getItemOrNullObject()`

```ts theme={null}
getItemOrNullObject(key: string): Nullable<WorksheetCustomProperty>
```
