API Reference

@univerjs-pro/engine-pivot

Pivot table calculation model and field utilities for Web SDK.

TypeScript
import { PivotTable } from '@univerjs-pro/engine-pivot'

Filter utilities

compilePivotDateFilter(filter) accepts an IPivotTableCustomFilter and returns a predicate over numeric date serials. Use isPivotDateFilter(filter) to identify fixed date conditions. useWholeDay: true compares floored day serials; otherwise fractional time is retained. Between conditions include both bounds. Invalid operators or operands throw, and non-finite candidate serials do not match.

hasPivotMultipleFilters(snapshot) checks whether the same source field has more than one active filter category, including copies of that field in the report. PivotFilterCategory distinguishes member, condition, and value filters. Use the Pivot Table Facade to configure reports and resolve conflicts when disabling multiple filters.

How is this guide?

© 2026 DreamNum Co., Ltd.