# @univerjs-pro/sheets-slicer

- Human documentation: [https://docs.univer.ai/reference/packages/plugins/univerjs-pro/sheets-slicer](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/sheets-slicer)

- Agent Markdown: [https://docs.univer.ai/reference/packages/plugins/univerjs-pro/sheets-slicer.md](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/sheets-slicer.md)

- Requested language: `en-US`

- Content language: `en-US`

- Documentation version: `1.3.0`

- Source: [packages/plugins/univerjs-pro/sheets-slicer.mdx](https://github.com/dream-num/documentation/blob/dev/content/reference/packages/plugins/univerjs-pro/sheets-slicer.mdx)

---

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`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/sheets-slicer-ui.md). See the [slicer guide](https://docs.univer.ai/guides/sheets/features/slicer.md) for the required Sheets, drawing, Table, and PivotTable setup.

## Entry Points

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

## IUniverSheetsSlicerConfig

```ts
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`](https://docs.univer.ai/reference/facade/sheet-slicer.md) and [`FSheetTimeline`](https://docs.univer.ai/reference/facade/sheet-timeline.md) manage existing controls.
- [`FSheetSlicerBuilder`](https://docs.univer.ai/reference/facade/sheet-slicer-builder.md) and [`FSheetTimelineBuilder`](https://docs.univer.ai/reference/facade/sheet-timeline-builder.md) configure new controls.

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