@univerjs-pro/sheets-pivot 0.2.9 → 0.2.11

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

@@ -2,6 +2,7 @@ import { IPivotViewCellData, IPivotViewValueType, PivotView, PivotViewItem } fro
 import { Injector, IRange } from '@univerjs/core';
 import { default as zhCN } from '../locale/zh-CN';
 import { IAdjustPivotTableRes, IPivotTableConfig, IThemeStyle } from './type';
+export declare const PIVOT_ICON_OFFSET = 16;
 export declare const SHEET_PIVOT_TABLE_PLUGIN = "SHEET_PIVOT_TABLE_PLUGIN";
 export declare const BLANK_ROW_COUNT = 1;
 export declare const BLANK_COL_COUNT = 1;
@@ -49,7 +50,7 @@ export declare function transformErrorValue(value: IPivotViewValueType): string
 export declare function getAdjustRangesPosition(startCell: {
     row: number;
     col: number;
-}, view: PivotViewItem, singleCellIsRange?: boolean, useLast?: boolean): IRange[];
+}, view: PivotViewItem, singleCellIsRange?: boolean, useLastRowOrCol?: boolean): IRange[];
 export declare const SHEET_PIVOT_IN_MAIN_THREAD = "SHEET_PIVOT_IN_MAIN_THREAD";
 export declare enum PivotDisplayDataType {
     Filter = "filter",

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

@@ -1,4 +1,4 @@
-import { 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 { 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 { CellValueType, ICellData, IRange, IStyleData, IUnitRangeName, Nullable, ObjectMatrix } from '@univerjs/core';
 import { PivotDisplayDataType, PositionType } from './const';
 export interface IPivotTableConfigChangeInfo {
@@ -501,3 +501,10 @@ export interface IAddPivotTableWithConfigCommandParams {
         values?: IValueFieldConfig[];
     };
 }
+export interface IUpdateInfo {
+    collection: FieldsCollection;
+    updateDataFieldList: {
+        index: number;
+        dataField: DataField;
+    }[];
+}

package/lib/types/models/sheets-pivot-config-model.d.ts

@@ -1,5 +1,6 @@
 import { Nullable, ObjectMatrix, Disposable, ICommandService, Injector, IUniverInstanceService } from '@univerjs/core';
-import { IDataFieldManagerJSON, IPivotRangesInfo, IPivotTableCellData, IPivotTableConfig, IPivotTableMatrixInfo, IPivotTableRangeInfo } from '../const/type';
+import { IFieldsCollectionJSON } from '@univerjs-pro/engine-pivot';
+import { IDataFieldManagerJSON, IPivotCellPositionInfo, IPivotRangesInfo, IPivotTableCellData, IPivotTableConfig, IPivotTableMatrixInfo, IPivotTableRangeInfo } from '../const/type';
 export declare class SheetsPivotTableConfigModel extends Disposable {
     private _injector;
     private _commandService;
@@ -26,11 +27,11 @@ export declare class SheetsPivotTableConfigModel extends Disposable {
     private _initLocale;
     getTextInfo(): Record<string, string>;
     updateViewInfo(unitId: string, subUnitId: string, pivotTableId: string, valueMatrix: ObjectMatrix<Nullable<IPivotTableCellData>>, rangesCache: IPivotRangesInfo | undefined): void;
-    getPivotTableConfig(unitId: string, subUnitId: string, pivotTableId: string): IPivotTableConfig | undefined;
-    getTargetByPivotId(unitId: string, subUnitId: string, pivotTableId: string): import('../const/type').IPivotCellPositionInfo | undefined;
+    getPivotTableConfig(unitId: string, subUnitId: string, pivotTableId: string): Nullable<IPivotTableConfig>;
+    getTargetByPivotId(unitId: string, subUnitId: string, pivotTableId: string): Nullable<IPivotCellPositionInfo>;
     getSubUnitPivotConfigs(unitId: string, subUnitId: string): Map<string, IPivotTableConfig> | undefined;
     updateConfigCache(unitId: string, subUnitId: string, pivotTableId: string, pivotTableConfig: Nullable<IPivotTableConfig>): void;
-    getCollection(unitId: string, pivotTableId: string): import('@univerjs-pro/engine-pivot').IFieldsCollectionJSON | undefined;
+    getCollection(unitId: string, pivotTableId: string): IFieldsCollectionJSON | undefined;
     updateCollectionConfig(unitId: string, collectionConfig: IDataFieldManagerJSON): void;
     private _ensurePivotMap;
     private _ensurePivotTableRangeInfo;
@@ -42,7 +43,7 @@ export declare class SheetsPivotTableConfigModel extends Disposable {
      * @param {string} unitId - the unit id
      * @param {string} subUnitId - the sub unit id
      * @param {string} pivotTableId - the pivot table id
-     * @returns {IPivotRangesInfo} - the pivot table range info
+     * @returns {IPivotTableRangeInfo} - the pivot table range info
      */
     getPivotTableRangeInfo(unitId: string, subUnitId: string, pivotTableId: string): IPivotTableRangeInfo | undefined;
     /**

package/lib/types/models/sheets-pivot-data-field-manager.d.ts

@@ -1,7 +1,7 @@
 import { ICellData, IRange, IUnitRangeName, IUniverInstanceService, Nullable, ObjectMatrix, Styles, Worksheet } from '@univerjs/core';
-import { IDataFieldValue, IFieldsCollectionJSON, DataField, DataFieldManager, FieldsCollection } from '@univerjs-pro/engine-pivot';
+import { IDataFieldValue, IFieldsCollectionJSON, PivotSubtotalTypeEnum, DataField, DataFieldManager, FieldsCollection } from '@univerjs-pro/engine-pivot';
 import { IRuntimeUnitDataType } from '@univerjs/engine-formula';
-import { ICurrentDataMatrix, IDataFieldManagerJSON, IPivotCellPositionInfo, IUnitRangeNameWithSubUnitId } from '../const/type';
+import { ICurrentDataMatrix, IDataFieldManagerJSON, IPivotCellPositionInfo, IUnitRangeNameWithSubUnitId, IUpdateInfo } from '../const/type';
 import { SheetsPivotDataSourceModel } from './sheets-pivot-data-source-model';
 interface IFeatureDirtyRangeType {
     [unitId: string]: Nullable<{
@@ -17,38 +17,21 @@ export declare class SheetsPivotDataFieldManager extends DataFieldManager {
     _host: SheetsPivotDataSourceModel;
     constructor(host: SheetsPivotDataSourceModel, univerInstanceService: IUniverInstanceService);
     initDataRanges(): void;
-    getAutoDisplayNameFunction(): (baseName: string, subtotalType: import('@univerjs-pro/engine-pivot').PivotSubtotalTypeEnum) => string;
+    getAutoDisplayNameFunction(): (baseName: string, subtotalType: PivotSubtotalTypeEnum) => string;
     deleteDataField(dataFieldId: string): void;
     removeCollectionImp(token: string): void;
     getRangeKey(rangeInfo: IUnitRangeName, colIndex: number): string;
-    getDataFieldByRangeKey(rangeKey: string): DataField;
+    getDataFieldByRangeKey(rangeKey: string): DataField | undefined;
     setRangeKeyMap(rangeKey: string, dataFieldId: string): void;
     updateRangeKeyMap(oldRangeKey: string, newRangeKey: string): void;
-    addCollectionByJSON(token: string, collectionJSON: IFieldsCollectionJSON, sourceRangeInfo: IUnitRangeNameWithSubUnitId, targetCellInfo: IPivotCellPositionInfo): {
-        collection: FieldsCollection;
-        updateDataFieldList: {
-            index: number;
-            dataField: DataField;
-        }[];
-    };
-    getRangeStartEndInfo(range: IRange, sheet: Worksheet): {
-        startRow: number;
-        startColumn: number;
-        endRow: number;
-        endColumn: number;
-    };
+    addCollectionByJSON(token: string, collectionJSON: IFieldsCollectionJSON, sourceRangeInfo: IUnitRangeNameWithSubUnitId, targetCellInfo: IPivotCellPositionInfo): IUpdateInfo;
+    getRangeStartEndInfo(range: IRange, sheet: Worksheet): IRange;
     /**
      * - when add pivot table, we should create a collection with data range first
      * @param {IUnitRangeName} dataRangeInfo the data range info
      * @returns {FieldsCollection} the created collection
      */
-    createCollectionWithDataRange(dataRangeInfo: IUnitRangeName): {
-        updateDataFieldList: {
-            index: number;
-            dataField: DataField;
-        }[];
-        collection: FieldsCollection;
-    };
+    createCollectionWithDataRange(dataRangeInfo: IUnitRangeName): IUpdateInfo;
     _getAutoName(colIndex: number): string;
     uniqueDataFieldName(name: IDataFieldValue, colIndex: number): string;
     getCollection(token: string): FieldsCollection;
@@ -69,17 +52,11 @@ export declare class SheetsPivotDataFieldManager extends DataFieldManager {
      * @returns {Nullable<ICellData>} the cell data
      */
     getMatrixValue(matrix: ObjectMatrix<Nullable<ICellData>>, arrayFormulaCellDataMatrix: ObjectMatrix<Nullable<ICellData>> | undefined, unitDataMatrix: ObjectMatrix<Nullable<ICellData>> | undefined, rowIndex: number, colIndex: number): Nullable<ICellData>;
-    refreshDataField(dataFieldId: string, dataRangeInfo: IUnitRangeNameWithSubUnitId, index: number, currentDataMatrix?: ICurrentDataMatrix): {
-        header: never[];
-        data: never[];
-    } | undefined;
+    refreshDataField(dataFieldId: string, dataRangeInfo: IUnitRangeNameWithSubUnitId, index: number, currentDataMatrix?: ICurrentDataMatrix): void;
     refreshData(collection: FieldsCollection, list: {
         index: number;
         dataField: DataField;
-    }[], dataRangeInfo: IUnitRangeName): {
-        header: never[];
-        data: never[];
-    } | undefined;
+    }[], dataRangeInfo: IUnitRangeNameWithSubUnitId): void;
     getRangeKeyList(dataRangeInfo: IUnitRangeName): string[];
     /**
      * - adjust sheet cell value to the type that pivot engine can recognize
@@ -91,7 +68,7 @@ export declare class SheetsPivotDataFieldManager extends DataFieldManager {
     adjustSheetCellData(cellData: Nullable<ICellData>, styles: Styles, patternInfoRecord: Record<string, any>): IDataFieldValue;
     getRangeData(dataRangeInfo: IUnitRangeName): {
         header: (string | null)[];
-        data: (string | number | boolean | import('@univerjs-pro/engine-pivot').IDateValue | null | undefined)[][];
+        data: IDataFieldValue[][];
     };
     toJSON(): IDataFieldManagerJSON;
     fromJSON(jsonData: IDataFieldManagerJSON): void;

package/lib/types/models/sheets-pivot-data-source-model.d.ts

@@ -1,7 +1,7 @@
 import { IUnitRangeName, Nullable, Disposable, ICommandService, IConfigService, Injector, IResourceManagerService, IUniverInstanceService, LifecycleService } from '@univerjs/core';
 import { DataField, FieldsCollection, IFieldsCollectionJSON, IPivotTableSnapshot, PivotView, PivotTable } from '@univerjs-pro/engine-pivot';
 import { IMoveRangeMutationParams } from '@univerjs/sheets';
-import { ICollectionChangeInfo, IDataFieldManagerJSON, IPivotCellPositionInfo, IPivotMutationDirtyViewInfo, IPivotTableConfig, IPivotTableJson, IPivotWorkerItemCache, ISendPivotConfigLocalMutationParams, IUnitRangeNameWithSubUnitId, PivotTableOperationEnum } from '../const/type';
+import { ICollectionChangeInfo, IDataFieldManagerJSON, IPivotCellPositionInfo, IPivotMutationDirtyViewInfo, IPivotTableConfig, IPivotTableJson, IPivotWorkerItemCache, ISendPivotConfigLocalMutationParams, IUnitRangeNameWithSubUnitId, IUpdateInfo, PivotTableOperationEnum } from '../const/type';
 import { SheetsPivotDataFieldManager } from './sheets-pivot-data-field-manager';
 import { IViewTranslateCtx } from './view-util';
 export declare class SheetsPivotDataSourceModel extends Disposable {
@@ -34,32 +34,7 @@ export declare class SheetsPivotDataSourceModel extends Disposable {
      */
     private _queryingMap;
     constructor(_injector: Injector, _univerInstanceService: IUniverInstanceService, _lifecycleService: LifecycleService, _configService: IConfigService, _commandService: ICommandService, _resourceManagerService: IResourceManagerService);
-    getTextInfo(): Record<string, string> | {
-        'sheets-pivot.blankValue': string;
-        'sheets-pivot.columnName': string;
-        'sheets-pivot.subTotalText': string;
-        'sheets-pivot.grandTotalText': string;
-        'sheets-pivot.valueText': string;
-        'sheets-pivot.averageName': string;
-        'sheets-pivot.countName': string;
-        'sheets-pivot.countNumsName': string;
-        'sheets-pivot.maxName': string;
-        'sheets-pivot.minName': string;
-        'sheets-pivot.productName': string;
-        'sheets-pivot.stdDevName': string;
-        'sheets-pivot.stdDevpName': string;
-        'sheets-pivot.sumName': string;
-        'sheets-pivot.varName': string;
-        'sheets-pivot.varpName': string;
-        'sheets-pivot.subTotal': string;
-        'sheets-pivot.grandTotal': string;
-        'sheets-pivot.value': string;
-        'sheets-pivot.blank': string;
-        'sheets-pivot.emptyPivot.filter': string;
-        'sheets-pivot.emptyPivot.row': string;
-        'sheets-pivot.emptyPivot.column': string;
-        'sheets-pivot.emptyPivot.values': string;
-    };
+    getTextInfo(): Record<string, string>;
     setTextInfo(textInfo: Record<string, string>): void;
     handleMoveRange(params: IMoveRangeMutationParams): void;
     broadcastCollectionChange(info: ICollectionChangeInfo): void;
@@ -83,7 +58,7 @@ export declare class SheetsPivotDataSourceModel extends Disposable {
     addPivotTable(unitId: string, subUnitId: string, pivotTableId: string, pivotTable: PivotTable, pivotTableConfig: IPivotTableConfig): void;
     removePivotTable(unitId: string, subUnitId: string, pivotTableId: string): void;
     setPivotTable(unitId: string, subUnitId: string, pivotTableId: string, pivotTableConfig: IPivotTableConfig): void;
-    getPivotTableConfig(unitId: string, subUnitId: string, pivotTableId: string): IPivotTableConfig | null;
+    getPivotTableConfig(unitId: string, subUnitId: string, pivotTableId: string): IPivotTableConfig | undefined;
     /**
      * - get the pivot table model json config
      * @param {string} unitId
@@ -94,27 +69,15 @@ export declare class SheetsPivotDataSourceModel extends Disposable {
     getPivotTableModelConfig(unitId: string, subUnitId: string, pivotTableId: string): IPivotTableSnapshot | undefined;
     getPivotTableInstance(pivotTableId: string): PivotTable | undefined;
     deleteUnitId(unitId: string): void;
-    addCollectionByJSON(token: string, collectionJSON: IFieldsCollectionJSON, sourceRangeInfo: IUnitRangeNameWithSubUnitId, targetCellInfo: IPivotCellPositionInfo): {
-        collection: FieldsCollection;
-        updateDataFieldList: {
-            index: number;
-            dataField: DataField;
-        }[];
-    };
+    addCollectionByJSON(token: string, collectionJSON: IFieldsCollectionJSON, sourceRangeInfo: IUnitRangeNameWithSubUnitId, targetCellInfo: IPivotCellPositionInfo): IUpdateInfo;
     /**
      * - this function just create a collection with data range info, but wil not add it to the dataFieldManager
      */
-    createCollectionWithDataRange(dataRangeInfo: IUnitRangeNameWithSubUnitId): {
-        updateDataFieldList: {
-            index: number;
-            dataField: DataField;
-        }[];
-        collection: FieldsCollection;
-    };
+    createCollectionWithDataRange(dataRangeInfo: IUnitRangeNameWithSubUnitId): IUpdateInfo;
     refreshData(collection: FieldsCollection, updateDataFieldList: {
         index: number;
         dataField: DataField;
-    }[], dataRangeInfo: IUnitRangeName): void;
+    }[], dataRangeInfo: IUnitRangeNameWithSubUnitId): void;
     removeDataField(unitId: string, dataFieldId: string): void;
     removeCollections(unitId: string, token: string): void;
     getSubUnitPivotConfigs(unitId: string, subUnitId: string): Map<string, IPivotTableConfig> | undefined;

package/lib/types/models/sheets-pivot-table-adaptor-model.d.ts

@@ -1,4 +1,4 @@
-import { Nullable, Disposable, Injector, IUniverInstanceService, LocaleService, ObjectMatrix } from '@univerjs/core';
+import { IRange, Nullable, Disposable, Injector, IUniverInstanceService, LocaleService, ObjectMatrix } from '@univerjs/core';
 import { IPivotRangesInfo, IPivotRenderCache, IPivotTableCellData, IPivotTableConfigChangeInfo, PivotTableOperationEnum } from '../const/type';
 import { SheetsPivotTableConfigModel } from './sheets-pivot-config-model';
 export declare class SheetsPivotTableAdaptorModel extends Disposable {
@@ -27,16 +27,24 @@ export declare class SheetsPivotTableAdaptorModel extends Disposable {
     private _initUnitDisposed;
     private _initLocale;
     updateRenderCache(config: IPivotTableConfigChangeInfo): {
-        rangeCache: IPivotRangesInfo;
+        rangeCache: IPivotRangesInfo | undefined;
         matrix: ObjectMatrix<Nullable<IPivotTableCellData>>;
     } | undefined;
     clearRenderCache(config: IPivotTableConfigChangeInfo): void;
     private _ensurePivotItemRenderInfoCache;
     private _ensurePivotItemRenderValueMatrixCache;
     getPivotTableCellData(unitId: string, subUnitId: string, row: number, col: number): IPivotTableCellData | undefined;
-    getPivotTableIdByCell(unitId: string, subUnitId: string, row: number, col: number): string | undefined;
+    getPivotTableIdByCell(unitId: string, subUnitId: string, row: number, col: number): Nullable<string>;
+    /**
+     * Get pivot table ids that intersect with the range
+     * @param {string} unitId The test unit id of range
+     * @param {string} subUnitId The sub unit id of range
+     * @param {IRange} range The range to check
+     * @returns {string[]} The pivot table ids that intersect with the range
+     */
+    getIntersectsPivotTable(unitId: string, subUnitId: string, range: IRange): string[];
     getSubUnitPivotMatrix(unitId: string, subUnitId: string): ObjectMatrix<Nullable<IPivotTableCellData>>;
-    getPivotItemRenderInfoCache(unitId: string, subUnitId: string, pivotTableId: string): IPivotRenderCache | undefined;
+    getPivotItemRenderInfoCache(unitId: string, subUnitId: string, pivotTableId: string): Nullable<IPivotRenderCache>;
     deleteUnitId(unitId: string): void;
     markDirty(unitId: string, subUnitId: string): void;
 }