Sheets Outline

Packages	`@univerjs-pro/sheets-outline`

Facade APIs for row and column outlines in Univer Sheets with Web SDK.

Import @univerjs-pro/sheets-outline/facade before 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)

Source: @univerjs-pro/sheets-outline

How is this guide?