Sheets Outline
本 API 页面目前提供英文正文。代码签名与标识符不随界面语言变化。
| Packages | @univerjs-pro/sheets-outline |
|---|
Facade APIs for row and column outlines in Univer Sheets with Web SDK.
Import
@univerjs-pro/sheets-outline/facadebefore using these APIs in plugin mode.
Overview
FWorksheet
| Method | Signature |
|---|---|
addRowOutline | addRowOutline(startRow: number, numRows: number): FWorksheet |
addColumnOutline | addColumnOutline(startColumn: number, numColumns: number): FWorksheet |
removeDimensionOutline | removeDimensionOutline(outlineId: string): FWorksheet |
setDimensionOutlineCollapsed | setDimensionOutlineCollapsed(outlineId: string, collapsed: boolean): FWorksheet |
clearDimensionOutlines | clearDimensionOutlines(axis: DimensionOutlineAxis, start: number, end: number): FWorksheet |
getDimensionOutlines | getDimensionOutlines(axis?: DimensionOutlineAxis): IDimensionOutline[] |
Examples
TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook?.getActiveSheet()fWorksheet?.addRowOutline(1, 5)const outlines = fWorksheet?.getDimensionOutlines(univerAPI.Enum.DimensionOutlineAxis.ROW)@univerjs-pro/sheets-outline你觉得这篇文档如何？