@univerjs-pro/engine-pivot 0.21.1 → 0.22.0-insiders.20260513-09bbeca

package/README.md

@@ -1,57 +1,34 @@
 # @univerjs-pro/engine-pivot
 
-[![npm version](https://img.shields.io/npm/v/@univerjs-pro/engine-pivot)](https://npmjs.org/packages/@univerjs-pro/engine-pivot)
-[![license](https://img.shields.io/npm/l/@univerjs-pro/engine-pivot)](https://img.shields.io/npm/l/@univerjs-pro/engine-pivot)
+[![npm version](https://img.shields.io/npm/v/@univerjs-pro/engine-pivot?style=flat-square)](https://npmjs.com/package/@univerjs-pro/engine-pivot)
+[![downloads](https://img.shields.io/npm/dm/@univerjs-pro/engine-pivot?style=flat-square)](https://npmjs.com/package/@univerjs-pro/engine-pivot)
 
-## Introduction
+`@univerjs-pro/engine-pivot` provides pivot table calculation engine for Univer Pro.
 
-> Pivot table is a powerful data analysis tool that can quickly summarize, organize and analyze large amounts of data, thereby helping users discover patterns and trends in the data. This package contains the analyze logic for univer pivot.
+## Package Overview
 
-- 11 subtotal methods supported like excel
-- Dimension label filtering and sorting (using localCompare method), label value filter.
-- tabular layout
-- expand / collapse
-- Supports multiple value dimensions, and can customize the area (value position) and position (value index) of the multi-value dimension.
-- rename field & format filed
+| Package | UMD global | CSS | Locales | Facade entry |
+| --- | --- | :---: | :---: | :---: |
+| `@univerjs-pro/engine-pivot` | `UniverProEnginePivot` | No | No | No |
 
-More info you can get from link [https://docs.univer.ai/guides/sheets/features/pivot-table#data-source](https://docs.univer.ai/guides/sheets/features/pivot-table#data-source)
+## Installation
 
-> This npm package does not depend on any third-party libraries.
-
-## Usage
-
-We do not recommend using this npm package alone because it is pure calculation logic without any UI. You can use `@univerjs-pro/sheets-pivot` and `@univerjs-pro/sheets-pivot-ui` to get the complete experience, here are the reference links: [https://docs.univer.ai/en-US/guides/sheets/features/pivot-table
-](https://docs.univer.ai/en-US/guides/sheets/features/pivot-table
-) 
-### Installation
-
-```shell
-npm i @univerjs-pro/engine-pivot
+```sh
+pnpm add @univerjs-pro/engine-pivot
+# or
+npm install @univerjs-pro/engine-pivot
 ```
 
-## Performance of Pivot Table
-Test machine spec: a MacBook Pro with Apple Silicon M2 Pro.
+Keep all `@univerjs/*` and `@univerjs-pro/*` packages on the same version.
 
-| Spreadsheet Cells Count                                                 | Read data (s) | Query time (s) |
-| :---------------------------------------------------------------------- | :------------ | :------------- |
-| 500k (1 pivot row dimension, 1 pivot col dimension, 2 value dimensions) | 0.252         | 0.040          |
-| 1M (1 pivot row dimension, 1 pivot col dimension, 2 value dimensions)   | 0.376         | 0.078          |
-| 2M (1 pivot row dimension, 1 pivot col dimension, 2 value dimensions)   | 0.732         | 0.140          |
-| 5M (1 pivot row dimension, 1 pivot col dimension, 2 value dimensions)   | 3.200         | 0.415          |
-
-## Custom Parameters
-
-The following config is global config for pivot engine.
+## Usage
 
-```js
-import {setMaxLimitItemCount, setDateSystem, PivotDateGroupFieldDateSystemEnum, setDefaultSortType} from "@univerjs-pro/engine-pivot"
+```ts
+import { PivotModel, PivotTable } from '@univerjs-pro/engine-pivot';
+```
 
-// use the 1904 date system
-setDateSystem(PivotDateGroupFieldDateSystemEnum.Date1904)
+## Resources
 
-// set the max field items count to 200, this case only use for some data has many no repeated items, the performance is bad and human unreadable
-setMaxLimitItemCount(200)
+- [Documentation](https://docs.univer.ai/guides/pro)
+- [NPM package](https://npmjs.com/package/@univerjs-pro/engine-pivot)
 
-// change the default pivot sort type, if the pivot table not set sort info, it will works as default
-setDefaultSortType('ascending')
-```