@univerjs-pro/engine-pivot 0.6.0 → 0.6.1

package/lib/types/field/data-field.d.ts

@@ -138,6 +138,7 @@ export declare class DataField {
      */
     addRecord(record: IDataFieldValue, index: number): void;
     getIndexesByKey(key: string): number[];
+    getAllIndexMap(): Record<string, number[]>;
     /**
      * @description Update the item key in the data field.
      * @param {IDateValue} record - The date value.

package/lib/types/field/fields-collection.d.ts

@@ -25,6 +25,8 @@ export declare class FieldsCollection {
     readonly host: DataFieldManager;
     constructor(host: DataFieldManager);
     getFieldIds(): string[];
+    getFieldDisplayNames(): string[];
+    getFieldIdByDisplayName(name: string): string | undefined;
     hasField(fieldId: string): boolean;
     /**
      * find the is there has a data field whose name is the same as the sourceName.

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

@@ -183,6 +183,11 @@ export declare class PivotModel {
      * @returns {IPivotTableQueryData} - The query data of the pivot table.
      */
     getQueryData(): IPivotTableQueryData;
+    /**
+     * Resets the specified or all pivot table areas.
+     * @param {PivotTableFiledAreaEnum} [area] - The area to be reset. If not passed, all areas will be reset.
+     */
+    reset(area?: PivotTableFiledAreaEnum): void;
     fromJSON(data: IPivotTableSnapshot): void;
     toJSON(): IPivotTableSnapshot;
     cloneBufferModel(): PivotModel;

package/lib/types/pivot/pivot-table.d.ts

@@ -1,7 +1,7 @@
 import { DataField } from '../field/data-field';
 import { FieldsCollection } from '../field/fields-collection';
 import { PivotView } from '../layout/pivot-view';
-import { IPivotTableChangeSet, IPivotTableFilterInfo, IPivotTableOptions, IPivotTableQueryData, IPivotTableSnapshot, IPivotTableSortInfo, PivotTableFiledAreaEnum, PivotTableValuePositionEnum, PivotDataFieldDataTypeEnum, PivotSubtotalTypeEnum } from '../types';
+import { IPivotTableChangeSet, IPivotTableFilterInfo, IPivotTableOptions, IPivotTableQueryData, IPivotTableSnapshot, IPivotTableSortInfo, PivotTableFiledAreaEnum, PivotTableValuePositionEnum, PivotCallbackEnum, PivotDataFieldDataTypeEnum, PivotSubtotalTypeEnum } from '../types';
 import { PivotModel } from './model';
 import { PivotTableLabelField, PivotTableValueField } from './table-field';
 /**
@@ -15,7 +15,21 @@ export declare class PivotTable {
     private _model;
     _bufferModel: PivotModel;
     private _tupleGroupCache;
-    constructor(dataFieldsCollection: FieldsCollection, model?: PivotModel);
+    private _id;
+    private static _callbacks;
+    /**
+     * Register callback functions that are executed at certain times
+     * @param {PivotCallbackEnum} event - Enumeration of execution time
+     * @param {(id?: string) => void} callback - Callback Function
+    */
+    static registerCallbackWithEvent(event: PivotCallbackEnum, callback: (id?: string) => void): void;
+    /**
+     * Unregisters the callback function from the specified event.
+     * @param {PivotCallbackEnum} event - Enumeration of execution time
+     * @param {(id?: string) => void} callback - Callback Function
+     */
+    static unRegisterCallbackWithEvent(event: PivotCallbackEnum, callback: (id?: string) => void): void;
+    constructor(dataFieldsCollection: FieldsCollection, model?: PivotModel, id?: string);
     updateDataFieldsCollection(dataFieldsCollection: FieldsCollection): void;
     private _getModel;
     startCollectChangeset(): void;
@@ -100,6 +114,17 @@ export declare class PivotTable {
      * @returns {DataField|undefined} the data field or undefined
      */
     getDataFieldByDataFieldId(dataFieldId: string): DataField | undefined;
+    /**
+     * - get the data field id by the display name
+     * @param {string} name - the display name of the data field.
+     * @returns {string | undefined} - the data fieldId corresponding to the display name, or undefined if not found.
+     */
+    getDataFieldIdByDisplayName(name: string): string | undefined;
+    /**
+     * - get all display names of the data fields
+     * @returns {string[]} the all display names of the data fields
+     */
+    getFieldDisplayNames(): string[];
     getDataFieldItemInfo(dataField: DataField): {
         items: string[];
         itemTypes: PivotDataFieldDataTypeEnum[];
@@ -229,6 +254,7 @@ export declare class PivotTable {
      */
     getIndexesByPathStr(tuple: string[][]): number[];
     setDirty(dirty: boolean): void;
+    reset(area?: PivotTableFiledAreaEnum): void;
     query(config?: IPivotTableQueryData): PivotView;
     toJSON(): IPivotTableSnapshot;
     fromJSON(data: IPivotTableSnapshot): void;

package/lib/types/types/enum.d.ts

@@ -622,3 +622,17 @@ export declare enum PivotLayoutTypeEnum {
      */
     tabular = 3
 }
+/**
+ * Enum the execution time of callback functions
+ * @enum {string}
+ */
+export declare enum PivotCallbackEnum {
+    /**
+     * The pivot engine starts calculating
+     */
+    onQueryStart = "onQueryStart",
+    /**
+     * The pivot engine completes the calculation
+     */
+    onQueryEnd = "onQueryEnd"
+}

package/lib/types/types/json-types.d.ts

@@ -1,4 +1,4 @@
-import { PivotLayoutTypeEnum, PivotSubtotalTypeEnum, PivotTableFiledAreaEnum, PivotTableValuePositionEnum } from './enum';
+import { PivotDataFieldDataTypeEnum, PivotLayoutTypeEnum, PivotSubtotalTypeEnum, PivotTableFiledAreaEnum, PivotTableValuePositionEnum } from './enum';
 import { IPivotTableFilterInfo, IPivotTableShowDataAsInfo, IPivotTableSortInfo } from './interface';
 import { IPivotTableOptions } from './layout-type';
 export interface IPivotTableValueFieldJSON {
@@ -84,6 +84,7 @@ export interface IDataFieldJSON {
     id: string;
     name: string;
     hexCode: string;
+    fieldDataType: PivotDataFieldDataTypeEnum;
     rangeKey: string;
 }
 export interface IDataFieldManagerBaseJSON {

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

@@ -156,6 +156,10 @@ export interface IPivotTableOptions {
      * use span in the pivot table header
      */
     mergeItems?: boolean;
+    /**
+     * Whether to repeat the item labels in the pivot table
+     */
+    repeatRowLabels?: boolean;
 }
 export interface INodeSizeInfo {
     /**
@@ -196,6 +200,7 @@ export interface IPivotLayoutCtx {
     summaryManager: SummaryManager;
     measureIndexesMap: Record<string, number>;
     collapseInfo: Record<string, boolean | Record<string, boolean>>;
+    repeatRowLabels: boolean;
 }
 export interface IPageViewItemRange {
     row: number;

package/lib/types/util.d.ts

@@ -1,4 +1,4 @@
-import { IDataFieldValue, IDateValue, IMeasuresMapItem, IPivotTableCustomFilter, IPivotTableFilterInfo, IPivotTableManualFilter, IPivotTableSortInfo, ITupleItem, PivotCellStyleTypeEnum, PivotDataFieldDataTypeEnum, PivotSubtotalTypeEnum, PivotTableFiledAreaEnum } from './types';
+import { IDataFieldValue, IDateValue, IMeasuresMapItem, IPivotTableCustomFilter, IPivotTableFilterInfo, IPivotTableManualFilter, IPivotTableSortInfo, ITupleItem, PivotCellStyleTypeEnum, PivotDataFieldDataTypeEnum, PivotSubtotalTypeEnum, PivotTableFiledAreaEnum, ST_PivotFilterOperatorEnum } from './types';
 /**
  * - judge the value is date like type
  * @param {IDataFieldValue} value the date like value
@@ -122,3 +122,4 @@ export declare function unionSortedList(arrays: number[][]): number[];
  * @returns {Record<string, number>} the sorted item map
  */
 export declare function sortLabelItem(items: string[], itemTypes: PivotDataFieldDataTypeEnum[], itemsMap: Record<string, number>): Record<string, number>;
+export declare function getCustomNumberFilterResultTemp(indexesMap: Record<string, number[]>, operator: ST_PivotFilterOperatorEnum, expected: number | [number, number]): number[][];