@univerjs-pro/sheets-pivot 0.5.3 → 0.5.4

package/lib/types/const/type.d.ts

@@ -1,6 +1,6 @@
+import { DataField, FieldsCollection, IDataFieldManagerBaseJSON, IFieldsCollectionJSON, ILabelViewHeaderMapItem, IPivotTableChangeSet, IPivotTableFilterInfo, IPivotTableLabelFieldJSON, IPivotTableOptions, IPivotTableSnapshot, IPivotTableSortInfo, IPivotTableValueFieldJSON, IPivotViewInfo, IPivotViewJSON, IPivotViewValueType, PivotCellStyleTypeEnum, PivotDataFieldDataTypeEnum, PivotSubtotalTypeEnum, PivotTableChangeTypeEnum, PivotTableFiledAreaEnum, PivotTableValuePositionEnum, PivotView } from '@univerjs-pro/engine-pivot';
 import { CellValueType, ICellData, IRange, IStyleData, IUndoRedoCommandInfosByInterceptor, IUnitRangeName, Nullable, ObjectMatrix } from '@univerjs/core';
-import { DataField, FieldsCollection, IDataFieldManagerBaseJSON, IFieldsCollectionJSON, ILabelViewHeaderMapItem, IPivotTableChangeSet, IPivotTableFilterInfo, IPivotTableLabelFieldJSON, IPivotTableOptions, IPivotTableSnapshot, IPivotTableSortInfo, IPivotTableValueFieldJSON, IPivotViewInfo, IPivotViewJSON, IPivotViewValueType, PivotCellStyleTypeEnum, PivotDataFieldDataTypeEnum, PivotSubtotalTypeEnum, PivotTableFiledAreaEnum, PivotTableValuePositionEnum, PivotView } from '@univerjs-pro/engine-pivot';
-import { PivotDisplayDataType } from './const';
+import { PivotDisplayDataType, PositionType } from './const';
 export interface IPivotPerformCheckParams {
     cellInfo: IPivotCellPositionInfo;
     view: PivotView;
@@ -194,9 +194,21 @@ export interface IPivotTableMatrixInfo {
     matrix: ObjectMatrix<Nullable<IPivotTableCellData>>;
     oldMatrix?: ObjectMatrix<Nullable<IPivotTableCellData>>;
 }
+/**
+ * The pivot table view change operation type.
+ */
 export declare enum PivotTableOperationEnum {
+    /**
+     *  A pivot table  added to the sheet cells.
+     */
     Add = "add",
+    /**
+     * A pivot table updated in the sheet cells, maybe the range of the pivot table changed or the values of the pivot table cell changed.
+     */
     Set = "set",
+    /**
+     * A pivot table removed from the sheet cells.
+     */
     Delete = "delete"
 }
 export interface IPivotTableCellData {
@@ -523,3 +535,202 @@ export interface IUpdateInfo {
         dataField: DataField;
     }[];
 }
+export interface IPivotViewUpdateInfo {
+    unitId: string;
+    subUnitId: string;
+    pivotTableId: string;
+    rangesCache: IPivotRangesInfo | undefined;
+    valueMatrix: ObjectMatrix<Nullable<IPivotTableCellData>>;
+    type: PivotTableOperationEnum;
+    isEmpty?: boolean;
+}
+interface IPivotTableEventParamsBase {
+    /**
+     * The pivot table id.When create a pivot table, the id maybe undefined.
+     */
+    pivotTableId: string | undefined;
+    /**
+     * The unit id of workbook which the pivot table belongs to.
+     */
+    unitId: string;
+}
+/**
+ * The pivot table added event callback argument.
+ */
+export interface IPivotTableAddedEventParams extends IPivotTableEventParamsBase {
+    /**
+     * @property {PositionType} positionType The position type of the pivot table.
+     */
+    positionType: PositionType;
+    /**
+     * The source range info of the pivot table.
+     */
+    sourceRangeInfo: {
+        /**
+         * @property {number} startRow The start row of the range.
+         */
+        startRow: number;
+        /**
+         * @property {number} endRow The end row of the range.
+         */
+        endRow: number;
+        /**
+         * @property {number} startColumn The start column of the range.
+         */
+        startColumn: number;
+        /**
+         * @property {number} endColumn The end column of the range.
+         */
+        endColumn: number;
+        /**
+         * @property {string} unitId The unit id of workbook which the pivot table source range belongs to.
+         */
+        unitId: string;
+        /**
+         * @property {string} subUnitId The sheet id of workbook which the pivot table source range belongs to.
+         */
+        subUnitId: string;
+        /**
+         * @property {string} sheetName The sheet name of workbook which the pivot table source range belongs to.
+         */
+        sheetName?: string;
+    };
+    /**
+     * The target cell info of the pivot table.Only the PositionType is 'exiting' will have this property.
+     */
+    targetCellInfo?: {
+        /**
+         * @property {number} row The row of the target cell.
+         */
+        row: number;
+        /**
+         * @property {number} col The column of the target cell.
+         */
+        column: number;
+        /**
+         * @property {string} unitId The unit id of workbook which the pivot table target cell belongs to.
+         */
+        unitId: string;
+        /**
+         * @property {string} subUnitId The sheet id of workbook which the pivot table target cell belongs to.
+         */
+        subUnitId: string;
+        /**
+         * @property {string} sheetName The sheet name of workbook which the pivot table target cell belongs to.
+         */
+        sheetName?: string;
+    };
+}
+/**
+ * The pivot table removed event callback argument.
+ */
+export interface IPivotTableRemovedEventParams extends IPivotTableEventParamsBase {
+}
+/**
+ * The pivot table updated event callback argument.
+ */
+export interface IPivotTableUpdatedEventParams extends IPivotTableEventParamsBase {
+    /**
+     * The pivot table change infos, may be a ui drag operation may cause multiple changes.
+     */
+    changes: {
+        /**
+         * @property {PivotTableChangeTypeEnum} changeType The change type of the pivot table.
+         */
+        changeType: PivotTableChangeTypeEnum;
+        /**
+         * The pivot table change info.
+         */
+        changeInfo: IPivotTableChangeSet;
+    }[];
+}
+/**
+ * The pivot table moved event callback argument.
+ */
+export interface IPivotTableMovedEventParams extends IPivotTableEventParamsBase {
+    /**
+     * @property {object} originTargetInfo The origin target info of the pivot table.
+     */
+    originTargetInfo: {
+        /**
+         * @property {string} subUnitId The sheet id of workbook which the pivot table belongs to.
+         */
+        subUnitId: string;
+        /**
+         * @property {string} unitId The unit id of workbook which the pivot table belongs to.
+         */
+        unitId: string;
+        /**
+         * @property {number} row The origin row of the pivot table.
+         */
+        row: number;
+        /**
+         * @property {number} column The origin column of the pivot table.
+         */
+        column: number;
+    };
+    /**
+     * @property {object} targetCellInfo The target cell info of the pivot table.
+     */
+    targetCellInfo: {
+        /**
+         * @property {number} row The row of the target cell.
+         */
+        row: number;
+        /**
+         * @property {number} col The column of the target cell.
+         */
+        column: number;
+        /**
+         * @property {string} unitId The unit id of workbook which the pivot table target cell belongs to.
+         */
+        unitId: string;
+        /**
+         * @property {string} subUnitId The sheet id of workbook which the pivot table target cell belongs to.
+         */
+        subUnitId: string;
+    };
+}
+/**
+ * The pivot table rendered event callback argument.
+ */
+export interface IPivotTableRenderedEventParams extends IPivotTableEventParamsBase {
+    /**
+     * @property {boolean} isEmpty Whether the pivot table is empty.
+     */
+    isEmpty: boolean;
+    /**
+     * @property {string} subUnitId The sheet id of workbook which the pivot table belongs to.
+     */
+    subUnitId: string;
+    /**
+     * @property {changeType} changeType The change type of the pivot table.
+     */
+    changeType: PivotTableOperationEnum;
+    /**
+     * @property {object} rangeInfo The current range info of the pivot table.When the pivot table is empty, the rangeInfo will be undefined.
+     */
+    rangeInfo?: {
+        /**
+         * @property {Array<IRange>} rowRanges The row header ranges of the pivot table.
+         */
+        rowRanges: IRange[];
+        /**
+         * @property {Array<IRange>} colRanges The column header ranges of the pivot table.
+         */
+        colRanges: IRange[];
+        /**
+         * @property {Array<IRange>} cornerRanges The cross range of the pivot table row and column header in the left&top.
+         */
+        cornerRanges: IRange[];
+        /**
+         * @property {Array<IRange>} dataRanges The data ranges of the pivot table.Which is the main data of the pivot table.
+         */
+        dataRanges: IRange[];
+        /**
+         * @property {Array<IRange>} pageRanges The page ranges of the pivot table.Which match the pivot table filters area.In excel it is the page field.
+         */
+        pageRanges: IRange[];
+    };
+}
+export {};

package/lib/types/controllers/const.d.ts

@@ -1 +1 @@
-export declare const getLsInfoFuncStr = "KTpnvVIp LanYM9vVIp(HVnapCa, 9TXHVnjaM) {    vYM {        nIpCv HVnapCacpKIemYvZYYmM = HVnapCa.C9HVv('-');        nIpCv IYV3VpoaCCm3a = NWrF.9mYCa(mvIX(HVnapCacpKIemYvZYYmM[B]));        VK (!IYV3VpoaCCm3a.TL) {            IYV3VpoaCCm3a.TL = FTkXaY(HVnapCacpKIemYvZYYmM[R]);        }        nIpCv VCwIYgaY = vM9aIK wIYgaYdHIXmHWnI9a !== 'TpLaKVpaL' && CaHK VpCvmpnaIK wIYgaYdHIXmHWnI9a;        nIpCv nIpvaSv = VCwIYgaY ? CaHK : lVpLIl;        nIpCv kaCCm3awIYL = nIpvaSv.__umCaOR__.9mYCa(HVnapCacpKIemYvZYYmM[B]);        nIpCv kaCCm3a = nIpvaSv.__haS__.CvYVp3VKM(kaCCm3awIYL);        nIpCv CV3pmvTYawIYL = nIpvaSv.__umCaOR__.9mYCa(HVnapCacpKIemYvZYYmM[s]);        nIpCv CV3pmvTYa = nIpvaSv.__haS__.CvYVp3VKM(CV3pmvTYawIYL);        nIpCv CV3pJmHVL = nIpvaSv.__baYVKM__(CV3pmvTYa, kaCCm3a, 9TXHVnjaM);        nIpCv LIkmVp = IYV3VpoaCCm3a.Lk;        KTpnvVIp VCEIkmVpomvn6Vp3(IemvvaYp, IhICv) {            nIpCv 9mvvaYp = IemvvaYp.Ya9Hmna(/^.+/, '');            nIpCv 6ICv = IhICv.Ya9Hmna(/^.+/, '');            nIpCv 9mvvaYpemYvC = 9mvvaYp.C9HVv('.');            nIpCv 6ICvemYvC = 6ICv.C9HVv('.');            VK (!9mvvaYp.VpnHTLaC('*')) {                YavTYp 9mvvaYp === 6ICv;            }            VK (9mvvaYpemYvC.Hap3v6 < B || 9mvvaYpemYvC[z] !== '*') {                YavTYp KmHCa;            }            nIpCv 9mvvaYpWTKKVS = 9mvvaYpemYvC.CHVna(A).0IVp('.');            nIpCv 6ICvWTKKVS = 6ICvemYvC.CHVna(-9mvvaYpemYvC.Hap3v6 + A).0IVp('.');            YavTYp 9mvvaYpWTKKVS === 6ICvWTKKVS;        }        Hav LIkmVpJmHVL = (LIkmVp && LIkmVp.Hap3v6) ? LIkmVp.CIka((Lkcvak) => VCEIkmVpomvn6Vp3(Lkcvak, HInmvVIp.6ICvpmka)) : vYTa;        VK (HInmvVIp.6ICvpmka === 'HInmH6ICv') {            LIkmVpJmHVL = vYTa;        }        nIpCv bmHVL = CV3pJmHVL && LIkmVpJmHVL;        YavTYp {            bmHVL, kaCCm3a: IYV3VpoaCCm3a,        };    } nmvn6 (aYYIY) {        YavTYp {            bmHVL: KmHCa, kaCCm3a: {},        };    }}";
+export declare const getLsInfoFuncStr = "fU51j965 V31MJWj965(a9135L3, WUxa91K3J) {    jMJ {        165Lj a9135L3I5f6vrMjgMMrJ = a9135L3.LWa9j('-');        165Lj 6M9A95d3LLrA3 = OZbD.WrML3(rj6x(a9135L3I5f6vrMjgMMrJ[s]));        9f (!6M9A95d3LLrA3.UV) {            6M9A95d3LLrA3.UV = DUhx3M(a9135L3I5f6vrMjgMMrJ[C]);        }        165Lj 9Ll6M83M = jJW36f l6M83MRa6xraZ16W3 !== 'U5V3f953V' && L3af 95Ljr5136f l6M83MRa6xraZ16W3;        165Lj 165j3Nj = 9Ll6M83M ? L3af : u95V6u;        165Lj h3LLrA3l6MV = 165j3Nj.__HrL3GC__.WrML3(a9135L3I5f6vrMjgMMrJ[s]);        165Lj h3LLrA3 = 165j3Nj.__73N__.LjM95A9fJ(h3LLrA3l6MV);        165Lj L9A5rjUM3l6MV = 165j3Nj.__HrL3GC__.WrML3(a9135L3I5f6vrMjgMMrJ[F]);        165Lj L9A5rjUM3 = 165j3Nj.__73N__.LjM95A9fJ(L9A5rjUM3l6MV);        165Lj L9A5era9V = 165j3Nj.__i3M9fJ__(L9A5rjUM3, h3LLrA3, WUxa91K3J);        165Lj V6hr95 = 6M9A95d3LLrA3.Vh;        fU51j965 9L06hr95drj1P95A(6vrjj3M5, 676Lj) {            165Lj Wrjj3M5 = 6vrjj3M5.M3War13(/^.+/, '');            165Lj P6Lj = 676Lj.M3War13(/^.+/, '');            165Lj Wrjj3M5vrMjL = Wrjj3M5.LWa9j('.');            165Lj P6LjvrMjL = P6Lj.LWa9j('.');            9f (!Wrjj3M5.951aUV3L('*')) {                M3jUM5 Wrjj3M5 === P6Lj;            }            9f (Wrjj3M5vrMjL.a35AjP < s || Wrjj3M5vrMjL[T] !== '*') {                M3jUM5 fraL3;            }            165Lj Wrjj3M5ZUff9N = Wrjj3M5vrMjL.La913(w).B695('.');            165Lj P6LjZUff9N = P6LjvrMjL.La913(-Wrjj3M5vrMjL.a35AjP + w).B695('.');            M3jUM5 Wrjj3M5ZUff9N === P6LjZUff9N;        }        a3j V6hr95era9V = (V6hr95 && V6hr95.a35AjP) ? V6hr95.L6h3((VhIj3h) => 9L06hr95drj1P95A(VhIj3h, a61rj965.P6Lj5rh3)) : jMU3;        9f (a61rj965.P6Lj5rh3 === 'a61raP6Lj') {            V6hr95era9V = jMU3;        }        165Lj ira9V = L9A5era9V && V6hr95era9V;        M3jUM5 {            ira9V, h3LLrA3: 6M9A95d3LLrA3,        };    } 1rj1P (3MM6M) {        M3jUM5 {            ira9V: fraL3, h3LLrA3: {},        };    }}";

package/lib/types/facade/f-enum.d.ts

@@ -0,0 +1,50 @@
+import { PivotDataFieldDataTypeEnum, PivotDataFieldSortOperatorEnum, PivotDataFieldSortTypeEnum, PivotFilterTypeEnum, PivotSubtotalTypeEnum, PivotTableChangeTypeEnum, PivotTableFiledAreaEnum, PivotTableValuePositionEnum, ST_PivotFilterOperatorEnum } from '@univerjs-pro/engine-pivot';
+import { PositionType } from '@univerjs-pro/sheets-pivot';
+export interface IPivotEnumMixin {
+    /**
+     * Represents the subtotal type of the pivot table. {@link PivotSubtotalTypeEnum}
+     */
+    PivotSubtotalTypeEnum: typeof PivotSubtotalTypeEnum;
+    /**
+     * Represents the filter type of the pivot table. {@link PivotFilterTypeEnum}
+     */
+    PivotFilterTypeEnum: typeof PivotFilterTypeEnum;
+    /**
+     * Represents the field area of the pivot table. {@link PivotTableFiledAreaEnum}
+     */
+    PivotTableFiledAreaEnum: typeof PivotTableFiledAreaEnum;
+    /**
+     * Represents the value position of the pivot table. {@link PivotTableValuePositionEnum}
+     * @description In excel pivot table, the value position can be placed in the row, column area, but only there are more than one value field it will be placed.
+     */
+    PivotTableValuePositionEnum: typeof PivotTableValuePositionEnum;
+    /**
+     * Represents the data type of the pivot data field. {@link PivotDataFieldDataTypeEnum}
+     * @description This is enum is used to specify the data type of the pivot source field.
+     */
+    PivotDataFieldDataTypeEnum: typeof PivotDataFieldDataTypeEnum;
+    /**
+     * Represents the sort type of the pivot data field. {@link PivotDataFieldSortTypeEnum}
+     */
+    PivotDataFieldSortTypeEnum: typeof PivotDataFieldSortTypeEnum;
+    /**
+     * Represents the sort operator of the pivot data field. {@link PivotDataFieldSortOperatorEnum}
+     */
+    PivotDataFieldSortOperatorEnum: typeof PivotDataFieldSortOperatorEnum;
+    /**
+     * Represents the filter operator of the pivot filter. {@link ST_PivotFilterOperatorEnum}
+     */
+    PivotFilterOperatorEnum: typeof ST_PivotFilterOperatorEnum;
+    /**
+     * Represents the position type of the pivot table. {@link PositionType}
+     */
+    PositionTypeEnum: typeof PositionType;
+    /**
+     * Represents the change type of the pivot table. {@link PivotTableChangeTypeEnum}
+     */
+    PivotTableChangeTypeEnum: typeof PivotTableChangeTypeEnum;
+}
+declare module '@univerjs/core' {
+    interface FEnum extends IPivotEnumMixin {
+    }
+}

package/lib/types/facade/f-event.d.ts

@@ -0,0 +1,276 @@
+import { IAddPivotFieldCommandParams, IMovePivotFieldCommandParams, IPivotTableAddedEventParams, IPivotTableMovedEventParams, IPivotTableRemovedEventParams, IPivotTableRenderedEventParams, IRemovePivotFieldCommandParams, ISetPivotCollapseCommandParams, ISetPivotFilterCommandParams, ISetPivotSortCommandParams, IUpdatePivotFieldSettingCommandParams, IUpdatePivotValuePositionCommandParams } from '@univerjs-pro/sheets-pivot';
+import { IEventBase, FEventName } from '@univerjs/core';
+interface IPivotTableEventMixin {
+    /**
+     * The before pivot table add event.The event parameter is {@link IPivotTableAddedEventParams}
+     * @example
+     * ```typescript
+     * univerAPI.addEvent(univerAPI.Event.BeforePivotTableAdd, (params) => {
+     *     const { positionType, targetCellInfo } = params;
+     *     if (positionType === univerAPI.Enum.PositionTypeEnum.Existing && targetCellInfo.sheetName === 'Sheet 1') {
+     *         params.cancel = true;
+     *         console.log(`The pivot table can't be added to the sheet ${targetCellInfo.sheetName}`);
+     *     }
+     * });
+     * ```
+     */
+    readonly BeforePivotTableAdd: 'BeforePivotTableAdd';
+    /**
+     * The pivot table added event.The event parameter is {@link IPivotTableAddedEventParams}
+     * @example
+     * ```typescript
+     * univerAPI.addEvent(univerAPI.Event.PivotTableAdded, (params) => {
+     *     const { positionType, targetCellInfo } = params;
+     *     if (positionType === univerAPI.Enum.PositionTypeEnum.Existing) {
+     *         console.log('A pivot table created in an existing sheet');
+     *         console.log(`The target sheet name is ${targetCellInfo.sheetName}, the target row is ${targetCellInfo.row}, the target column is ${targetCellInfo.column}`);
+     *     } else {
+     *         console.log('A pivot table created in a new sheet');
+     *     }
+     * });
+     * ```
+     */
+    readonly PivotTableAdded: 'PivotTableAdded';
+    /**
+     * The before pivot table moved event.The event parameter is {@link IPivotTableMovedEventParams}
+     * @example
+     * ```typescript
+     * univerAPI.addEvent(univerAPI.Event.BeforePivotTableMove, (params) => {
+     *     const { pivotTableId, targetCellInfo } = params;
+     *     if (pivotTableId === 'pivotTable1' && targetCellInfo.sheetName === 'Sheet 1') {
+     *         params.cancel = true;
+     *         console.log(`The pivot table can't be moved to the sheet ${targetCellInfo.sheetName}`);
+     *     }
+     * });
+     * ```
+     */
+    readonly BeforePivotTableMove: 'BeforePivotTableMove';
+    /**
+     * The pivot table moved event. The event parameter is {@link IPivotTableMovedEventParams}
+     * @example
+     * ```typescript
+     * univerAPI.addEvent(univerAPI.Event.PivotTableMoved, (params) => {
+     *     const { pivotTableId, targetCellInfo, originTargetInfo } = params;
+     *     if (pivotTableId === 'pivotTable1') {
+     *         console.log(`The pivot table moved from row: ${originTargetInfo.row} & column: ${originTargetInfo.column} to the sheet ${targetCellInfo.sheetName} row: ${targetCellInfo.row} & column: ${targetCellInfo.column}`);
+     *     }
+     * });
+     * ```
+     */
+    readonly PivotTableMoved: 'PivotTableMoved';
+    /**
+     * The pivot table calculated done and fill the value to worksheet, the event parameter is {@link IPivotTableRenderedEventParams}
+     * @example
+     * ```typescript
+     * // import { unionPivotViewRange } from '@univerjs-pro/sheets-pivot';
+     * univerAPI.addEvent(univerAPI.Event.PivotTableRendered, (params) => {
+     *     const { pivotTableId, rangeInfo } = params;
+     *     console.log(`The pivot table ${pivotTableId} has been rendered`);
+     *     if (rangeInfo) {
+     *         console.log(unionPivotViewRange(rangeInfo));
+     *     }
+     * });
+     * ```
+     */
+    readonly PivotTableRendered: 'PivotTableRendered';
+    /**
+     * The pivot table removed event. The event parameter is {@link IPivotTableRemovedEventParams}
+     * @example
+     * ```typescript
+     * univerAPI.addEvent(univerAPI.Event.PivotTableRemoved, (params) => {
+     *    const { pivotTableId } = params;
+     *    console.log(`The pivot table ${pivotTableId} has been removed`);
+     * });
+     */
+    readonly PivotTableRemoved: 'PivotTableRemoved';
+    /**
+     * The pivot table field added event. The event parameter is {@link IAddPivotFieldCommandParams}
+     * @example
+     * ```typescript
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * univerAPI.addEvent(univerAPI.Event.PivotTableFieldAdded, (params) => {
+     *    const { pivotTableId, fieldId, fieldArea, fieldIndex } = params;
+     *    const pivotTable = fWorkbook.getPivotTableById(pivotTableId);
+     *    const fieldSetting = pivotTable.getFieldSetting('fieldId');
+     *    console.log(fieldSetting);
+     * ```
+     */
+    readonly PivotTableFieldAdded: 'PivotTableFieldAdded';
+    /**
+     * The pivot table field removed event. The event parameter is {@link IRemovePivotFieldCommandParams}
+     * @example
+     * ```typescript
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * univerAPI.addEvent(univerAPI.Event.PivotTableFieldRemoved, (params) => {
+     *     const { pivotTableId, fieldId } = params;
+     *     const pivotTable = fWorkbook.getPivotTableById(pivotTableId);
+     *     const fieldSetting = pivotTable.getFieldSetting(fieldId);
+     *     console.log(fieldSetting);
+     * });
+     * ```
+     */
+    readonly PivotTableFieldRemoved: 'PivotTableFieldRemoved';
+    /**
+     * The pivot table field moved event. The event parameter is {@link IMovePivotFieldCommandParams}
+     * @example
+     * ```typescript
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * univerAPI.addEvent(univerAPI.Event.PivotTableFieldMoved, (params) => {
+     *    const { pivotTableId, fieldId, fieldArea, fieldIndex } = params;
+     *   const pivotTable = fWorkbook.getPivotTableById(pivotTableId);
+     *   const fieldSetting = pivotTable.getFieldSetting(fieldId);
+     *   console.log(`The source name ${fieldSetting.sourceName} the display name ${fieldSetting.displayName}`);
+     * });
+     * ```
+     */
+    readonly PivotTableFieldMoved: 'PivotTableFieldMoved';
+    /**
+     * The pivot table field collapse changed event. The event parameter is {@link ISetPivotCollapseCommandParams}
+     * @example
+     * ```typescript
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * univerAPI.addEvent(univerAPI.Event.PivotTableFieldCollapseChanged, (params) => {
+     *   const { pivotTableId, fieldId, isCollapsed } = params;
+     *   const pivotTable = fWorkbook.getPivotTableById(pivotTableId);
+     *   const fieldSetting = pivotTable.getFieldSetting(fieldId);
+     *   console.log(`The source name ${fieldSetting.sourceName} the display name ${fieldSetting.displayName}`);
+     * });
+     */
+    readonly PivotTableFieldCollapseChanged: 'PivotTableFieldCollapseChanged';
+    /**
+     * The pivot table field filter changed event. The event parameter is {@link ISetPivotFilterCommandParams}
+     * @example
+     * ```typescript
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * univerAPI.addEvent(univerAPI.Event.PivotTableFieldFilterChanged, (params) => {
+     *     const { pivotTableId, fieldId, filter } = params;
+     *     const pivotTable = fWorkbook.getPivotTableById(pivotTableId);
+     *     const fieldSetting = pivotTable.getFieldSetting(fieldId);
+     *     console.log(`The Checklist filter value is ${fieldSetting.filterInfo.checklist}`);
+     * });
+     * ```
+     */
+    readonly PivotTableFieldFilterChanged: 'PivotTableFieldFilterChanged';
+    /**
+     * The pivot table field sort changed event. The event parameter is {@link ISetPivotSortCommandParams}
+     * @example
+     * ```typescript
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * univerAPI.addEvent(univerAPI.Event.PivotTableFieldSortChanged, (params) => {
+     *    const { pivotTableId, fieldId, sort } = params;
+     *    const pivotTable = fWorkbook.getPivotTableById(pivotTableId);
+     *    const fieldSetting = pivotTable.getFieldSetting(fieldId);
+     *    console.log(`The sort info is ${fieldSetting.sortInfo}`);
+     * });
+     * ```
+     */
+    readonly PivotTableFieldSortChanged: 'PivotTableFieldSortChanged';
+    /**
+     * The pivot table field setting changed event. The event parameter is {@link IUpdatePivotFieldSettingCommandParams}
+     * @example
+     * ```typescript
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * univerAPI.addEvent(univerAPI.Event.PivotTableFieldSettingChanged, (params) => {
+     *     const { pivotTableId, fieldId, setting } = params;
+     *     const pivotTable = fWorkbook.getPivotTableById(pivotTableId);
+     *     const fieldSetting = pivotTable.getFieldSetting(fieldId);
+     *     console.log(`The source name ${fieldSetting.sourceName} the display name ${fieldSetting.displayName}`);
+     * });
+     * ```
+     */
+    readonly PivotTableFieldSettingChanged: 'PivotTableFieldSettingChanged';
+    /**
+     * The pivot table value position changed event. The event parameter is {@link IUpdatePivotValuePositionCommandParams}
+     * @example
+     * ```typescript
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * univerAPI.addEvent(univerAPI.Event.PivotTableValuePositionChanged, (params) => {
+     *     const { pivotTableId, valueId, position } = params;
+     *     const pivotTable = fWorkbook.getPivotTableById(pivotTableId);
+     *     const valueSetting = pivotTable.getValueSetting(valueId);
+     *     console.log(`The source name ${valueSetting.sourceName} the display name ${valueSetting.displayName}`);
+     * });
+     * ```
+     */
+    readonly PivotTableValuePositionChanged: 'PivotTableValuePositionChanged';
+}
+export interface IPivotTableEventParamConfig {
+    /**
+     * The event parameter for the PivotTableAdded event.  {@link IPivotTableAddedEventParams}
+     */
+    PivotTableAdded: IPivotTableAddedEventParams & IEventBase;
+    /**
+     * The event parameter for the BeforePivotTableAdd event. {@link IPivotTableAddedEventParams}
+     */
+    BeforePivotTableAdd: IPivotTableAddedEventParams & IEventBase;
+    /**
+     * The event parameter for the BeforePivotTableMove event. {@link IPivotTableMovedEventParams}
+     */
+    BeforePivotTableMove: IPivotTableMovedEventParams & IEventBase;
+    /**
+     * The event parameter for the PivotTableMoved event. {@link IPivotTableMovedEventParams}
+     */
+    PivotTableMoved: IPivotTableMovedEventParams & IEventBase;
+    /**
+     * The event parameter for the PivotTableRendered event. {@link IPivotTableRenderedEventParams}
+     */
+    PivotTableRendered: IPivotTableRenderedEventParams & IEventBase;
+    /**
+     * The event parameter for the PivotTableRemoved event. {@link IPivotTableRemovedEventParams}
+     */
+    PivotTableRemoved: IPivotTableRemovedEventParams & IEventBase;
+    /**
+     * The event parameter for the PivotTableFieldAdded event. {@link IAddPivotFieldCommandParams}
+     */
+    PivotTableFieldAdded: IAddPivotFieldCommandParams & IEventBase;
+    /**
+     * The event parameter for the PivotTableFieldRemoved event. {@link IRemovePivotFieldCommandParams}
+     */
+    PivotTableFieldRemoved: IRemovePivotFieldCommandParams & IEventBase;
+    /**
+     * The event parameter for the PivotTableFieldMoved event. {@link IMovePivotFieldCommandParams}
+     */
+    PivotTableFieldMoved: IMovePivotFieldCommandParams & IEventBase;
+    /**
+     * The event parameter for the PivotTableFieldCollapseChanged event. {@link ISetPivotCollapseCommandParams}
+     */
+    PivotTableFieldCollapseChanged: ISetPivotCollapseCommandParams & IEventBase;
+    /**
+     * The event parameter for the PivotTableFieldFilterChanged event. {@link ISetPivotFilterCommandParams}
+     */
+    PivotTableFieldFilterChanged: ISetPivotFilterCommandParams & IEventBase;
+    /**
+     * The event parameter for the PivotTableFieldSortChanged event. {@link ISetPivotSortCommandParams}
+     */
+    PivotTableFieldSortChanged: ISetPivotSortCommandParams & IEventBase;
+    /**
+     * The event parameter for the PivotTableFieldSettingChanged event. {@link IUpdatePivotFieldSettingCommandParams}
+     */
+    PivotTableFieldSettingChanged: IUpdatePivotFieldSettingCommandParams & IEventBase;
+    /**
+     * The event parameter for the PivotTableValuePositionChanged event. {@link IUpdatePivotValuePositionCommand
+     */
+    PivotTableValuePositionChanged: IUpdatePivotValuePositionCommandParams & IEventBase;
+}
+export declare class FPivotTableEvent extends FEventName implements IPivotTableEventMixin {
+    get PivotTableAdded(): 'PivotTableAdded';
+    get BeforePivotTableAdd(): 'BeforePivotTableAdd';
+    get PivotTableRemoved(): 'PivotTableRemoved';
+    get PivotTableMoved(): 'PivotTableMoved';
+    get PivotTableRendered(): 'PivotTableRendered';
+    get PivotTableFieldAdded(): 'PivotTableFieldAdded';
+    get PivotTableFieldRemoved(): 'PivotTableFieldRemoved';
+    get PivotTableFieldMoved(): 'PivotTableFieldMoved';
+    get PivotTableFieldCollapseChanged(): 'PivotTableFieldCollapseChanged';
+    get PivotTableFieldFilterChanged(): 'PivotTableFieldFilterChanged';
+    get PivotTableFieldSortChanged(): 'PivotTableFieldSortChanged';
+    get PivotTableFieldSettingChanged(): 'PivotTableFieldSettingChanged';
+    get PivotTableValuePositionChanged(): 'PivotTableValuePositionChanged';
+}
+declare module '@univerjs/core' {
+    interface FEventName extends IPivotTableEventMixin {
+    }
+    interface IEventParamConfig extends IPivotTableEventParamConfig {
+    }
+}
+export {};