# Sheets Table

- Human documentation: [https://docs.univer.ai/reference/facade/table](https://docs.univer.ai/reference/facade/table)

- Agent Markdown: [https://docs.univer.ai/reference/facade/table.md](https://docs.univer.ai/reference/facade/table.md)

- Requested language: `en-US`

- Content language: `en-US`

- Documentation version: `1.0.0-rc.0`

- Source: [facade/table.mdx](https://github.com/dream-num/documentation/blob/dev/content/reference/facade/table.mdx)

---

| Packages | `@univerjs/sheets-table` |
| -------- | ------------------------ |

Facade APIs for working with Univer Sheets tables from `FWorkbook` and `FWorksheet`.

> Import `@univerjs/sheets-table/facade` before using these APIs in plugin mode.

## Overview

### FWorkbook

| Method               | Signature                                                                                                                                        |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `getTableInfo`       | `getTableInfo(tableId: string): ITableInfoWithUnitId \| undefined`                                                                               |
| `getTableList`       | `getTableList(): ITableInfoWithUnitId[]`                                                                                                         |
| `addTable`           | addTable(subUnitId: string, tableName: string, rangeInfo: ITableRange, tableId?: string, options?: ITableOptions): Promise\<string \| undefined> |
| `removeTable`        | removeTable(tableId: string): Promise\<boolean>                                                                                                  |
| `getTableInfoByName` | `getTableInfoByName(tableName: string): ITableInfoWithUnitId \| undefined`                                                                       |
| `setTableFilter`     | setTableFilter(tableId: string, column: number, filter: ITableFilterItem \| undefined): Promise\<boolean>                                        |

### FWorksheet

| Method             | Signature                                                                                                                    |
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
| `addTable`         | addTable(tableName: string, rangeInfo: ITableRange, tableId?: string, options?: ITableOptions): Promise\<boolean> \| boolean |
| `setTableFilter`   | setTableFilter(tableId: string, column: number, filter: ITableFilterItem): Promise\<boolean>                                 |
| `removeTable`      | removeTable(tableId: string): Promise\<boolean>                                                                              |
| `setTableRange`    | setTableRange(tableId: string, rangeInfo: ITableRange): Promise\<boolean>                                                    |
| `setTableName`     | setTableName(tableId: string, tableName: string): Promise\<boolean> \| boolean                                               |
| `getSubTableInfos` | `getSubTableInfos(): ITableInfoWithUnitId[]`                                                                                 |
| `resetFilter`      | resetFilter(tableId: string, column: number): Promise\<boolean>                                                              |
| `getTableByCell`   | `getTableByCell(row: number, column: number): ITableInfoWithUnitId \| undefined`                                             |
| `addTableTheme`    | addTableTheme(tableId: string, themeStyleJSON: IRangeThemeStyleJSON): Promise\<boolean>                                      |

## Examples

```ts
const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook?.getActiveSheet()

await fWorksheet?.addTable('SalesTable', {
  startRow: 0,
  startColumn: 0,
  endRow: 10,
  endColumn: 4,
})

const table = fWorksheet?.getTableByCell(0, 0)
```

Source: 

`@univerjs/sheets-table`