# 表格

- Human documentation: [https://docs.univer.ai/zh-CN/guides/docs/features/table](https://docs.univer.ai/zh-CN/guides/docs/features/table)

- Agent Markdown: [https://docs.univer.ai/zh-CN/guides/docs/features/table.md](https://docs.univer.ai/zh-CN/guides/docs/features/table.md)

- Requested language: `zh-CN`

- Content language: `zh-CN`

- Documentation version: `1.0.0-rc.0`

- Source: [docs/features/table.zh-CN.mdx](https://github.com/dream-num/documentation/blob/dev/content/guides/docs/features/table.zh-CN.mdx)

---

#### Package metadata

```json
{
  "plugins": [
    {
      "client": "@univerjs-pro/docs-table",
      "facade": "@univerjs-pro/docs-table/facade"
    },
    {
      "client": "@univerjs-pro/docs-table-ui",
      "locale": "@univerjs-pro/docs-table-ui/locale/zh-CN",
      "style": "@univerjs-pro/docs-table-ui/lib/index.css"
    }
  ],
  "license": true,
  "server": false
}
```

增强表格功能为 Univer Docs 提供了丰富的表格编辑能力，包括单元格样式、边框自定义、行列操作和数据填充。

## 介绍

在 Univer Docs 中，增强表格使您能够：

* **以编程方式插入表格**：创建指定尺寸的表格。
* **操作结构**：添加、删除和移动行列。
* **样式单元格**：应用边框、背景和文本格式。
* **合并和拆分单元格**：组合单元格以实现复杂布局。

## 插件模式

### 安装

#### npm

```bash
npm install @univerjs-pro/docs-table @univerjs-pro/docs-table-ui
```

#### pnpm

```bash
pnpm add @univerjs-pro/docs-table @univerjs-pro/docs-table-ui
```

#### yarn

```bash
yarn add @univerjs-pro/docs-table @univerjs-pro/docs-table-ui
```

#### bun

```bash
bun add @univerjs-pro/docs-table @univerjs-pro/docs-table-ui
```

### 使用

```typescript
import { UniverDocsTablePlugin } from '@univerjs-pro/docs-table' // [!code ++]
import { UniverDocsTableUIPlugin } from '@univerjs-pro/docs-table-ui' // [!code ++]
import DocsTableUIZhCN from '@univerjs-pro/docs-table-ui/locale/zh-CN' // [!code ++]
import { LocaleType, mergeLocales, Univer } from '@univerjs/core'

import '@univerjs-pro/docs-table-ui/lib/index.css' // [!code ++]

const univer = new Univer({
  locale: LocaleType.ZH_CN,
  locales: {
    [LocaleType.ZH_CN]: mergeLocales(
      DocsTableUIZhCN, // [!code ++]
    ),
  },
})

univer.registerPlugin(UniverDocsTablePlugin) // [!code ++]
univer.registerPlugin(UniverDocsTableUIPlugin) // [!code ++]
```

如果您拥有 Univer 商业许可证，请参阅[在客户端使用许可证](https://docs.univer.ai/zh-CN/guides/license.md#in-plugin-mode)进行配置。

## Facade API

使用 API 前请确保已导入 facade：

```typescript
import '@univerjs-pro/docs-table/facade'
```

### 插入表格

```typescript
const doc = univerAPI.getActiveDocument()
const table = doc?.insertTable(3, 4, { tableId: 'my-table' })
table?.setCellText(0, 0, 'Name')
```

### 从数据插入表格

```typescript
const doc = univerAPI.getActiveDocument()
doc?.insertTableFromData([
  ['Name', 'Status'],
  ['Facade', 'Ready'],
], { headerRowCount: 1 })
```

### 获取所有表格

```typescript
const doc = univerAPI.getActiveDocument()
const tables = doc?.getTables() ?? []
```

### 删除表格

```typescript
const doc = univerAPI.getActiveDocument()
doc?.deleteTable('my-table')
```