冻结

IWorksheetData.freeze 可以配置工作表的冻结状态。它的接口定义如下:

TypeScript
interface IFreeze {  /**   * 冻结列的数量   */  xSplit: number  /**   * 冻结行的数量   */  ySplit: number  /**   * 可滚动的起始行(视图主区域的起始行)   */  startRow: number  /**   * 可滚动的起始列(视图主区域的起始列)   */  startColumn: number}

例如,我想冻结 B 列和第 2 行,可以这样配置:

JSON
{  "xSplit": 1, // 冻结 1 列,即 B 列  "ySplit": 1, // 冻结 1 行,即第 2 行  "startRow": 2, // 可滚动的起始行是第 3 行  "startColumn": 2 // 可滚动的起始列是第 C 列}

冻结窗格示意

向下、向右滚动,观察哪些单元格留在原位。

ABCDEFGH
1A1B1C1D1E1F1G1H1
2A2B2C2D2E2F2G2H2
3A3B3C3D3E3F3G3H3
4A4B4C4D4E4F4G4H4
5A5B5C5D5E5F5G5H5
6A6B6C6D6E6F6G6H6
7A7B7C7D7E7F7G7H7
8A8B8C8D8E8F8G8H8
9A9B9C9D9E9F9G9H9
10A10B10C10D10E10F10G10H10
11A11B11C11D11E11F11G11H11
12A12B12C12D12E12F12G12H12
13A13B13C13D13E13F13G13H13
14A14B14C14D14E14F14G14H14
15A15B15C15D15E15F15G15H15
16A16B16C16D16E16F16G16H16
17A17B17C17D17E17F17G17H17
18A18B18C18D18E18F18G18H18
{
  "startRow": 1,
  "startColumn": 1,
  "ySplit": 1,
  "xSplit": 1
}

split 表示冻结数量,start 表示可滚动区域的起始索引(从 0 开始);更早的行列不在当前视图中。

Facade API

FWorksheet 类提供了几种方法来管理工作表中行和列的冻结状态。这些方法允许你设置、获取和取消冻结窗格。

设置冻结

TypeScript
const worksheet = univerAPI.getActiveWorkbook().getActiveSheet()worksheet.setFreeze({  xSplit: 1, // 冻结 1 列,即 B 列  ySplit: 1, // 冻结 1 行,即第 2 行  startRow: 2, // 可滚动的起始行是第 3 行  startColumn: 2, // 可滚动的起始列是第 C 列})console.log('当前冻结状态:', worksheet.getFreeze())

设置冻结列的数量

TypeScript
const worksheet = univerAPI.getActiveWorkbook().getActiveSheet()// 设置 A-B 列冻结worksheet.setFrozenColumns(2)

设置冻结行的数量

TypeScript
const worksheet = univerAPI.getActiveWorkbook().getActiveSheet()// 设置前 3 行冻结worksheet.setFrozenRows(3)

获取冻结状态

TypeScript
const worksheet = univerAPI.getActiveWorkbook().getActiveSheet()const freezeState = worksheet.getFreeze()

获取冻结列的数量

TypeScript
const worksheet = univerAPI.getActiveWorkbook().getActiveSheet()const frozenColumns = worksheet.getFrozenColumns()

获取冻结行的数量

TypeScript
const worksheet = univerAPI.getActiveWorkbook().getActiveSheet()const frozenRows = worksheet.getFrozenRows()

取消冻结

TypeScript
const worksheet = univerAPI.getActiveWorkbook().getActiveSheet()// 取消所有冻结worksheet.cancelFreeze()

你觉得这篇文档如何?

© 2026 DreamNum Co., Ltd.