@univerjs-pro/engine-pivot 1.0.0-alpha.8 → 1.0.0-beta.1

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, IPivotTableDateGroupInfo, IPivotTableManualFilter, IPivotTableSortInfo, IPivotTableValueFilter, IValueFilterInfoItem, } from './types/interface';
+export type { IDataFieldValue, IDateValue, IPivotTableDateGroupInfo, IPivotTableFilterInfo, 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/base-layout.d.ts

@@ -1,8 +1,8 @@
 import type { PivotTable } from '../pivot/pivot-table';
 import type { NodeTree } from '../summary/node-tree';
 import type { SummaryManager } from '../summary/summary-manager';
-import type { IColumnNodeSizeInfo, INodeSizeInfo, IPivotLayoutCtx, IPivotTableLabelFieldQueryData, IPivotTableQueryData, PivotErrorTypeEnum } from '../types';
-import type { PageViewItem } from './pivot-view';
+import type { IColumnNodeSizeInfo, INodeSizeInfo, IPivotLayoutCtx, IPivotTableLabelFieldQueryData, IPivotTableQueryData, IPivotViewValueType, PivotErrorTypeEnum } from '../types';
+import type { ColViewItem, PageViewItem } from './pivot-view';
 export declare class BaseLayout {
     /**
      *
@@ -15,7 +15,7 @@ export declare class BaseLayout {
     static layoutPageOverThenDown(filters: IPivotTableLabelFieldQueryData[], page: PageViewItem, pageWrap?: number): void;
     static layoutPageDownThenOver(filters: IPivotTableLabelFieldQueryData[], page: PageViewItem, pageWrap?: number): void;
     static layoutCol(ctx: IPivotLayoutCtx): void;
-    static layoutCorner(ctx: IPivotLayoutCtx): void;
+    static layoutCorner(_ctx: IPivotLayoutCtx): void;
     static layoutColHeader(ctx: IPivotLayoutCtx): void;
     static setValueSize(ctx: IPivotLayoutCtx): void;
     static layoutNoneColFields(ctx: IPivotLayoutCtx, nodeTree: NodeTree): IColumnNodeSizeInfo;
@@ -52,6 +52,7 @@ export declare class BaseLayout {
     static shouldMultipleTotal(hasMultiValue: boolean, nodeLevel: number, valueIndex: number): boolean;
     static shouldMultipleNode(hasMultiValue: boolean, nodeLevel: number, valueIndex: number): boolean;
     static getRowIndexForColHeader(nodeLevel: number, valueIndex: number, hasMultiValue: boolean): number;
+    static setColLabelValue(colView: ColViewItem, row: number, col: number, value: IPivotViewValueType, isBlank: boolean, isOther: boolean): void;
     static layoutColNode(ctx: IPivotLayoutCtx, nodeTree: NodeTree, col: number, valueIds: string[]): IColumnNodeSizeInfo;
     static getMeasureIndex(isColMultiMeasure: boolean, valueIds: string[], measureIndexesMap: Record<string, number>): number;
     static updateColumnSubtotal(ctx: IPivotLayoutCtx, col: number, nodeTree: NodeTree, valueIds: string[], colPathMap: Record<string, number>): void;

package/lib/types/layout/tabular.d.ts

@@ -6,6 +6,11 @@ import type { PivotView } from './pivot-view';
 import { BaseLayout } from './base-layout';
 export declare class TabularLayout extends BaseLayout {
     static layout(pivotTable: PivotTable, summaryManager: SummaryManager, queryData: IPivotTableQueryData): PivotView;
+    static layoutHeadersWithoutColumnDimensions(ctx: IPivotLayoutCtx): void;
+    static getCornerSize(ctx: IPivotLayoutCtx): {
+        rowCount: number;
+        colCount: number;
+    };
     static layoutCorner(ctx: IPivotLayoutCtx): void;
     static layoutRowFields(ctx: IPivotLayoutCtx): void;
     static doRowLeafNode(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, valueIds: string[]): IRowNodeSizeInfo;

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

@@ -117,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

@@ -179,9 +179,13 @@ export interface IPivotTableOptions {
      */
     mergeItems?: boolean;
     /**
-     * Whether to repeat the item labels in the pivot table
+     * Whether to repeat row item labels in the pivot table
      */
     repeatRowLabels?: boolean;
+    /**
+     * Whether to repeat column item labels in the pivot table
+     */
+    repeatColLabels?: boolean;
     /**
      * Whether to show subtotal and grand total, if showSubtotal is false, the subtotal and grand total will not be calculated and rendered, if showGrandTotal is false, the grand total will not be calculated and rendered
      */
@@ -243,6 +247,7 @@ export interface IPivotLayoutCtx {
     measureIndexesMap: Record<string, number>;
     collapseInfo: Record<string, boolean | Record<string, boolean>>;
     repeatRowLabels: boolean;
+    repeatColLabels: boolean;
     valueFilterMap: Record<string, IValueFilterInfoItem>;
     showRowSubtotal: boolean;
     showRowGrandTotal: boolean;