@univerjs-pro/engine-pivot 0.2.9

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

@@ -0,0 +1,131 @@
+import { IPivotTableFilterInfo, IPivotTableLabelFieldJSON, IPivotTableLabelFieldQueryData, IPivotTableShowDataAsInfo, IPivotTableSortInfo, IPivotTableValueFieldJSON, IPivotTableValueFieldQueryData, PivotSubtotalTypeEnum } from '../types';
+/**
+ * Represents a base class for the field in a pivot table.
+ * @abstract
+ * @description The base class for the field in a pivot table.
+ * @property {string} dataFieldId - The base data field id of the field.
+ * @property {string} id - The unique identifier of the field.
+ * @property {string} displayName - The display name of the field. the default value is the data field name.
+ * @property {string} lossLessProperty - thr public object to save the property not defined but should be saved.
+ *
+ */
+export declare abstract class PivotTableFieldBase {
+    /**
+     * @property {string} - The base data field id of the field.
+     */
+    readonly dataFieldId: string;
+    readonly id: string;
+    readonly sourceName: string;
+    displayName: string;
+    format: string | undefined;
+    lossLessProperty?: any;
+    constructor(dataFieldId: string, id: string, displayName: string | undefined, sourceName: string);
+    getId(): string;
+    /**
+     * - the read only name in collection
+     * @returns {string} - the source name of the field, which is the name of the data field.
+     */
+    getSourceName(): string;
+    setSourceName(sourceName: string): void;
+    setDataFieldId(dataFieldId: string): void;
+    getDataFieldId(): string;
+    getFormat(): string | undefined;
+    setFormat(format: string | undefined): void;
+    setDisplayName(displayName: string): void;
+    getDisplayName(): string;
+    /**
+     * @abstract
+     */
+    abstract toJSON(): object;
+    /**
+     * @abstract
+     * @param {object} data - the data config a field.
+     */
+    abstract fromJSON(data: object): void;
+    /**
+     * @abstract
+     * @returns {object} - the query data of the field.
+     */
+    abstract getQueryData(): object;
+}
+export declare class PivotTableValueField extends PivotTableFieldBase {
+    subtotal: PivotSubtotalTypeEnum;
+    showDataAs: IPivotTableShowDataAsInfo;
+    constructor(dataFieldId: string, id: string, displayName: string | undefined, sourceName: string);
+    setSubtotal(subtotal: PivotSubtotalTypeEnum): void;
+    getSubtotal(): PivotSubtotalTypeEnum;
+    setShowDataAs(showDataAs: IPivotTableShowDataAsInfo): void;
+    getShowDataAs(): IPivotTableShowDataAsInfo;
+    getQueryData(): IPivotTableValueFieldQueryData;
+    /**
+     * @override
+     * @returns {IPivotTableValueFieldJSON} - the JSON data of the value field.
+     */
+    toJSON(): IPivotTableValueFieldJSON;
+    /**
+     * @override
+     * @param data
+     */
+    fromJSON(data: IPivotTableValueFieldJSON): void;
+}
+/**
+ * Represents a label field in a pivot table.
+ */
+export declare class PivotTableLabelField extends PivotTableFieldBase {
+    sortInfo: IPivotTableSortInfo | undefined;
+    filterInfo: IPivotTableFilterInfo;
+    constructor(dataFieldId: string, id: string, displayName: string | undefined, sourceName: string);
+    /**
+     * @method setSortInfo
+     * @description Set the sort information of the label field.
+     * @param {IPivotTableSortInfo} sortInfo - The sort information of the label field.
+     */
+    setSortInfo(sortInfo: IPivotTableSortInfo | undefined): void;
+    /**
+     * @method getSortInfo
+     * @description Get the sort information of the label field.
+     * @returns {IPivotTableSortInfo} The sort information of the label field.
+     */
+    getSortInfo(): IPivotTableSortInfo | undefined;
+    /**
+     * @method setFilterInfo
+     * @description Set the filter information of the label field. Only one of the manual filter, custom filter or value filter can be effective.
+     * @param {IPivotTableFilterInfo} filterInfo - The filter information of the label field. the manual filter, custom filter or value filter is opposite to each other.
+     */
+    setFilterInfo(filterInfo: IPivotTableFilterInfo): void;
+    /**
+     * @method getFilterInfo
+     * @description Get the filter information of the label field.
+     * @returns {IPivotTableFilterInfo} The filter information of the label field.
+     */
+    getFilterInfo(): IPivotTableFilterInfo;
+    getQueryData(): IPivotTableLabelFieldQueryData;
+    toJSON(): IPivotTableLabelFieldJSON;
+    fromJSON(data: IPivotTableLabelFieldJSON): void;
+}
+/**
+ * Clone the label field to a value field.
+ * @param {PivotTableLabelField} labelField - The label field to be cloned.
+ * @param {boolean} [keepUnknown] - Whether to keep the unknown property of the label field. the default value is true.
+ * @returns {PivotTableValueField} - the value field may has sortInfo and filterInfo in the property lossLessProperty.
+ */
+export declare function cloneLabelFieldToValueField(labelField: PivotTableLabelField, keepUnknown?: boolean): PivotTableValueField;
+/**
+ * Clone the value field to a label field.
+ * @param {PivotTableValueField} valueField - The value field to be cloned.
+ * @param {boolean} [keepUnknown] - Whether to keep the unknown property of the value field. the default value is true.
+ * @returns {PivotTableLabelField} - the label field may has sortInfo and filterInfo in the property lossLessProperty.
+ */
+export declare function cloneValueFieldToLabelField(valueField: PivotTableValueField, keepUnknown?: boolean): PivotTableLabelField;
+/**
+ * - Create a value field from the JSON data.
+ * @param {IPivotTableValueFieldJSON} data - The JSON data of the value field.
+ * @returns {PivotTableValueField} - The value field created from the JSON data.
+ */
+export declare function createValueField(data: IPivotTableValueFieldJSON): PivotTableValueField;
+/**
+ * - Create a label field from the JSON data.
+ * @param {IPivotTableLabelFieldJSON} data - The JSON data of the label field.
+ * @returns {PivotTableLabelField} - The label field created from the JSON data.
+ */
+export declare function createLabelField(data: IPivotTableLabelFieldJSON): PivotTableLabelField;

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

@@ -0,0 +1,48 @@
+import { PivotDataFieldDataTypeEnum } from '../types';
+export declare class NodeTree {
+    /**
+     * @property {number} index - The id of the node tree.which is the index of summary-manager tuples
+     */
+    private readonly _index;
+    /**
+     * @property {number} level - The level of the node tree. the root level is 0.
+     */
+    private _level;
+    /**
+     * @property {number} parentIndex - The parent index of the node tree. the root node parent index is -1.
+     */
+    parentIndex: number;
+    paths: string[];
+    isLeaf: boolean;
+    /**
+     * @property {string} name - The name of the node tree.
+     */
+    name: string;
+    fieldId: string;
+    collapse: boolean;
+    sortedList: string[];
+    hasSort: boolean;
+    /**
+     * - the data type of the node tree.
+     */
+    type: PivotDataFieldDataTypeEnum;
+    private _nodes;
+    constructor(index: number, fieldId: string, type: PivotDataFieldDataTypeEnum);
+    getCollapse(): boolean;
+    setCollapse(collapse: boolean): void;
+    getFieldsId(): string;
+    iterate(callback: (node: NodeTree) => void): void;
+    getIndex(): number;
+    hasNode(path: string): boolean;
+    setParentIndex(parentIndex: number): void;
+    setLevel(level: number): void;
+    getLevel(): number;
+    setPaths(paths: string[]): void;
+    getPaths(): string[];
+    setLeaf(): void;
+    getIsLeaf(): boolean;
+    setName(name: string): void;
+    addNode(node: NodeTree, path: string, sortMap: Record<string, number> | undefined, isAsc: boolean): void;
+    sortNode(path: string, sortedMap: Record<string, number>, isAsc: boolean): void;
+    getNode(path: string): NodeTree;
+}

package/lib/types/summary/pivot-tuple.d.ts

@@ -0,0 +1,24 @@
+import { IDataFieldValue, ITPivotTupleInfo, PivotErrorTypeEnum, PivotSubtotalTypeEnum } from '../types';
+/**
+ * @class PivotTuple
+ * @description use Welford algorithm calc subtotal
+ * https://en.wikipedia.org/wiki/Algorithms_for_calculating_variance
+ */
+export declare class PivotTuple {
+    private _sum;
+    private _count;
+    private _countN;
+    private _product;
+    private _min;
+    private _max;
+    private _squareSum;
+    constructor();
+    getInfo(): ITPivotTupleInfo;
+    reset(): void;
+    addValue(value: IDataFieldValue): void;
+    unionTuples(tuples: PivotTuple[]): void;
+    unionTupleInfo(tupleInfo: ITPivotTupleInfo): void;
+    getSubtotal(subtotalType: PivotSubtotalTypeEnum): number | {
+        errorType: PivotErrorTypeEnum;
+    };
+}

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

@@ -0,0 +1,72 @@
+import { DataField } from '../field/data-field';
+import { IDimensionMapItem, IMeasuresMapItem, IPivotSummaryLevelPool, IPivotTableQueryData, ITupleItem, PivotSubtotalTypeEnum, PivotDataFieldSortOperatorEnum } from '../types';
+import { NodeTree } from './node-tree';
+import { TupleGroup } from './tuple-group';
+export declare class SummaryManager {
+    counter: number;
+    rowDimOrder: number[];
+    colDimOrder: number[];
+    rowTableIdList: string[];
+    colTableIdList: string[];
+    rowDeep: number;
+    colDeep: number;
+    measureCount: number;
+    leafCount: number;
+    measuresMap: Record<string, IMeasuresMapItem>;
+    /**
+     * @property The tuples of the pivot table, it contains the path, indexes, and save the measure value of each tuple.
+     */
+    tuples: ITupleItem[];
+    /**
+     * @property The map of tuple, it is used to quickly find the tuple by the path of tuple. the key is the path of tuple, the value is the index of tuple in tuples.
+     */
+    tupleMap: Record<string, number>;
+    /**
+     * @property The dimensionIdList, it contains the id of dimension fields.Only the the row and col fields are dimension fields.
+     */
+    dimensionIdList: string[];
+    dimensionTableIdList: string[];
+    /**
+     * @property The measureIdList, it contains the id of measure fields.It used to quickly find the measure field.
+     */
+    measureIdList: string[];
+    _rowLevelPool: IPivotSummaryLevelPool;
+    _colLevelPool: IPivotSummaryLevelPool;
+    rowNodeTree: NodeTree;
+    colNodeTree: NodeTree;
+    dimensionMap: Record<string, IDimensionMapItem>;
+    /**
+     * fist Record key is combinePathMap
+     */
+    combinePathMap: Record<string, Record<string, number>>;
+    collapseInfo: Record<string, boolean | Record<string, boolean>>;
+    dimensionSortInfo: Record<string, {
+        type: PivotDataFieldSortOperatorEnum;
+        sortMap: Record<string, number>;
+    }>;
+    constructor(queryData: IPivotTableQueryData, tupleGroup: TupleGroup);
+    createSummaryLabelSortedMap(queryData: IPivotTableQueryData): void;
+    getCellValue(index: number, id: string, subtotal: PivotSubtotalTypeEnum): number | {
+        errorType: import('../types').PivotErrorTypeEnum;
+    } | undefined;
+    getSortedMap(tableFieldId: string, dataField: DataField): Record<string, number>;
+    doSummary(): void;
+    private _getIndex;
+    buildNodeTree(): void;
+    createTupleWithoutCheck(paths: string[], nodeIndex: number, tupleKey: string): void;
+    _buildNodeTreeImp(dimOrder: number[], tableIdList: string[], levelPool: IPivotSummaryLevelPool, nodePathStr: string): NodeTree;
+    combinePathMapList(colPathMapList: Record<string, number>[], basePath: string): Record<string, number>;
+    calculateListSubtotal(tupleItem: ITupleItem, indexes: number[]): void;
+    calculateSubtotal(): void;
+    getPathKeyWithFiledId(paths: string[], tableIdList: string[]): string;
+    ensureTupleItem(index: number, paths: string[], tableIdList: string[]): void;
+    ensureTupleItemByString(index: number, pathString: string): void;
+    /**
+     * - create tuple if not exist
+     * @param {string[]} paths the path of tuple
+     * @param {string} [pathsStr] the joined path string of tuple
+     * @returns {void}
+     */
+    createTuple(paths: string[], pathsStr?: string, nodeIndex?: number): void;
+    _calculateSubtotalImp(levelPool: IPivotSummaryLevelPool): void;
+}

package/lib/types/summary/tuple-group.d.ts

@@ -0,0 +1,82 @@
+import { FieldsCollection } from '../field/fields-collection';
+import { IDimensionMapItem, IMeasuresMapItem, IPivotTableQueryData, ITupleItem, PivotDataFieldDataTypeEnum } from '../types';
+export declare class TupleGroup {
+    /**
+     * @property The tuples of the pivot table, it contains the path, indexes, and save the measure value of each tuple.
+     */
+    tuples: ITupleItem[];
+    /**
+     * @property The map of tuple, it is used to quickly find the tuple by the path of tuple. the key is the path of tuple, the value is the index of tuple in tuples.
+     */
+    tupleMap: Record<string, number>;
+    /**
+     * @property The measuresMap, it contains the field and subtotal of each measure.
+     */
+    measuresMap: Record<string, IMeasuresMapItem>;
+    /**
+     * @property The dimensionIdList, it contains the id of dimension fields.Only the the row and col fields are dimension fields.
+     */
+    dimensionIdList: string[];
+    dimensionTableIdList: string[];
+    /**
+     * @property The measureIdList, it contains the id of measure fields.It used to quickly find the measure field.
+     */
+    measureIdList: string[];
+    /**
+     * @property The dimensionMap, it contains the field of each dimension.
+     */
+    dimensionMap: Record<string, IDimensionMapItem>;
+    /**
+     * @property The rowDeep, the deep of row fields.
+     */
+    rowDeep: number;
+    /**
+     * @property The colDeep, the deep of col fields.
+     */
+    colDeep: number;
+    constructor();
+    /**
+     * - prepare the measuresMap and dimensionMap, it will prepare the measuresMap and dimensionMap based on the query data
+     * @param {FieldsCollection} dataFieldsCollection - the fields collection of pivot table
+     * @param {IPivotTableQueryData} queryData - the query data of pivot table, which contains the value, row, col, filter information,it the configuration of pivot table
+     */
+    prepare(dataFieldsCollection: FieldsCollection, queryData: IPivotTableQueryData): void;
+    /**
+     * - filter the data records by the query data
+     * @param {IPivotTableQueryData} queryData - the query data of pivot table, which contains the value, row, col, filter information,it the configuration of pivot table
+     * @returns {number[]} list - the indexes of data records, which is used to iterate the data records, isALL - whether all the data records are selected
+     */
+    filter(queryData: IPivotTableQueryData): {
+        isAll: boolean;
+        list: number[];
+    };
+    /**
+     * - the core method of tuple group, it will prepare, filter, iterate the data records, and create or update tuple
+     * @param {FieldsCollection} dataFieldsCollection - the fields collection of pivot table
+     * @param {IPivotTableQueryData} queryData - the query data of pivot table, which contains the value, row, col, filter information,it the configuration of pivot table
+     * @returns {void}
+     */
+    query(dataFieldsCollection: FieldsCollection, queryData: IPivotTableQueryData): void;
+    reset(): void;
+    /**
+     * - iterate the indexes of data records, and create or update tuple
+     * @param {boolean} isALL - whether all the data records are selected
+     * @param {number} indexes - the indexes of data records
+     */
+    iterate(isALL: boolean, indexes: number[], recordCount?: number): void;
+    /**
+     * - create or update tuple, which is the core logic of tuple group, it will create a new tuple if not exist, or update the existing tuple., the judgment is based on the paths of tuple.
+     * @param {string} paths the path of tuple
+     * @param {string} pathsWithField the joined path string of tuple
+     * @param {number} index the index of data
+     * @returns {void}
+     */
+    createOrUpdateTuple(paths: string[], pathsWithField: string[], index: number, types: PivotDataFieldDataTypeEnum[]): void;
+    /**
+     * - create tuple if not exist
+     * @param {string[]} paths the path of tuple
+     * @param {string} [pathsStr] the joined path string of tuple
+     * @returns {void}
+     */
+    createTuple(paths: string[], pathsStr?: string, nodeIndex?: number, types?: PivotDataFieldDataTypeEnum[]): void;
+}