@univerjs-pro/engine-pivot 1.0.0-alpha.7 → 1.0.0-beta.0

package/lib/types/field/base-group-field.d.ts

@@ -1,4 +1,4 @@
-import type { IBaseGroupFieldInfo, IBaseGroupFieldJSON, IPivotTableGroupInfo, PivotDataFieldTypeEnum } from '../types';
+import type { IBaseGroupFieldInfo, IBaseGroupFieldJSON, IPivotTableDateGroupInfo, PivotDataFieldTypeEnum } from '../types';
 import { DataField } from './data-field';
 export declare abstract class BaseGroupField extends DataField {
     protected originalFieldId: string;
@@ -7,7 +7,7 @@ export declare abstract class BaseGroupField extends DataField {
      * @returns {PivotDataFieldTypeEnum} - The group type
      */
     abstract getDataFieldType(): PivotDataFieldTypeEnum;
-    abstract getGroupInfo(): IPivotTableGroupInfo;
+    abstract getGroupInfo(): IPivotTableDateGroupInfo;
     abstract getOriginFieldId(): string;
     abstract refreshGroupField(originalField: DataField): void;
     getFieldInfo(): IBaseGroupFieldInfo;

package/lib/types/field/date-group-field.d.ts

@@ -1,4 +1,4 @@
-import type { IDateGroupFieldInfo, IDateGroupFieldJSON, IPivotTableGroupInfo } from '../types';
+import type { IDateGroupFieldInfo, IDateGroupFieldJSON, IPivotTableDateGroupInfo } from '../types';
 import type { DataField } from './data-field';
 import { PivotDataFieldTypeEnum, PivotDateGroupFieldDateTypeEnum } from '../types';
 import { BaseGroupField } from './base-group-field';
@@ -10,7 +10,7 @@ export declare class DateGroupField extends BaseGroupField {
     getDateType(): PivotDateGroupFieldDateTypeEnum;
     getDateGroupValid(): boolean;
     refreshGroupField(originalField: DataField): void;
-    getGroupInfo(): IPivotTableGroupInfo;
+    getGroupInfo(): IPivotTableDateGroupInfo;
     getDataFieldType(): PivotDataFieldTypeEnum;
     getOriginFieldId(): string;
     getFieldInfo(): IDateGroupFieldInfo;

package/lib/types/index.d.ts

@@ -8,7 +8,7 @@ export { isErrorValue, isPrefixValue, LabelViewItem, PivotView, PivotViewItem, }
 export { PivotTable } from './pivot/pivot-table';
 export { createLabelField, createValueField, PivotTableLabelField, PivotTableValueField, } from './pivot/table-field';
 export { PivotCallbackEnum, PivotDataFieldDataTypeEnum, PivotDataFieldSortOperatorEnum, PivotDataFieldSortTypeEnum, PivotDataFieldTypeEnum, PivotDateGroupFieldDateSystemEnum, PivotDateGroupFieldDateTypeEnum, PivotErrorTypeEnum, PivotFilterTypeEnum, PivotLayoutTypeEnum, PivotShowAsTypeEnum, PivotSubtotalPositionEnum, PivotSubtotalTypeEnum, PivotTableFiledAreaEnum, PivotTableValuePositionEnum, ST_PivotFilterOperatorEnum, } from './types/enum';
-export type { IDataFieldValue, IDateValue, IPivotTableFilterInfo, IPivotTableGroupInfo, IPivotTableManualFilter, IPivotTableSortInfo, IPivotTableValueFilter, IValueFilterInfoItem, } from './types/interface';
+export type { IDataFieldValue, IDateValue, IPivotTableFilterInfo, IPivotTableDateGroupInfo, IPivotTableManualFilter, IPivotTableSortInfo, IPivotTableValueFilter, IValueFilterInfoItem, } from './types/interface';
 export type { IBaseGroupFieldJSON, IDataFieldManagerBaseJSON, IFieldsCollectionJSON, IPivotTableLabelFieldJSON, IPivotTableSnapshot, IPivotTableValueFieldJSON, } from './types/json-types';
 export { PivotTableChangeTypeEnum } from './types/json-types';
 export type { IPivotTableAddFieldChange, IPivotTableChangeSet, IPivotTableRemoveFieldChange, IPivotTableRenameFieldChange, IPivotTableSetCollapseChange, IPivotTableSetFilterInfoChange, IPivotTableSetFormatChange, IPivotTableSetLayoutChange, IPivotTableSetOptionsChange, IPivotTableSetSortInfoChange, IPivotTableSetSubtotalTypeChange, IPivotTableSetValueFilterChange, IPivotTableUpdatePositionChange, IPivotTableUpdateValuePositionChange, IPivotUpdateSourceChange, } from './types/json-types';

package/lib/types/layout/pivot-view.d.ts

@@ -1,5 +1,5 @@
 import type { PivotModel } from '../pivot/model';
-import type { ILabelViewHeaderMapItem, ILabelViewItemJSON, IPageViewItemJSON, IPageViewItemRange, IPivotTableGroupInfo, IPivotViewCellData, IPivotViewErrorValue, IPivotViewInfo, IPivotViewItemData, IPivotViewItemJSON, IPivotViewJSON, IPivotViewPrefixValue, IPivotViewValueType, PivotCellStyleTypeEnum } from '../types';
+import type { ILabelViewHeaderMapItem, ILabelViewItemJSON, IPageViewItemJSON, IPageViewItemRange, IPivotTableDateGroupInfo, IPivotViewCellData, IPivotViewErrorValue, IPivotViewInfo, IPivotViewItemData, IPivotViewItemJSON, IPivotViewJSON, IPivotViewPrefixValue, IPivotViewValueType, PivotCellStyleTypeEnum } from '../types';
 /**
  * @class PivotView
  * @description the view of pivot table, which contains the page, row, col, data view, the page view separation the pivot table to two areas, the row and col view as the header of data area
@@ -36,10 +36,10 @@ export declare class PivotView {
     /**
      * the group info map of the table field id, it will be used to store the group info of the pivot view
      */
-    groupInfo: Record<string, IPivotTableGroupInfo>;
+    groupInfo: Record<string, IPivotTableDateGroupInfo>;
     constructor();
     setVersion(version?: number): void;
-    setGroupInfo(groupInfo: Record<string, IPivotTableGroupInfo>): void;
+    setGroupInfo(groupInfo: Record<string, IPivotTableDateGroupInfo>): void;
     /**
      * - the func effect is to set the format code , for label view, it will used to format the header , such as date type data, in the data view, it will used to format the data of show data as
      * @param model the pivot model, it will be used to set the format of the pivot view

package/lib/types/pivot/model.d.ts

@@ -146,8 +146,10 @@ export declare class PivotModel {
     isExistFieldName(fieldName: string): boolean;
     /**
      * @description Rename a field in the pivot table.
+     * Renaming a field to its current display name is an idempotent no-op. A display name already
+     * used by another field is rejected.
      * @param {string} fieldId - The id of the field to be renamed.
-     * @param displayName - The new display name of the field.
+     * @param {string} displayName - The new display name of the field.
      * @returns {void}
      */
     renameField(fieldId: string, displayName: string): void;

package/lib/types/summary/node-tree.d.ts

@@ -45,5 +45,6 @@ export declare class NodeTree {
     setName(name: string): void;
     addNode(node: NodeTree, path: string, sortMap: Record<string, number> | undefined, sortType: PivotDataFieldSortOperatorEnum): void;
     sortNode(path: string, sortedMap: Record<string, number>, sortType: PivotDataFieldSortOperatorEnum): void;
+    sortChildrenByValue(fieldId: string, sortType: PivotDataFieldSortOperatorEnum, getValue: (index: number) => number | undefined): void;
     getNode(path: string): NodeTree | undefined;
 }

package/lib/types/summary/summary-manager.d.ts

@@ -1,5 +1,5 @@
 import type { DataField } from '../field/data-field';
-import type { IDimensionMapItem, IMeasuresMapItem, IPivotSummaryLevelPool, IPivotTableQueryData, IPivotTableValueFilter, ITupleItem, IValueFilterInfoItem, PivotErrorTypeEnum, PivotSubtotalTypeEnum } from '../types';
+import type { IDimensionMapItem, IMeasuresMapItem, IPivotSummaryLevelPool, IPivotTableQueryData, IPivotTableValueFilter, IPivotTableValueSortInfo, ITupleItem, IValueFilterInfoItem, PivotErrorTypeEnum, PivotSubtotalTypeEnum } from '../types';
 import type { TupleGroup } from './tuple-group';
 import { PivotDataFieldSortOperatorEnum } from '../types';
 import { NodeTree } from './node-tree';
@@ -45,6 +45,7 @@ export declare class SummaryManager {
         type: PivotDataFieldSortOperatorEnum;
         sortMap: Record<string, number>;
     }>;
+    valueSortInfo: Record<string, IPivotTableValueSortInfo>;
     valueFilterInfo: IValueFilterInfoItem[];
     subtotalMap: Record<string, {
         subTotal: PivotSubtotalTypeEnum;
@@ -57,6 +58,7 @@ export declare class SummaryManager {
     } | undefined;
     getSortedMap(tableFieldId: string, dataField: DataField): Record<string, number>;
     doSummary(): void;
+    private _applyValueSorts;
     private _getIndex;
     buildNodeTree(ignoreLeafSet: Set<number>): void;
     createTupleWithoutCheck(paths: string[], nodeIndex: number, tupleKey: string): void;

package/lib/types/types/interface.d.ts

@@ -69,7 +69,6 @@ export interface IPivotTuple {
 }
 export type IPivotTableFilterInfo = IPivotTableManualFilter | IPivotTableCustomFilter | IPivotTableValueFilter;
 export type IPivotTableSortInfo = IPivotTableLabelSortInfo | IPivotTableValueSortInfo | IPivotTableLabelCustomSortInfo;
-export type IPivotTableGroupInfo = IPivotTableDateGroupInfo;
 export interface IPivotTableDateGroupInfo {
     type: PivotDataFieldTypeEnum.dateGroupField;
     dateType: PivotDateGroupFieldDateTypeEnum;
@@ -118,6 +117,8 @@ export interface IPivotTableValueFilter {
     operator: ST_PivotFilterOperatorEnum;
     expected: any;
     valueFieldId: string;
+    /** Whether a count/percent rank filter keeps the bottom values instead of the top values. */
+    isBottom?: boolean;
 }
 export interface IPivotTableShowDataAsInfo {
     type: PivotShowAsTypeEnum;

package/lib/types/types/layout-type.d.ts

@@ -2,7 +2,7 @@ import type { PivotView } from '../layout/pivot-view';
 import type { NodeTree } from '../summary/node-tree';
 import type { SummaryManager } from '../summary/summary-manager';
 import type { PivotErrorTypeEnum, PivotSubtotalPositionEnum } from './enum';
-import type { IPivotTableGroupInfo, IPivotTableQueryData, IPivotTableValueFieldQueryData, IValueFilterInfoItem } from './interface';
+import type { IPivotTableDateGroupInfo, IPivotTableQueryData, IPivotTableValueFieldQueryData, IValueFilterInfoItem } from './interface';
 export interface IPivotViewItemData {
     [row: number]: IPivotViewColData;
 }
@@ -287,6 +287,6 @@ export interface IPivotViewJSON {
     cornerView: IPivotViewItemJSON;
     version: number;
     formatMap: Record<string, string>;
-    groupInfo: Record<string, IPivotTableGroupInfo>;
+    groupInfo: Record<string, IPivotTableDateGroupInfo>;
 }
 export {};

package/lib/types/util.d.ts

@@ -1,7 +1,7 @@
 import type { BaseGroupField } from './field/base-group-field';
 import type { DataField } from './field/data-field';
 import type { DateGroupField } from './field/date-group-field';
-import type { IBaseGroupFieldJSON, IDataFieldJSON, IDataFieldValue, IDateGroupFieldJSON, IDateValue, IMeasuresMapItem, IPivotTableCustomFilter, IPivotTableDateGroupInfo, IPivotTableFilterInfo, IPivotTableGroupInfo, IPivotTableLabelCustomSortInfo, IPivotTableManualFilter, IPivotTableSortInfo, ITupleItem, IValueFilterInfoItem, PivotErrorTypeEnum, ST_PivotFilterOperatorEnum } from './types';
+import type { IBaseGroupFieldJSON, IDataFieldJSON, IDataFieldValue, IDateGroupFieldJSON, IDateValue, IMeasuresMapItem, IPivotTableCustomFilter, IPivotTableDateGroupInfo, IPivotTableFilterInfo, IPivotTableLabelCustomSortInfo, IPivotTableManualFilter, IPivotTableSortInfo, ITupleItem, IValueFilterInfoItem, PivotErrorTypeEnum, ST_PivotFilterOperatorEnum } from './types';
 import { PivotTuple } from './summary/pivot-tuple';
 import { PivotCellStyleTypeEnum, PivotDataFieldDataTypeEnum, PivotDateGroupFieldDateTypeEnum, PivotSubtotalTypeEnum, PivotTableFiledAreaEnum } from './types';
 /**
@@ -143,5 +143,5 @@ export declare function isDateGroupField(field: DataField): field is DateGroupFi
 export declare function isBaseGroupField(field: DataField): field is BaseGroupField;
 export declare function isBaseGroupFieldJSON(field: IDataFieldJSON | IBaseGroupFieldJSON): field is IBaseGroupFieldJSON;
 export declare function isDateGroupFieldJSON(field: IDataFieldJSON | IBaseGroupFieldJSON): field is IDateGroupFieldJSON;
-export declare function isDateGroupInfo(groupInfo: IPivotTableGroupInfo): groupInfo is IPivotTableDateGroupInfo;
+export declare function isDateGroupInfo(groupInfo: IPivotTableDateGroupInfo): groupInfo is IPivotTableDateGroupInfo;
 export declare function getDateGroupValue(excelDate: number, dateType: PivotDateGroupFieldDateTypeEnum, useDefault1900DateSystem?: boolean): string;