@univerjs-pro/sheets-slicer

本 API 页面目前提供英文正文。代码签名与标识符不随界面语言变化。

Slicer and timeline data, filtering, and Facade APIs for Univer Sheets.

TypeScript

import { UniverSheetsSlicerPlugin } from '@univerjs-pro/sheets-slicer'import '@univerjs-pro/sheets-slicer/facade'univer.registerPlugin(UniverSheetsSlicerPlugin)

For interactive controls, also register @univerjs-pro/sheets-slicer-ui. See the slicer guide for the required Sheets, drawing, Table, and PivotTable setup.

Entry Points

Facade: @univerjs-pro/sheets-slicer/facade

IUniverSheetsSlicerConfig

TypeScript

export interface IUniverSheetsSlicerConfig {  notExecuteFormula?: boolean  maxMemberWindowSize?: number}

notExecuteFormula is true on the main thread and false in the calculation Worker. Omit it when calculation and UI run in the same Univer instance.

maxMemberWindowSize limits the number of members returned by a query window. It defaults to 200 and must be a positive integer.

Facade API

FSheetSlicer and FSheetTimeline manage existing controls.
FSheetSlicerBuilder and FSheetTimelineBuilder configure new controls.

ISlicerSourceMetadata describes the source field and its readiness. It contains fieldId, name, ready, and optional timeline bounds and interaction state.

你觉得这篇文档如何？