@univerjs-pro/sheets-pivot 1.0.0-alpha.1 → 1.0.0-alpha.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (91) hide show
  1. package/README.md +8 -2
  2. package/lib/cjs/facade.js +1 -1
  3. package/lib/cjs/index.js +1 -1
  4. package/lib/cjs/locale/ar-SA.js +1 -1
  5. package/lib/cjs/locale/ca-ES.js +1 -1
  6. package/lib/cjs/locale/de-DE.js +1 -1
  7. package/lib/cjs/locale/en-US.js +1 -1
  8. package/lib/cjs/locale/es-ES.js +1 -1
  9. package/lib/cjs/locale/fa-IR.js +1 -1
  10. package/lib/cjs/locale/fr-FR.js +1 -1
  11. package/lib/cjs/locale/id-ID.js +1 -1
  12. package/lib/cjs/locale/it-IT.js +1 -1
  13. package/lib/cjs/locale/ja-JP.js +1 -1
  14. package/lib/cjs/locale/ko-KR.js +1 -1
  15. package/lib/cjs/locale/pl-PL.js +1 -1
  16. package/lib/cjs/locale/pt-BR.js +1 -1
  17. package/lib/cjs/locale/ru-RU.js +1 -1
  18. package/lib/cjs/locale/sk-SK.js +1 -1
  19. package/lib/cjs/locale/vi-VN.js +1 -1
  20. package/lib/cjs/locale/zh-CN.js +1 -1
  21. package/lib/cjs/locale/zh-HK.js +1 -1
  22. package/lib/cjs/locale/zh-TW.js +1 -1
  23. package/lib/es/facade.js +1 -1
  24. package/lib/es/index.js +1 -1
  25. package/lib/es/locale/ar-SA.js +1 -1
  26. package/lib/es/locale/ca-ES.js +1 -1
  27. package/lib/es/locale/de-DE.js +1 -1
  28. package/lib/es/locale/en-US.js +1 -1
  29. package/lib/es/locale/es-ES.js +1 -1
  30. package/lib/es/locale/fa-IR.js +1 -1
  31. package/lib/es/locale/fr-FR.js +1 -1
  32. package/lib/es/locale/id-ID.js +1 -1
  33. package/lib/es/locale/it-IT.js +1 -1
  34. package/lib/es/locale/ja-JP.js +1 -1
  35. package/lib/es/locale/ko-KR.js +1 -1
  36. package/lib/es/locale/pl-PL.js +1 -1
  37. package/lib/es/locale/pt-BR.js +1 -1
  38. package/lib/es/locale/ru-RU.js +1 -1
  39. package/lib/es/locale/sk-SK.js +1 -1
  40. package/lib/es/locale/vi-VN.js +1 -1
  41. package/lib/es/locale/zh-CN.js +1 -1
  42. package/lib/es/locale/zh-HK.js +1 -1
  43. package/lib/es/locale/zh-TW.js +1 -1
  44. package/lib/facade.js +1 -1
  45. package/lib/index.js +1 -1
  46. package/lib/locale/ar-SA.js +1 -1
  47. package/lib/locale/ca-ES.js +1 -1
  48. package/lib/locale/de-DE.js +1 -1
  49. package/lib/locale/en-US.js +1 -1
  50. package/lib/locale/es-ES.js +1 -1
  51. package/lib/locale/fa-IR.js +1 -1
  52. package/lib/locale/fr-FR.js +1 -1
  53. package/lib/locale/id-ID.js +1 -1
  54. package/lib/locale/it-IT.js +1 -1
  55. package/lib/locale/ja-JP.js +1 -1
  56. package/lib/locale/ko-KR.js +1 -1
  57. package/lib/locale/pl-PL.js +1 -1
  58. package/lib/locale/pt-BR.js +1 -1
  59. package/lib/locale/ru-RU.js +1 -1
  60. package/lib/locale/sk-SK.js +1 -1
  61. package/lib/locale/vi-VN.js +1 -1
  62. package/lib/locale/zh-CN.js +1 -1
  63. package/lib/locale/zh-HK.js +1 -1
  64. package/lib/locale/zh-TW.js +1 -1
  65. package/lib/types/const/const.d.ts +1 -1
  66. package/lib/types/facade/f-generic-pivot-table.d.ts +2 -2
  67. package/lib/types/facade/f-pivot-table.d.ts +29 -29
  68. package/lib/types/facade/f-workbook.d.ts +2 -2
  69. package/lib/types/index.d.ts +5 -17
  70. package/lib/umd/facade.js +1 -1
  71. package/lib/umd/index.js +1 -1
  72. package/lib/umd/locale/ar-SA.js +1 -1
  73. package/lib/umd/locale/ca-ES.js +1 -1
  74. package/lib/umd/locale/de-DE.js +1 -1
  75. package/lib/umd/locale/en-US.js +1 -1
  76. package/lib/umd/locale/es-ES.js +1 -1
  77. package/lib/umd/locale/fa-IR.js +1 -1
  78. package/lib/umd/locale/fr-FR.js +1 -1
  79. package/lib/umd/locale/id-ID.js +1 -1
  80. package/lib/umd/locale/it-IT.js +1 -1
  81. package/lib/umd/locale/ja-JP.js +1 -1
  82. package/lib/umd/locale/ko-KR.js +1 -1
  83. package/lib/umd/locale/pl-PL.js +1 -1
  84. package/lib/umd/locale/pt-BR.js +1 -1
  85. package/lib/umd/locale/ru-RU.js +1 -1
  86. package/lib/umd/locale/sk-SK.js +1 -1
  87. package/lib/umd/locale/vi-VN.js +1 -1
  88. package/lib/umd/locale/zh-CN.js +1 -1
  89. package/lib/umd/locale/zh-HK.js +1 -1
  90. package/lib/umd/locale/zh-TW.js +1 -1
  91. package/package.json +11 -11
@@ -1 +1 @@
1
- const _0x3343db=_0x156b;function _0x156b(_0xdf8f49,_0x2bc100){_0xdf8f49=_0xdf8f49-0x1ad;const _0x486fa5=_0x486f();let _0x156b46=_0x486fa5[_0xdf8f49];return _0x156b46;}function _0x486f(){const _0x1fd3cc=['計數項:','460798SsuhBD','720540zCinhX','年-月','總體標準差項:','數值計數項:','年-月-日','最小值項:','1285172XURnRU','標準差項:','乘積項:','工作表','{0}\x20{1}','平均值項:','{0}','649443LhKVcf','求和項:','624092zVhjhZ','月-日','方差項:','2258112sbjQvU','{0}-Q{1}','3063380wpYdyo','{0}-{1}-{2}','4wNhUFb','(其他)','{0}-{1}'];_0x486f=function(){return _0x1fd3cc;};return _0x486f();}(function(_0x2c00b6,_0x35daa7){const _0x53c5c6=_0x156b,_0x378acd=_0x2c00b6();while(!![]){try{const _0x463d94=parseInt(_0x53c5c6(0x1ba))/0x1+-parseInt(_0x53c5c6(0x1af))/0x2+-parseInt(_0x53c5c6(0x1ad))/0x3*(parseInt(_0x53c5c6(0x1b6))/0x4)+parseInt(_0x53c5c6(0x1b4))/0x5+parseInt(_0x53c5c6(0x1bb))/0x6+parseInt(_0x53c5c6(0x1c1))/0x7+-parseInt(_0x53c5c6(0x1b2))/0x8;if(_0x463d94===_0x35daa7)break;else _0x378acd['push'](_0x378acd['shift']());}catch(_0x1e7edd){_0x378acd['push'](_0x378acd['shift']());}}}(_0x486f,0x8a461));const e={'sheets-pivot':{'sheet':_0x3343db(0x1c4),'blankValue':'(空白)','otherValue':_0x3343db(0x1b7),'columnName':'欄\x20','subTotalText':'小計','grandTotalText':'總計','valueText':'值','rowLabels':'行標籤','columnLabels':'列標籤','averageName':_0x3343db(0x1c6),'countName':_0x3343db(0x1b9),'countNumsName':_0x3343db(0x1be),'maxName':'最大值項:','minName':_0x3343db(0x1c0),'productName':_0x3343db(0x1c3),'stdDevName':_0x3343db(0x1c2),'stdDevpName':_0x3343db(0x1bd),'sumName':_0x3343db(0x1ae),'varName':_0x3343db(0x1b1),'varpName':'總體方差項:','subTotal':'小計','grandTotal':'總計','value':'值','blank':'空白','other':'其他','renderText':{'valueField':'{0}{1}','subtotal':_0x3343db(0x1c5),'grandTotal':'{0}\x20{1}','multipleGrandTotal':_0x3343db(0x1c7),'subtotalWithValue':_0x3343db(0x1c5)},'emptyPivot':{'filter':'篩選','row':'行','column':'欄','values':'值'},'dateGroup':{'year':'年','month':'月','day':'日','date':'日','hour':'小時','minute':'分鐘','hourMinute':'小時-分鐘','quarter':'季度','monthDate':_0x3343db(0x1b0),'yearQuarter':'年-季度','yearMonth':_0x3343db(0x1bc),'yearMonthDate':_0x3343db(0x1bf)},'cellDateGroupDisplay':{'minute':'{0}','hour':_0x3343db(0x1c7),'hourMinute':'{0}:{1}','date':'{0}','month':_0x3343db(0x1c7),'monthDate':_0x3343db(0x1b8),'quarter':'Q{0}','year':_0x3343db(0x1c7),'yearMonth':_0x3343db(0x1b8),'yearMonthDate':_0x3343db(0x1b5),'yearQuarter':_0x3343db(0x1b3)}}};export{e as default};
1
+ const _0x15bb3e=_0x2e20;(function(_0x2e5034,_0x348153){const _0x17282c=_0x2e20,_0xfb88a5=_0x2e5034();while(!![]){try{const _0x524574=parseInt(_0x17282c(0xd3))/0x1*(-parseInt(_0x17282c(0xe5))/0x2)+-parseInt(_0x17282c(0xcd))/0x3*(parseInt(_0x17282c(0xdd))/0x4)+parseInt(_0x17282c(0xda))/0x5+-parseInt(_0x17282c(0xe4))/0x6+-parseInt(_0x17282c(0xce))/0x7*(parseInt(_0x17282c(0xdf))/0x8)+-parseInt(_0x17282c(0xe8))/0x9*(-parseInt(_0x17282c(0xcc))/0xa)+parseInt(_0x17282c(0xe2))/0xb;if(_0x524574===_0x348153)break;else _0xfb88a5['push'](_0xfb88a5['shift']());}catch(_0x385a0b){_0xfb88a5['push'](_0xfb88a5['shift']());}}}(_0x1e57,0x6866a));function _0x2e20(_0x291b5a,_0x4ab342){_0x291b5a=_0x291b5a-0xca;const _0x1e57ac=_0x1e57();let _0x2e201f=_0x1e57ac[_0x291b5a];return _0x2e201f;}const e={'sheets-pivot':{'sheet':_0x15bb3e(0xe3),'blankValue':'(空白)','otherValue':_0x15bb3e(0xdb),'columnName':'欄\x20','subTotalText':'小計','grandTotalText':'總計','valueText':'值','rowLabels':_0x15bb3e(0xd6),'columnLabels':_0x15bb3e(0xcb),'averageName':_0x15bb3e(0xea),'countName':_0x15bb3e(0xd8),'countNumsName':'數值計數項:','maxName':_0x15bb3e(0xd1),'minName':_0x15bb3e(0xe1),'productName':_0x15bb3e(0xd5),'stdDevName':_0x15bb3e(0xd7),'stdDevpName':'總體標準差項:','sumName':_0x15bb3e(0xd9),'varName':'方差項:','varpName':_0x15bb3e(0xd0),'subTotal':'小計','grandTotal':'總計','value':'值','blank':'空白','other':'其他','renderText':{'valueField':_0x15bb3e(0xd4),'subtotal':_0x15bb3e(0xe7),'grandTotal':_0x15bb3e(0xe7),'multipleGrandTotal':_0x15bb3e(0xdc),'subtotalWithValue':'{0}\x20{1}'},'emptyPivot':{'filter':'篩選','row':'行','column':'欄','values':'值'},'dateGroup':{'year':'年','month':'月','day':'日','date':'日','hour':'小時','minute':'分鐘','hourMinute':'小時-分鐘','quarter':'季度','monthDate':'月-日','yearQuarter':_0x15bb3e(0xe9),'yearMonth':_0x15bb3e(0xe0),'yearMonthDate':_0x15bb3e(0xca)},'cellDateGroupDisplay':{'minute':_0x15bb3e(0xdc),'hour':'{0}','hourMinute':_0x15bb3e(0xde),'date':'{0}','month':_0x15bb3e(0xdc),'monthDate':_0x15bb3e(0xe6),'quarter':_0x15bb3e(0xd2),'year':_0x15bb3e(0xdc),'yearMonth':'{0}-{1}','yearMonthDate':'{0}-{1}-{2}','yearQuarter':_0x15bb3e(0xcf)}}};export{e as default};function _0x1e57(){const _0x156304=['計數項:','求和項:','3778265zvpuRT','(其他)','{0}','60eoSdyH','{0}:{1}','10840FpcZLe','年-月','最小值項:','7915226wAxWya','工作表','2718612LFwDxh','30zzxJBs','{0}-{1}','{0}\x20{1}','74097NXuuyy','年-季度','平均值項:','年-月-日','列標籤','730JUrmRj','46404twhhSE','3423ZVIBaP','{0}-Q{1}','總體方差項:','最大值項:','Q{0}','20059YgWbep','{0}{1}','乘積項:','行標籤','標準差項:'];_0x1e57=function(){return _0x156304;};return _0x1e57();}
@@ -62,7 +62,7 @@ export declare function getDateGroupDisplayArgs(dateType: PivotDateGroupFieldDat
62
62
  export declare const generatorAdjustPositionData: (injector: Injector, data: PivotView, pivotTableConfig: IPivotTableConfig, textInfo: Record<string, string>) => IAdjustPivotTableRes;
63
63
  export declare function transFromCellValue(cellData: IPivotViewCellData, isValue: boolean, format: string | undefined, textInfo: Record<string, string>, multipleGrandTotalLabel?: string): IPivotViewValueType;
64
64
  export declare function formatPivotRenderText(textInfo: Record<string, string>, templateKey: string, fallbackTemplate: string, ...args: unknown[]): string;
65
- export declare function transformErrorValue(value: IPivotViewValueType): string | number | import("@univerjs-pro/engine-pivot").IPivotViewPrefixValue | undefined;
65
+ export declare function transformErrorValue(value: IPivotViewValueType): string | number | import("@univerjs-pro/engine-pivot/types/layout-type.js").IPivotViewPrefixValue | undefined;
66
66
  export declare function getAdjustRangesPosition(startCell: {
67
67
  row: number;
68
68
  col: number;
@@ -110,10 +110,10 @@ export declare class FGenericPivotTable {
110
110
  removeFieldWithName(name: string): void;
111
111
  /**
112
112
  * Gets the result of the pivot table calculation.
113
- * The return value is a two-dimensional array after the pivot table calculation.
113
+ * The return value contains the calculated two-dimensional array and the split calculation result.
114
114
  * You can configure whether to display subTotal, grandTotal, etc. according to the input config.
115
115
  * @param {IPivotTableCubeConfig} config - The configuration of the pivot table cube.
116
- * @returns {IPivotViewValueType[][]} The result of the pivot table calculation.
116
+ * @returns {{ dataArr: IPivotViewValueType[][]; dataArrWithSplit: IPivotViewValueType[][][] }} The result of the pivot table calculation.
117
117
  * @example
118
118
  * ```typescript
119
119
  * const sourceData = [
@@ -84,12 +84,12 @@ export declare class FPivotTable {
84
84
  getId(): string;
85
85
  /**
86
86
  * @description Get the source range info of the pivot table.
87
- * @typedef SourceInfo
87
+ * @typedef IUnitRangeNameWithSubUnitId
88
88
  * @property {string} unitId The unit id of the source workbook.
89
89
  * @property {string} subUnitId The sheet id of the source worksheet.
90
90
  * @property {string} sheetName The source worksheet name.
91
91
  * @property {IRange} range The source data range.
92
- * @returns {SourceInfo|undefined} The source range info or undefined if the pivot table no longer exists.
92
+ * @returns {IUnitRangeNameWithSubUnitId | undefined} The source range info or undefined if the pivot table no longer exists.
93
93
  *
94
94
  * @example
95
95
  * ```ts
@@ -105,13 +105,13 @@ export declare class FPivotTable {
105
105
  getSourceRangeInfo(): IUnitRangeNameWithSubUnitId | undefined;
106
106
  /**
107
107
  * @description Get the target cell info of the pivot table.
108
- * @typedef TargetCellInfo
108
+ * @typedef PivotTableTargetCellInfo
109
109
  * @property {string} unitId The unit id of the target workbook.
110
110
  * @property {string} subUnitId The sheet id of the target worksheet.
111
111
  * @property {number} row The target row index.
112
112
  * @property {number} col The target column index.
113
113
  * @property {string} [sheetName] The target worksheet name if it is stored in the config.
114
- * @returns {TargetCellInfo|undefined} The target cell info or undefined if the pivot table no longer exists.
114
+ * @returns {IPivotTableConfig['targetCellInfo'] | undefined} The target cell info or undefined if the pivot table no longer exists.
115
115
  *
116
116
  * @example
117
117
  * ```ts
@@ -344,12 +344,12 @@ export declare class FPivotTable {
344
344
  getFieldSetting(fieldId: string): IPivotTableValueFieldJSON | IPivotTableLabelFieldJSON | undefined;
345
345
  /**
346
346
  * Get the pivot table field info list.
347
- * @typedef PivotTableDataFieldInfo
347
+ * @typedef IPivotTableDataFieldInfo
348
348
  * @property {string} id The field id.
349
349
  * @property {string} name The field name.
350
350
  * @property {PivotDataFieldDataTypeEnum} fieldDataType The field data type.
351
351
  * @property {string} [displayName] The field display name if it is set.
352
- * @returns {PivotTableDataFieldInfo} The field info list.
352
+ * @returns {IPivotTableDataFieldInfo[]} The field info list.
353
353
  *
354
354
  * @example
355
355
  * ```typescript
@@ -478,7 +478,7 @@ export declare class FPivotTable {
478
478
  * @param {string|number} dataFieldIdOrIndex The data field id.
479
479
  * @param {PivotTableFiledAreaEnum} fieldArea The area of the field.
480
480
  * @param {number} index The index of the field in the target area.
481
- * @returns {boolean} Whether the pivot field is added successfully.
481
+ * @returns {Promise<boolean>} Whether the pivot field is added successfully.
482
482
  *
483
483
  * @example
484
484
  * ```ts
@@ -493,7 +493,7 @@ export declare class FPivotTable {
493
493
  *
494
494
  * if(fPivotTable) {
495
495
  * // 1 means the source range index , 0 means the index in the target area.
496
- * fPivotTable.addField(1, univerAPI.Enum.PivotTableFiledAreaEnum.Row, 0);
496
+ * await fPivotTable.addField(1, univerAPI.Enum.PivotTableFiledAreaEnum.Row, 0);
497
497
  * }
498
498
  * ```
499
499
  */
@@ -501,7 +501,7 @@ export declare class FPivotTable {
501
501
  /**
502
502
  * @description Remove a pivot field from the pivot table
503
503
  * @param {string[]} fieldIds The deleted field ids.
504
- * @returns {boolean} Whether the pivot field is removed successfully.
504
+ * @returns {Promise<boolean>} Whether the pivot field is removed successfully.
505
505
  *
506
506
  * @example
507
507
  * ```ts
@@ -517,7 +517,7 @@ export declare class FPivotTable {
517
517
  * const rowIds = fPivotTable.getFieldIdsByArea(univerAPI.Enum.PivotTableFiledAreaEnum.Row);
518
518
  * if (rowIds.length > 0) {
519
519
  * // remove all field in row.
520
- * fPivotTable.removeField(rowIds);
520
+ * await fPivotTable.removeField(rowIds);
521
521
  * }
522
522
  * }
523
523
  * ```
@@ -528,7 +528,7 @@ export declare class FPivotTable {
528
528
  * @param {string} fieldId - The moved field id.
529
529
  * @param {PivotTableFiledAreaEnum} area - The target area of the field.
530
530
  * @param {number} index - The target index of the field, if the index is bigger than the field count in the target area, the field will be moved to the last, if the index is smaller than 0, the field will be moved to the first.
531
- * @returns {boolean} Whether the pivot field is moved successfully.
531
+ * @returns {Promise<boolean>} Whether the pivot field is moved successfully.
532
532
  *
533
533
  * @example
534
534
  * ```typescript
@@ -544,7 +544,7 @@ export declare class FPivotTable {
544
544
  * const rowIds = fPivotTable.getFieldIdsByArea(univerAPI.Enum.PivotTableFiledAreaEnum.Row);
545
545
  * if (rowIds.length > 0) {
546
546
  * // move to column
547
- * fPivotTable.updateFieldPosition(rowIds[0], univerAPI.Enum.PivotTableFiledAreaEnum.Column, 0);
547
+ * await fPivotTable.updateFieldPosition(rowIds[0], univerAPI.Enum.PivotTableFiledAreaEnum.Column, 0);
548
548
  * }
549
549
  * }
550
550
  * ```
@@ -554,7 +554,7 @@ export declare class FPivotTable {
554
554
  * @description If there are multiple value fields in the pivot table, you can update the position of the value field, which only can be position in row or column.
555
555
  * @param {PivotTableValuePositionEnum} position - The position of the value field.
556
556
  * @param {number} index - The index of the value field.
557
- * @returns {boolean} Whether the pivot value field is moved successfully.
557
+ * @returns {Promise<boolean>} Whether the pivot value field is moved successfully.
558
558
  *
559
559
  * @example
560
560
  * ```typescript
@@ -568,7 +568,7 @@ export declare class FPivotTable {
568
568
  * const fPivotTable = fWorkbook.getPivotTableByCell(unitId, subUnitId, 0, 8);
569
569
  * if(fPivotTable) {
570
570
  * // The prerequisite here is that the value dimension has more than one item
571
- * fPivotTable.updateValuePosition(univerAPI.Enum.PivotTableValuePositionEnum.Row, 0);
571
+ * await fPivotTable.updateValuePosition(univerAPI.Enum.PivotTableValuePositionEnum.Row, 0);
572
572
  * }
573
573
  * ```
574
574
  */
@@ -577,7 +577,7 @@ export declare class FPivotTable {
577
577
  * @description Set the pivot table subtotal type for value field, it only works for the value field.
578
578
  * @param {string} fieldId - The field id.
579
579
  * @param {PivotSubtotalTypeEnum} subtotalType - The subtotal type of the field.
580
- * @returns {boolean} Whether the pivot table subtotal type is set successfully.
580
+ * @returns {Promise<boolean>} Whether the pivot table subtotal type is set successfully.
581
581
  *
582
582
  * @example
583
583
  * ```ts
@@ -592,7 +592,7 @@ export declare class FPivotTable {
592
592
  * if (fPivotTable) {
593
593
  * const valueId = fPivotTable.getFieldIdsByArea(univerAPI.Enum.PivotTableFiledAreaEnum.Value)[0];
594
594
  * if (valueId) {
595
- * fPivotTable.setSubtotalType(valueId, univerAPI.Enum.PivotSubtotalTypeEnum.average);
595
+ * await fPivotTable.setSubtotalType(valueId, univerAPI.Enum.PivotSubtotalTypeEnum.average);
596
596
  * }
597
597
  * }
598
598
  * ```
@@ -633,7 +633,7 @@ export declare class FPivotTable {
633
633
  * @param {PivotTableSortInfo} info - The sort info.
634
634
  * @typedef PivotTableSortInfo
635
635
  * @property {PivotDataFieldSortOperatorEnum} type The sort operator of the field items.
636
- * @returns {boolean} Whether the pivot table sort info is set successfully.
636
+ * @returns {Promise<boolean>} Whether the pivot table sort info is set successfully.
637
637
  *
638
638
  * @example
639
639
  * ```ts
@@ -648,7 +648,7 @@ export declare class FPivotTable {
648
648
  * if (fPivotTable) {
649
649
  * const rowIds = fPivotTable.getFieldIdsByArea(univerAPI.Enum.PivotTableFiledAreaEnum.Row);
650
650
  * if (rowIds.length > 0) {
651
- * fPivotTable.setLabelSort(rowIds[0], { type: univerAPI.Enum.PivotDataFieldSortOperatorEnum.ascending });
651
+ * await fPivotTable.setLabelSort(rowIds[0], { type: univerAPI.Enum.PivotDataFieldSortOperatorEnum.ascending });
652
652
  * }
653
653
  * }
654
654
  * ```
@@ -659,7 +659,7 @@ export declare class FPivotTable {
659
659
  * @param {string} tableFieldId - The field id of the filter.
660
660
  * @param {string[]} items - The items of the filter.
661
661
  * @param {boolean} [isAll] - Whether the filter is all.If true, the filter will be all items, the items will be ignored.
662
- * @returns {boolean} Whether the pivot table filter is set successfully.
662
+ * @returns {Promise<boolean>} Whether the pivot table filter is set successfully.
663
663
  *
664
664
  * @example
665
665
  * ```ts
@@ -674,7 +674,7 @@ export declare class FPivotTable {
674
674
  * if (fPivotTable) {
675
675
  * const rowIds = fPivotTable.getFieldIdsByArea(univerAPI.Enum.PivotTableFiledAreaEnum.Row);
676
676
  * if (rowIds.length > 0) {
677
- * fPivotTable.setLabelManualFilter(rowIds[0], ['item1', 'item2']);
677
+ * await fPivotTable.setLabelManualFilter(rowIds[0], ['item1', 'item2']);
678
678
  * }
679
679
  * }
680
680
  * ```
@@ -688,7 +688,7 @@ export declare class FPivotTable {
688
688
  * @property {valueGreaterThan} operator - The filter operator is used to compare the value of the field with the expected value.Currently, The following operators are supported: valueBetween, valueEqual, valueGreaterThan, valueGreaterThanOrEqual, valueLessThan, valueLessThanOrEqual,valueNotBetween,valueNotEqual.
689
689
  * @property {number} expected - The expected value.
690
690
  * @property {string} valueFieldId - The value field id.
691
- * @returns {boolean} Whether the pivot table value filter is set successfully.
691
+ * @returns {Promise<boolean>} Whether the pivot table value filter is set successfully.
692
692
  *
693
693
  * @example
694
694
  * ```ts
@@ -704,14 +704,14 @@ export declare class FPivotTable {
704
704
  * const rowIds = fPivotTable.getFieldIdsByArea(univerAPI.Enum.PivotTableFiledAreaEnum.Row);
705
705
  * const valueIds = fPivotTable.getFieldIdsByArea(univerAPI.Enum.PivotTableFiledAreaEnum.Value);
706
706
  * if (valueIds.length > 0 && rowIds.length > 0) {
707
- * fPivotTable.setValueFilter(rowIds[0], {
707
+ * await fPivotTable.setValueFilter(rowIds[0], {
708
708
  * operator: univerAPI.Enum.PivotFilterOperatorEnum.valueGreaterThan,
709
709
  * expected: 10,
710
710
  * valueFieldId: valueIds[0]
711
711
  * });
712
712
  * }
713
713
  * // remove the value filter
714
- * // fPivotTable.setValueFilter(rowIds[0], undefined)
714
+ * // await fPivotTable.setValueFilter(rowIds[0], undefined)
715
715
  * }
716
716
  * ```
717
717
  */
@@ -740,7 +740,7 @@ export declare class FPivotTable {
740
740
  * @description Rename the pivot table field.
741
741
  * @param {string} fieldId - The field id.
742
742
  * @param {string} name - The new name of the field.
743
- * @returns {boolean} Whether the pivot table field is renamed successfully.
743
+ * @returns {Promise<boolean>} Whether the pivot table field is renamed successfully.
744
744
  *
745
745
  * @example
746
746
  * ```typescript
@@ -755,7 +755,7 @@ export declare class FPivotTable {
755
755
  * if (fPivotTable) {
756
756
  * const valueIds = fPivotTable.getFieldIdsByArea(univerAPI.Enum.PivotTableFiledAreaEnum.Value);
757
757
  * if (valueIds.length > 0) {
758
- * fPivotTable.renameField(valueIds[0], 'newName');
758
+ * await fPivotTable.renameField(valueIds[0], 'newName');
759
759
  * }
760
760
  * }
761
761
  * ```
@@ -766,7 +766,7 @@ export declare class FPivotTable {
766
766
  * @param {string} sheetName - The target sheet name.
767
767
  * @param {number} row - The target row index.
768
768
  * @param {number} col - The target column index.
769
- * @returns {boolean} Whether the pivot table field is moved successfully.
769
+ * @returns {Promise<boolean>} Whether the pivot table is moved successfully.
770
770
  * @example
771
771
  * ```typescript
772
772
  * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -779,7 +779,7 @@ export declare class FPivotTable {
779
779
  * const fPivotTable = fWorkbook.getPivotTableByCell(unitId, subUnitId, 0, 8);
780
780
  * if (fPivotTable) {
781
781
  * // move pivot table to row:100, col:1
782
- * fPivotTable.move(subSheetName, 100, 1);
782
+ * await fPivotTable.move(subSheetName, 100, 1);
783
783
  * }
784
784
  * ```
785
785
  */
@@ -788,7 +788,7 @@ export declare class FPivotTable {
788
788
  * @description Set the date group type for the date group field.
789
789
  * @param {string} tableFieldId - The field id of the group label field.
790
790
  * @param {PivotDateGroupFieldDateTypeEnum} dateType - The date group type.
791
- * @returns {boolean} Whether the date group type is set successfully.
791
+ * @returns {Promise<boolean>} Whether the date group type is set successfully.
792
792
  * @example
793
793
  * ```typescript
794
794
  * // To use this demo, you need to build a pivot table first, and make sure that the entire column in the pivot table source data is a date,
@@ -804,7 +804,7 @@ export declare class FPivotTable {
804
804
  * const rowIds = pivotTable.getFieldIdsByArea(univerAPI.Enum.PivotTableFiledAreaEnum.Row);
805
805
  * if (rowIds.length > 0) {
806
806
  * // Because the index is added to the position of 0 above, the index of the automatically derived date grouping dimension is 1
807
- * pivotTable.setDateGroupType(rowIds[1], univerAPI.Enum.PivotDateGroupFieldDateTypeEnum.YearMonthDate);
807
+ * await pivotTable.setDateGroupType(rowIds[1], univerAPI.Enum.PivotDateGroupFieldDateTypeEnum.YearMonthDate);
808
808
  * }
809
809
  * ```
810
810
  */
@@ -21,7 +21,7 @@ export interface IFWorkbookSheetsPivotMixin {
21
21
  * @param {SourceInfo} sourceInfo The source data range info of the pivot table.
22
22
  * @param {PositionType} positionType whether new a sheet or insert a pivot table to the existing sheet.
23
23
  * @param {AnchorCellInfo} anchorCellInfo The target cell info of the pivot table.
24
- * @returns {FPivotTable|undefined} The added pivot table instance.
24
+ * @returns {Promise<FPivotTable | undefined>} A promise that resolves to the added pivot table instance.
25
25
  *
26
26
  * @example
27
27
  * ```typescript
@@ -82,7 +82,7 @@ export interface IFWorkbookSheetsPivotMixin {
82
82
  /**
83
83
  * @description Get the pivot table by the pivot table id.
84
84
  * @param {string} pivotTableId The pivot table id.
85
- * @returns {string|undefined} The pivot table instance or undefined.
85
+ * @returns {FPivotTable | undefined} The pivot table instance or undefined.
86
86
  *
87
87
  * @example
88
88
  * ```typescript
@@ -1,27 +1,23 @@
1
- export { BIDI_ISOLATE_END, BIDI_ISOLATE_START, bidiIsolateText, hasRTLText, isolateTextForBidiContext } from './bidi';
1
+ export { isolateTextForBidiContext } from './bidi';
2
2
  export { AddPivotFieldCommand } from './commands/command/add-pivot-field.command';
3
3
  export type { IAddPivotFieldCommandParams } from './commands/command/add-pivot-field.command';
4
4
  export { AddPivotTableWithConfigCommand } from './commands/command/add-pivot-table-with-config.command';
5
5
  export { AddPivotTableCommand } from './commands/command/add-pivot-table.command';
6
6
  export type { IAddPivotTableCommandParams } from './commands/command/add-pivot-table.command';
7
- export { getPivotDateGroupContext, isPivotDateGroupTypeDisabled, PIVOT_DATE_GROUP_TYPES } from './commands/command/date-group-util';
7
+ export { getPivotDateGroupContext, isPivotDateGroupTypeDisabled, PIVOT_DATE_GROUP_TYPES, } from './commands/command/date-group-util';
8
8
  export type { IPivotDateGroupContext } from './commands/command/date-group-util';
9
9
  export { MovePivotFieldCommand } from './commands/command/move-pivot-field.command';
10
10
  export type { IMovePivotFieldCommandParams } from './commands/command/move-pivot-field.command';
11
11
  export { MovePivotTableCommand } from './commands/command/move-pivot-table.command';
12
12
  export type { IMovePivotTableCommandProps } from './commands/command/move-pivot-table.command';
13
13
  export { PivotDrillDownCommand } from './commands/command/pivot-drill-down.command';
14
- export type { IPivotDrillDownCommandParams } from './commands/command/pivot-drill-down.command';
15
14
  export { RemovePivotFieldCommand } from './commands/command/remove-pivot-field.command';
16
15
  export type { IRemovePivotFieldCommandParams } from './commands/command/remove-pivot-field.command';
17
16
  export { RemovePivotTableCommand } from './commands/command/remove-pivot-table.command';
18
- export type { IRemovePivotTableCommandParams } from './commands/command/remove-pivot-table.command';
19
17
  export { ResetPivotFieldsConfigCommand } from './commands/command/reset-pivot-fields-config.command';
20
- export type { IResetPivotFieldsConfigCommandParams } from './commands/command/reset-pivot-fields-config.command';
21
18
  export { SetPivotCollapseCommand } from './commands/command/set-pivot-collapse.command';
22
19
  export type { ISetPivotCollapseCommandParams } from './commands/command/set-pivot-collapse.command';
23
20
  export { SetPivotDateGroupCommand } from './commands/command/set-pivot-date-group.command';
24
- export type { ISetPivotDateGroupCommandParams } from './commands/command/set-pivot-date-group.command';
25
21
  export { SetPivotFieldsConfigCommand } from './commands/command/set-pivot-fields-config.command';
26
22
  export type { ISetPivotFieldsConfigCommandParams } from './commands/command/set-pivot-fields-config.command';
27
23
  export { SetPivotFilterCommand } from './commands/command/set-pivot-filter.command';
@@ -32,24 +28,20 @@ export { SetPivotSortCommand } from './commands/command/set-pivot-sort.command';
32
28
  export type { ISetPivotSortCommandParams } from './commands/command/set-pivot-sort.command';
33
29
  export { SetPivotValueFilterCommand } from './commands/command/set-pivot-value-filter.command';
34
30
  export type { ISetPivotValueFilterCommandParams } from './commands/command/set-pivot-value-filter.command';
35
- export { UpdateDateGroupCommand } from './commands/command/update-date-group.command';
36
31
  export { UpdatePivotFieldSettingCommand } from './commands/command/update-pivot-setting.command';
37
32
  export type { IUpdatePivotFieldSettingCommandParams } from './commands/command/update-pivot-setting.command';
38
33
  export { UpdatePivotTableSourceRangeCommand } from './commands/command/update-pivot-source.command';
39
34
  export type { IUpdatePivotTableSourceRangeCommandParams } from './commands/command/update-pivot-source.command';
40
35
  export { UpdatePivotValuePositionCommand } from './commands/command/update-value-position.command';
41
36
  export type { IUpdatePivotValuePositionCommandParams } from './commands/command/update-value-position.command';
42
- export { applyChangeSet } from './commands/command/util';
43
37
  export { AddPivotFieldMutation } from './commands/mutations/add-pivot-field.mutation';
44
38
  export { AddPivotTableMutation } from './commands/mutations/add-pivot-table.mutation';
45
- export { getFieldListByArea } from './commands/mutations/change-apply-util';
46
39
  export { RemovePivotFieldMutation } from './commands/mutations/remove-pivot-field.mutation';
47
40
  export { RemovePivotTableMutation } from './commands/mutations/remove-pivot-table.mutation';
48
41
  export { RenamePivotFieldMutation } from './commands/mutations/rename-pivot-field.mutation';
49
42
  export { SetPivotCollapseMutation } from './commands/mutations/set-pivot-collapse.mutation';
50
43
  export { SetPivotFieldFormatMutation } from './commands/mutations/set-pivot-field-format.mutation';
51
44
  export { SetPivotFilterMutation } from './commands/mutations/set-pivot-filter.mutation';
52
- export { SetPivotLayoutMutation } from './commands/mutations/set-pivot-layout.mutation';
53
45
  export { SetPivotOptionMutation } from './commands/mutations/set-pivot-option.mutation';
54
46
  export { SetPivotPositionMutation } from './commands/mutations/set-pivot-position.mutation';
55
47
  export { SetPivotSortMutation } from './commands/mutations/set-pivot-sort.mutation';
@@ -59,17 +51,13 @@ export { UpdateFieldPositionMutation } from './commands/mutations/update-field-p
59
51
  export { UpdatePivotFieldSourceInfoMutation } from './commands/mutations/update-pivot-field-source-info.mutation';
60
52
  export { UpdatePivotTableSourceRangeMutation } from './commands/mutations/update-pivot-table-source.mutation';
61
53
  export { UpdateValuePositionMutation } from './commands/mutations/update-value-position.mutation';
62
- export { PivotTableViewDirtyMarkOperation } from './commands/operations/pivot-table-dirty-view.operation';
63
54
  export { SHEETS_PIVOT_PLUGIN_CONFIG_KEY } from './config/config';
64
55
  export type { IUniverSheetsPivotConfig } from './config/config';
65
- export { BLANK_ROW_COUNT, getAdjustRangesPosition, PivotDisplayDataType, PositionType, SHEET_PIVOT_TABLE_PLUGIN } from './const/const';
66
- export { DEFAULT_PIVOT_NUMBER, defaultThemeStyle, transFromCellValue } from './const/const';
67
- export type { IAddPivotFieldMutationParams, IAddPivotTableMutationParams, IPivotCellPositionInfo, IPivotPanelDataInfo, IPivotPanelSourceList, IPivotPanelTableListItemBase, IPivotRangesInfo, IPivotRenderCache, IPivotTableAddedEventParams, IPivotTableCellData, IPivotTableConfig, IPivotTableMatrixInfo, IPivotTableMovedEventParams, IPivotTableRemovedEventParams, IPivotTableRenderedEventParams, IPivotTableUpdatedEventParams, IPivotViewUpdateInfo, IRangePosition, IRemovePivotFieldMutationParams, IRemovePivotTableMutationParams, IRenamePivotFieldMutationParams, ISetPivotCollapseMutation, ISetPivotFieldFormatMutationParams, ISetPivotFilterMutationParams, ISetPivotLayoutMutationParams, ISetPivotOptionMutationParams, ISetPivotPositionMutationParams, ISetPivotSortMutationParams, ISetPivotSubtotalTypeMutationParams, ISetPivotValueFilterMutationParams, IUnitRangeNameWithSubUnitId, IUpdateFieldPositionMutationParams, IUpdatePivotFieldSourceInfoMutationParams, IUpdateValuePositionMutationParams, } from './const/type';
68
- export { PivotTableOperationEnum } from './const/type';
56
+ export { BLANK_ROW_COUNT, getAdjustRangesPosition, PivotDisplayDataType, PositionType, SHEET_PIVOT_TABLE_PLUGIN, } from './const/const';
57
+ export type { IAddPivotTableMutationParams, IPivotCellPositionInfo, IPivotPanelDataInfo, IPivotPanelSourceList, IPivotPanelTableListItemBase, IPivotRangesInfo, IPivotTableAddedEventParams, IPivotTableCellData, IPivotTableConfig, IPivotTableMatrixInfo, IPivotTableMovedEventParams, IPivotTableRemovedEventParams, IPivotTableRenderedEventParams, IPivotViewUpdateInfo, IRemovePivotTableMutationParams, ISetPivotLayoutMutationParams, ISetPivotOptionMutationParams, IUnitRangeNameWithSubUnitId, } from './const/type';
69
58
  export { SheetsPivotTableConfigModel } from './models/sheets-pivot-config-model';
70
- export { SheetsPivotDataSourceModel } from './models/sheets-pivot-data-source-model';
71
59
  export { SheetsPivotTableAdaptorModel } from './models/sheets-pivot-table-adaptor-model';
72
60
  export { UniverSheetsPivotTablePlugin } from './plugin';
73
61
  export { SheetsPivotRPCService } from './services/sheets-pivot-rpc.service';
74
62
  export { SheetsPivotTableService } from './services/sheets-pivot-table.service';
75
- export { canUsePivot, generateSetRangeValueMutations, getEmptyPivotRanges, getInsertRowColMutations, getPivotCellInfo, getPivotInfoByLicense, getPivotTableInfo, unionPivotViewRange } from './util';
63
+ export { generateSetRangeValueMutations, getEmptyPivotRanges, unionPivotViewRange, } from './util';