冻结
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 列}冻结窗格示意
向下、向右滚动,观察哪些单元格留在原位。
| A | B | C | D | E | F | G | H | |
|---|---|---|---|---|---|---|---|---|
| 1 | A1 | B1 | C1 | D1 | E1 | F1 | G1 | H1 |
| 2 | A2 | B2 | C2 | D2 | E2 | F2 | G2 | H2 |
| 3 | A3 | B3 | C3 | D3 | E3 | F3 | G3 | H3 |
| 4 | A4 | B4 | C4 | D4 | E4 | F4 | G4 | H4 |
| 5 | A5 | B5 | C5 | D5 | E5 | F5 | G5 | H5 |
| 6 | A6 | B6 | C6 | D6 | E6 | F6 | G6 | H6 |
| 7 | A7 | B7 | C7 | D7 | E7 | F7 | G7 | H7 |
| 8 | A8 | B8 | C8 | D8 | E8 | F8 | G8 | H8 |
| 9 | A9 | B9 | C9 | D9 | E9 | F9 | G9 | H9 |
| 10 | A10 | B10 | C10 | D10 | E10 | F10 | G10 | H10 |
| 11 | A11 | B11 | C11 | D11 | E11 | F11 | G11 | H11 |
| 12 | A12 | B12 | C12 | D12 | E12 | F12 | G12 | H12 |
| 13 | A13 | B13 | C13 | D13 | E13 | F13 | G13 | H13 |
| 14 | A14 | B14 | C14 | D14 | E14 | F14 | G14 | H14 |
| 15 | A15 | B15 | C15 | D15 | E15 | F15 | G15 | H15 |
| 16 | A16 | B16 | C16 | D16 | E16 | F16 | G16 | H16 |
| 17 | A17 | B17 | C17 | D17 | E17 | F17 | G17 | H17 |
| 18 | A18 | B18 | C18 | D18 | E18 | F18 | G18 | H18 |
{
"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()你觉得这篇文档如何?