@univerjs-pro/engine-pivot 0.6.1 → 0.6.2

package/lib/types/filter-util.d.ts

@@ -0,0 +1,2 @@
+import { IPivotTableCustomFilter, IPivotTableValueFilter } from './types';
+export declare function getFilterExecuteFunc(filterInfo: IPivotTableValueFilter | IPivotTableCustomFilter): (value: number) => boolean;

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

@@ -1,4 +1,4 @@
-import { IPivotTableChangeSet, IPivotTableFilterInfo, IPivotTableOptions, IPivotTableQueryData, IPivotTableSnapshot, IPivotTableSortInfo, PivotSubtotalTypeEnum, PivotLayoutTypeEnum, PivotTableFiledAreaEnum, PivotTableValuePositionEnum } from '../types';
+import { IPivotTableChangeSet, IPivotTableFilterInfo, IPivotTableOptions, IPivotTableQueryData, IPivotTableSnapshot, IPivotTableSortInfo, IPivotTableValueFilter, IValueFilterInfoItem, PivotSubtotalTypeEnum, PivotLayoutTypeEnum, PivotTableFiledAreaEnum, PivotTableValuePositionEnum } from '../types';
 import { PivotTableLabelField, PivotTableValueField } from './table-field';
 /**
  * @class PivotModel represents a config model for a pivot table.
@@ -71,6 +71,7 @@ export declare class PivotModel {
      * the dirty status is used to flag the pivot table need to be queried data from the data source or just use cached tuple data.
      */
     private _isDirty;
+    private _valueFilterInfo;
     constructor();
     startChangeStack(): void;
     endChangeStack(): IPivotTableChangeSet[];
@@ -102,7 +103,12 @@ export declare class PivotModel {
      * @param {string} [item] - The item of the field.
      */
     setCollapse(fieldId: string, collapse: boolean, item?: string): void;
-    setFilterInfo(fieldId: string, filterInfo: IPivotTableFilterInfo): void;
+    setLabelFilterInfo(fieldId: string, filterInfo: IPivotTableFilterInfo): void;
+    setValueFilterInfo(fieldId: string, filterInfo: IPivotTableValueFilter | undefined): void;
+    getValueFilterInfo(fieldId: string): IPivotTableValueFilter | undefined;
+    getValueFilterInfos(): IValueFilterInfoItem[];
+    removeValueFilterInfo(fieldId: string): void;
+    removeValueFilterInfoByValueFieldId(valueFieldId: string): void;
     getFieldFormat(fieldId: string): string | undefined;
     setFieldFormat(fieldId: string, format: string | undefined): void;
     setSortInfo(fieldId: string, sortInfo: IPivotTableSortInfo | undefined): void;

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, PivotCallbackEnum, PivotDataFieldDataTypeEnum, PivotSubtotalTypeEnum } from '../types';
+import { IPivotTableChangeSet, IPivotTableFilterInfo, IPivotTableOptions, IPivotTableQueryData, IPivotTableSnapshot, IPivotTableSortInfo, IPivotTableValueFilter, PivotTableFiledAreaEnum, PivotTableValuePositionEnum, PivotCallbackEnum, PivotDataFieldDataTypeEnum, PivotSubtotalTypeEnum } from '../types';
 import { PivotModel } from './model';
 import { PivotTableLabelField, PivotTableValueField } from './table-field';
 /**
@@ -21,7 +21,7 @@ export declare class PivotTable {
      * 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.
@@ -35,8 +35,8 @@ export declare class PivotTable {
     startCollectChangeset(): void;
     endCollectChangeset(): IPivotTableChangeSet[];
     _generateModel(): void;
-    createLabelFieldByDataFieldId(dataFieldId: string, tableName?: string): PivotTableLabelField | undefined;
-    createValueFieldByDataFieldId(dataFieldId: string): PivotTableValueField | undefined;
+    createLabelFieldByDataFieldId(dataFieldId: string, tableName?: string, provideTableFieldId?: string): PivotTableLabelField | undefined;
+    createValueFieldByDataFieldId(dataFieldId: string, provideTableFieldId?: string): PivotTableValueField | undefined;
     updateValuePosition(valuePosition: PivotTableValuePositionEnum, valueIndex: number): void;
     isColMultiMeasure(): boolean;
     isRowMultiMeasure(): boolean;
@@ -137,7 +137,7 @@ export declare class PivotTable {
      * @param {number} [index] the position of the field in the area, if not set, the field will be added to the end of the area.
      * @returns {PivotTableLabelField|PivotTableValueField} the added field
      */
-    addFieldWithSourceId(dataFieldId: string, area: PivotTableFiledAreaEnum, index?: number): PivotTableLabelField | PivotTableValueField | undefined;
+    addFieldWithSourceId(dataFieldId: string, area: PivotTableFiledAreaEnum, index?: number, provideTableFieldId?: string): PivotTableLabelField | PivotTableValueField | undefined;
     setOptions(options: IPivotTableOptions): void;
     /**
      *  the func is only use for when refresh
@@ -163,7 +163,7 @@ export declare class PivotTable {
      * @param fieldId
      * @param filterInfo
      */
-    setFilterInfo(fieldId: string, filterInfo: IPivotTableFilterInfo): void;
+    setLabelFilterInfo(fieldId: string, filterInfo: IPivotTableFilterInfo): void;
     /**
      *  - Set the sort information of the dimension field. only the dimension field can set the sort information.
      * @param {string} fieldId - The id of the field.
@@ -242,6 +242,33 @@ export declare class PivotTable {
         index: number;
     };
     private _getTupleCache;
+    /**
+     * Set the value filter information of the pivot table.
+     * @param {string} fieldId The base label field id of the value filter.
+     * @param {IPivotTableValueFilter} filterInfo The value filter information.
+     */
+    setValueFilterInfo(fieldId: string, filterInfo: IPivotTableValueFilter | undefined): void;
+    /**
+     * Get the value filter information list of the pivot table.
+     * @returns {IPivotTableValueFilter[]} The value filter information list.
+     */
+    getValueFilterInfos(): import('..').IValueFilterInfoItem[];
+    /**
+     * Get the value filter information of the pivot table by the field id.
+     * @param {string} fieldId The base label field id of the value filter.
+     * @returns {IPivotTableValueFilter | undefined} The value filter information.
+     */
+    getValueFilterInfo(fieldId: string): IPivotTableValueFilter | undefined;
+    /**
+     * Remove the value filter information of the pivot table by the field id.
+     * @param fieldId
+     */
+    removeValueFilterInfo(fieldId: string): void;
+    /**
+     * Remove the value filter information of the pivot table by the value field id.
+     * @param {string} valueFieldId The value field id of the value filter.
+     */
+    removeValueFilterInfoByValueFieldId(valueFieldId: string): void;
     /**
      * Find the tupleItem in the cache that matches the position order according to the passed array,
      * and after obtaining the row number array marked on it,
@@ -249,7 +276,7 @@ export declare class PivotTable {
      *
      * The key point here is that `dimensionIdList` and `dimensionTableIdList` are one-to-one index corresponding
      *
-     * @param {string[][]} -A two-dimensional array with path and tableFieldId
+     * @param {string[][]} tuple -A two-dimensional array with path and tableFieldId
      * @returns {number[]} -Sorted row numbers
      */
     getIndexesByPathStr(tuple: string[][]): number[];

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

@@ -1,7 +1,7 @@
 import { DataField } from '../field/data-field';
-import { IDimensionMapItem, IMeasuresMapItem, IPivotSummaryLevelPool, IPivotTableQueryData, ITupleItem, PivotErrorTypeEnum, PivotSubtotalTypeEnum, PivotDataFieldSortOperatorEnum } from '../types';
-import { NodeTree } from './node-tree';
+import { IDimensionMapItem, IMeasuresMapItem, IPivotSummaryLevelPool, IPivotTableQueryData, IPivotTableValueFilter, ITupleItem, IValueFilterInfoItem, PivotErrorTypeEnum, PivotSubtotalTypeEnum, PivotDataFieldSortOperatorEnum } from '../types';
 import { TupleGroup } from './tuple-group';
+import { NodeTree } from './node-tree';
 export declare class SummaryManager {
     counter: number;
     rowDimOrder: number[];
@@ -44,6 +44,11 @@ export declare class SummaryManager {
         type: PivotDataFieldSortOperatorEnum;
         sortMap: Record<string, number>;
     }>;
+    valueFilterInfo: IValueFilterInfoItem[];
+    subtotalMap: Record<string, {
+        subTotal: PivotSubtotalTypeEnum;
+        dataFieldId: string;
+    }>;
     constructor(queryData: IPivotTableQueryData, tupleGroup: TupleGroup);
     createSummaryLabelSortedMap(queryData: IPivotTableQueryData): void;
     getCellValue(index: number, id: string, subtotal: PivotSubtotalTypeEnum): number | {
@@ -52,12 +57,12 @@ export declare class SummaryManager {
     getSortedMap(tableFieldId: string, dataField: DataField): Record<string, number>;
     doSummary(): void;
     private _getIndex;
-    buildNodeTree(): void;
+    buildNodeTree(ignoreLeafSet: Set<number>): void;
     createTupleWithoutCheck(paths: string[], nodeIndex: number, tupleKey: string): void;
-    _buildNodeTreeImp(dimOrder: number[], tableIdList: string[], levelPool: IPivotSummaryLevelPool, nodePathStr: string): NodeTree;
+    _buildNodeTreeImp(dimOrder: number[], tableIdList: string[], levelPool: IPivotSummaryLevelPool, nodePathStr: string, ignoreLeafSet: Set<number>): NodeTree;
     combinePathMapList(colPathMapList: Record<string, number>[], basePath: string): Record<string, number>;
     calculateListSubtotal(tupleItem: ITupleItem, indexes: number[]): void;
-    calculateSubtotal(): void;
+    calculateSubtotal(ignoreLeafSet: Set<number>): void;
     getPathKeyWithFiledId(paths: string[], tableIdList: string[]): string;
     ensureTupleItem(index: number, paths: string[], tableIdList: string[]): void;
     ensureTupleItemByString(index: number, pathString: string): void;
@@ -68,5 +73,15 @@ export declare class SummaryManager {
      * @returns {void}
      */
     createTuple(paths: string[], pathsStr?: string, nodeIndex?: number): void;
-    _calculateSubtotalImp(levelPool: IPivotSummaryLevelPool): void;
+    _calculateValueFilter(): Set<number>;
+    _doValueFilter(fieldId: string, valueFieldId: string, filterInfo: IPivotTableValueFilter, leafSet: Set<number>): void;
+    /**
+     * get the filter tree by fieldId, if the fieldId is in rowTableIdList, return rowNodeTree, if the fieldId is in colTableIdList, return colNodeTree
+     * @param fieldId The base field id of the value filter.
+     */
+    _getValueFilterTree(fieldId: string): {
+        pool: IPivotSummaryLevelPool;
+        fieldIdList: string[];
+    } | null;
+    _calculateSubtotalImp(levelPool: IPivotSummaryLevelPool, ignoreLeafSet: Set<number>): void;
 }

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

@@ -93,6 +93,7 @@ export interface IPivotTableValueFilter {
     type: PivotFilterTypeEnum.ValueFilter;
     operator: ST_PivotFilterOperatorEnum;
     expected: any;
+    valueFieldId: string;
 }
 export interface IPivotTableShowDataAsInfo {
     type: PivotShowAsTypeEnum;
@@ -149,6 +150,10 @@ export interface IPivotTableQueryData {
      * @property {Record<string, boolean|Record<string, boolean>>} - The collapse state of the pivot table.
      */
     collapseInfo: Record<string, boolean | Record<string, boolean>>;
+    /**
+     * The value filter info of the pivot table. The ordered should be ensured, because the value filter must be applied in order.
+     */
+    valueFilterInfo: IValueFilterInfoItem[];
 }
 /**
  * Represents the query data for a value field in a pivot table.
@@ -184,4 +189,17 @@ export interface IPivotTableMeasureData {
      */
     values: IPivotTableValueFieldQueryData[];
 }
+/**
+ * Represents the value filer item of the pivot table.
+ */
+export interface IValueFilterInfoItem {
+    /**
+     * @property {string} - The base field id of the value filter.
+     */
+    fieldId: string;
+    /**
+     * @property {string} - The value field item of the value filter.
+     */
+    filterInfo: IPivotTableValueFilter;
+}
 export {};

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

@@ -1,5 +1,5 @@
 import { PivotDataFieldDataTypeEnum, PivotLayoutTypeEnum, PivotSubtotalTypeEnum, PivotTableFiledAreaEnum, PivotTableValuePositionEnum } from './enum';
-import { IPivotTableFilterInfo, IPivotTableShowDataAsInfo, IPivotTableSortInfo } from './interface';
+import { IPivotTableFilterInfo, IPivotTableShowDataAsInfo, IPivotTableSortInfo, IPivotTableValueFilter, IValueFilterInfoItem } from './interface';
 import { IPivotTableOptions } from './layout-type';
 export interface IPivotTableValueFieldJSON {
     dataFieldId: string;
@@ -68,6 +68,10 @@ export interface IPivotTableSnapshot {
      */
     collapseInfo: Record<string, any>;
     options: IPivotTableOptions;
+    /**
+     * Represents the value filter information of the pivot table.The ordered should be ensured, because the value filter must be applied in order.
+     */
+    valueFilter: IValueFilterInfoItem[];
 }
 export interface IFieldsCollectionJSON {
     fieldIds: string[];
@@ -142,7 +146,11 @@ export declare enum PivotTableChangeTypeEnum {
     /**
      * Update source of the field in the pivot table.
      */
-    UpdateSource = 11
+    UpdateSource = 11,
+    /**
+     * Set value filter to the field in the pivot table.
+     */
+    SetValueFilter = 12
 }
 /**
  * The change of adding field to the pivot table.
@@ -353,6 +361,24 @@ export interface IPivotTableSetFilterInfoChange {
      */
     newFilterInfo: IPivotTableFilterInfo;
 }
+export interface IPivotTableSetValueFilterChange {
+    /**
+     * @property {PivotTableChangeTypeEnum} type The type of the change.
+     */
+    type: PivotTableChangeTypeEnum.SetValueFilter;
+    /**
+     * @property {string} fieldId The pivot table field id.
+     */
+    fieldId: string;
+    /**
+     * @property {IPivotTableValueFilter} oldFilterInfo The old filter information.
+     */
+    oldFilterInfo: IPivotTableValueFilter | undefined;
+    /**
+     * @property {IPivotTableValueFilter} filterInfo The new filter information.
+     */
+    filterInfo: IPivotTableValueFilter | undefined;
+}
 /**
  * The change of setting sort information to the field in the pivot table.
  */
@@ -416,4 +442,4 @@ export interface IPivotTableSetCollapseChange {
      */
     item?: string;
 }
-export type IPivotTableChangeSet = IPivotTableAddFieldChange | IPivotTableSetSubtotalTypeChange | IPivotTableRemoveFieldChange | IPivotTableRenameFieldChange | IPivotTableSetFilterInfoChange | IPivotTableSetSortInfoChange | IPivotTableUpdatePositionChange | IPivotTableUpdateValuePositionChange | IPivotTableSetOptionsChange | IPivotTableSetFormatChange | IPivotTableSetCollapseChange | IPivotUpdateSourceChange;
+export type IPivotTableChangeSet = IPivotTableAddFieldChange | IPivotTableSetSubtotalTypeChange | IPivotTableRemoveFieldChange | IPivotTableRenameFieldChange | IPivotTableSetFilterInfoChange | IPivotTableSetSortInfoChange | IPivotTableUpdatePositionChange | IPivotTableUpdateValuePositionChange | IPivotTableSetOptionsChange | IPivotTableSetFormatChange | IPivotTableSetCollapseChange | IPivotUpdateSourceChange | IPivotTableSetValueFilterChange;

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

@@ -2,7 +2,7 @@ import { PivotView } from '../layout/pivot-view';
 import { NodeTree } from '../summary/node-tree';
 import { SummaryManager } from '../summary/summary-manager';
 import { PivotErrorTypeEnum } from './enum';
-import { IPivotTableQueryData, IPivotTableValueFieldQueryData } from './interface';
+import { IPivotTableQueryData, IPivotTableValueFieldQueryData, IValueFilterInfoItem } from './interface';
 export interface IPivotViewItemData {
     [row: number]: IPivotViewColData;
 }
@@ -201,6 +201,7 @@ export interface IPivotLayoutCtx {
     measureIndexesMap: Record<string, number>;
     collapseInfo: Record<string, boolean | Record<string, boolean>>;
     repeatRowLabels: boolean;
+    valueFilterMap: Record<string, IValueFilterInfoItem>;
 }
 export interface IPageViewItemRange {
     row: number;

package/lib/types/util.d.ts

@@ -1,4 +1,5 @@
-import { IDataFieldValue, IDateValue, IMeasuresMapItem, IPivotTableCustomFilter, IPivotTableFilterInfo, IPivotTableManualFilter, IPivotTableSortInfo, ITupleItem, PivotCellStyleTypeEnum, PivotDataFieldDataTypeEnum, PivotSubtotalTypeEnum, PivotTableFiledAreaEnum, ST_PivotFilterOperatorEnum } from './types';
+import { IDataFieldValue, IDateValue, IMeasuresMapItem, IPivotTableCustomFilter, IPivotTableFilterInfo, IPivotTableManualFilter, IPivotTableSortInfo, ITupleItem, IValueFilterInfoItem, PivotErrorTypeEnum, ST_PivotFilterOperatorEnum, PivotCellStyleTypeEnum, PivotDataFieldDataTypeEnum, PivotSubtotalTypeEnum, PivotTableFiledAreaEnum } from './types';
+import { PivotTuple } from './summary/pivot-tuple';
 /**
  * - judge the value is date like type
  * @param {IDataFieldValue} value the date like value
@@ -100,7 +101,7 @@ export declare function getFilterStatusAndValue(filterInfo: IPivotTableFilterInf
  * @param {IPivotTableSortInfo} sortInfo the sort info
  * @returns {PivotCellStyleTypeEnum} the cell style type
  */
-export declare function getDimFilterSortStatus(filterInfo: IPivotTableFilterInfo | undefined, sortInfo: IPivotTableSortInfo): PivotCellStyleTypeEnum;
+export declare function getDimFilterSortStatus(filterInfo: IPivotTableFilterInfo | undefined, sortInfo: IPivotTableSortInfo, valueFilterInfo: IValueFilterInfoItem): PivotCellStyleTypeEnum;
 /**
  *  - use the paths and value index to get the unique key of in layout pivot view, which use same rule to create the key in pivot engine
  * @param {string[]} paths - the paths of the cell
@@ -123,3 +124,12 @@ export declare function unionSortedList(arrays: number[][]): number[];
  */
 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[][];
+export interface IValueFilterSummaryListItem {
+    tuple: PivotTuple;
+}
+export declare function subtotalTupleItemForValueFilter(summaryList: IValueFilterSummaryListItem[], tupleItem: ITupleItem | undefined, fieldId: string, subtotal: PivotSubtotalTypeEnum, v: number, p: number): void;
+export declare function isErrorTypeSubtotal(subtotal: number | {
+    errorType: PivotErrorTypeEnum;
+}): subtotal is {
+    errorType: PivotErrorTypeEnum;
+};