@univerjs-pro/engine-pivot 0.2.9 → 0.2.11

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

@@ -1,4 +1,4 @@
-import { IFieldsCollectionJSON } from '../types';
+import { IDataFieldInfo, IFieldsCollectionJSON } from '../types';
 import { DataFieldManager } from './data-field-manager';
 import { DataField } from './data-field';
 /**
@@ -28,8 +28,8 @@ export declare class FieldsCollection {
     hasField(fieldId: string): boolean;
     /**
      * find the is there has a data field whose name is the same as the sourceName.
-     * @param sourceName
-     * @returns
+     * @param {string} sourceName - the source name of the field.
+     * @returns {boolean} - true if has the field, otherwise false.
      */
     hasSourceName(sourceName: string): boolean;
     setRange(range: any): void;
@@ -63,7 +63,7 @@ export declare class FieldsCollection {
      * @description Gets the field by the specified name.
      * @returns {IDataFieldInfo[]} -returns the field infos.
      */
-    getFieldInfo(): import('../types').IDataFieldInfo[];
+    getFieldInfo(): IDataFieldInfo[];
     toJSON(): IFieldsCollectionJSON;
     fromJSON(jsonData: IFieldsCollectionJSON): void;
     dispose(): void;

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

@@ -1,4 +1,4 @@
-import { IColumnNodeSizeInfo, INodeSizeInfo, IPivotLayoutCtx, IPivotTableLabelFieldQueryData, IPivotTableQueryData } from '../types';
+import { IColumnNodeSizeInfo, INodeSizeInfo, IPivotLayoutCtx, IPivotTableLabelFieldQueryData, IPivotTableQueryData, PivotErrorTypeEnum } from '../types';
 import { SummaryManager } from '../summary/summary-manager';
 import { NodeTree } from '../summary/node-tree';
 import { PivotTable } from '../pivot/pivot-table';
@@ -18,12 +18,7 @@ export declare class BaseLayout {
     static layoutCorner(ctx: IPivotLayoutCtx): void;
     static layoutColHeader(ctx: IPivotLayoutCtx): void;
     static setValueSize(ctx: IPivotLayoutCtx): void;
-    static layoutNoneColFields(ctx: IPivotLayoutCtx, nodeTree: NodeTree): {
-        itemSize: number;
-        topTotalSize: number;
-        bottomTotalSize: number;
-        colPathMap: Record<string, number>;
-    };
+    static layoutNoneColFields(ctx: IPivotLayoutCtx, nodeTree: NodeTree): IColumnNodeSizeInfo;
     static layoutColFields(ctx: IPivotLayoutCtx): void;
     /**
      * - the node is leaf node when the level of the node is equal to the deep, but the node is not the real leaf node
@@ -41,7 +36,7 @@ export declare class BaseLayout {
      * @returns {number} - the value of the node
      */
     static getNodeValue(ctx: IPivotLayoutCtx, nodeTree: NodeTree, measureIndex: number): number | {
-        errorType: import('../types').PivotErrorTypeEnum;
+        errorType: PivotErrorTypeEnum;
     } | undefined;
     static doColLeafNode(ctx: IPivotLayoutCtx, nodeTree: NodeTree, col: number, valueIds: string[]): IColumnNodeSizeInfo;
     static buildColPathMap(ctx: IPivotLayoutCtx, nodeTree: NodeTree): Record<string, number>;

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

@@ -2,7 +2,8 @@ import { PivotTable } from '../pivot/pivot-table';
 import { SummaryManager } from '../summary/summary-manager';
 import { IPivotLayoutCtx, IPivotTableQueryData } from '../types';
 import { BaseLayout } from './base-layout';
+import { PivotView } from './pivot-view';
 export declare class CompactLayout extends BaseLayout {
-    static layout(pivotTable: PivotTable, SummaryManager: SummaryManager, queryData: IPivotTableQueryData): import('./pivot-view').PivotView;
+    static layout(pivotTable: PivotTable, SummaryManager: SummaryManager, queryData: IPivotTableQueryData): PivotView;
     static layoutRow(ctx: IPivotLayoutCtx): void;
 }

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

@@ -2,7 +2,8 @@ import { PivotTable } from '../pivot/pivot-table';
 import { SummaryManager } from '../summary/summary-manager';
 import { IPivotLayoutCtx, IPivotTableQueryData } from '../types';
 import { BaseLayout } from './base-layout';
+import { PivotView } from './pivot-view';
 export declare class OutlineLayout extends BaseLayout {
-    static layout(pivotTable: PivotTable, SummaryManager: SummaryManager, queryData: IPivotTableQueryData): import('./pivot-view').PivotView;
+    static layout(pivotTable: PivotTable, SummaryManager: SummaryManager, queryData: IPivotTableQueryData): PivotView;
     static layoutRow(ctx: IPivotLayoutCtx): void;
 }

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

@@ -1,5 +1,5 @@
 import { PivotModel } from '../pivot/model';
-import { ILabelViewHeaderMapItem, ILabelViewItemJSON, IPageViewItemJSON, IPageViewItemRange, IPivotViewErrorValue, IPivotViewInfo, IPivotViewItemData, IPivotViewItemJSON, IPivotViewJSON, IPivotViewPrefixValue, IPivotViewValueType, PivotCellStyleTypeEnum } from '../types';
+import { ILabelViewHeaderMapItem, ILabelViewItemJSON, IPageViewItemJSON, IPageViewItemRange, 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
@@ -63,14 +63,18 @@ export declare class PivotViewItem {
     info: IPivotViewInfo[];
     lastCol: number;
     lastRow: number;
+    getLastCol(): number;
+    getLastRow(): number;
     setValue(row: number, col: number, value: IPivotViewValueType): void;
     setStyle(row: number, col: number, styleType: PivotCellStyleTypeEnum): void;
     setBlank(row: number, col: number): void;
-    protected getCell(row: number, col: number): import('../types').IPivotViewCellData;
+    protected getCell(row: number, col: number): IPivotViewCellData;
     setInfo(index: number, info: IPivotViewInfo): void;
     buildPathMap(considerValue: boolean): Record<string, number>;
     setRowCount(rowCount: number): void;
     setColCount(colCount: number): void;
+    getRowCount(): number;
+    getColCount(): number;
     getValue(row: number, col: number): IPivotViewValueType;
     getStyle(row: number, col: number): PivotCellStyleTypeEnum | undefined;
     toJSON(): IPivotViewItemJSON;
@@ -111,6 +115,12 @@ export declare class LabelViewItem extends PivotViewItem {
     toJSON(): ILabelViewItemJSON;
     fromJSON(json: ILabelViewItemJSON): void;
 }
+export declare class RowViewItem extends LabelViewItem {
+    getLastCol(): number;
+}
+export declare class ColViewItem extends LabelViewItem {
+    getLastRow(): number;
+}
 /**
  * judge the value is the prefix value, once when the value is a subtotal and there are multiple value field, the value will be the prefix value
  * @param {IPivotViewValueType} value the pivot view value

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

@@ -1,23 +1,14 @@
 import { PivotTable } from '../pivot/pivot-table';
 import { NodeTree } from '../summary/node-tree';
 import { SummaryManager } from '../summary/summary-manager';
-import { INodeSizeInfo, IPivotLayoutCtx, IPivotTableQueryData, IPivotTableValueFieldQueryData, IPivotViewInfo } from '../types';
+import { INodeSizeInfo, IPivotLayoutCtx, IPivotTableQueryData, IPivotTableValueFieldQueryData, IPivotViewInfo, IRowNodeSizeInfo } from '../types';
 import { BaseLayout } from './base-layout';
+import { PivotView } from './pivot-view';
 export declare class TabularLayout extends BaseLayout {
-    static layout(pivotTable: PivotTable, summaryManager: SummaryManager, queryData: IPivotTableQueryData): import('./pivot-view').PivotView;
+    static layout(pivotTable: PivotTable, summaryManager: SummaryManager, queryData: IPivotTableQueryData): PivotView;
     static layoutCorner(ctx: IPivotLayoutCtx): void;
     static layoutRowFields(ctx: IPivotLayoutCtx): void;
-    static doRowLeafNode(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, valueIds: string[]): {
-        itemSize: number;
-        topTotalSize: number;
-        bottomTotalSize: number;
-        valueIndex?: undefined;
-    } | {
-        itemSize: number;
-        topTotalSize: number;
-        bottomTotalSize: number;
-        valueIndex: number;
-    };
+    static doRowLeafNode(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, valueIds: string[]): IRowNodeSizeInfo;
     /**
      *  - layout the data area of the pivot table
      * @param {IPivotLayoutCtx} ctx the context of layout
@@ -31,11 +22,7 @@ export declare class TabularLayout extends BaseLayout {
     static getMeasureInfoByIndex(ctx: IPivotLayoutCtx, valueQueryInfo: IPivotTableValueFieldQueryData[], rowInfo: IPivotViewInfo, colInfo: IPivotViewInfo): IPivotTableValueFieldQueryData;
     static layoutValueLeafNode(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, paths: string[], measureIndex: number): void;
     static getColIndexForRowHeader(nodeLevel: number, valueIndex: number, hasMultiValue: boolean): number;
-    static doRowBrachNode(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, valueIds: string[]): {
-        itemSize: number;
-        topTotalSize: number;
-        bottomTotalSize: number;
-    };
+    static doRowBrachNode(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, valueIds: string[]): INodeSizeInfo;
     static layoutRowNode(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, valueIds: string[]): INodeSizeInfo;
     static updateRowSubtotal(ctx: IPivotLayoutCtx, row: number, nodeTree: NodeTree, valueIds: string[]): void;
 }

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

@@ -94,16 +94,7 @@ export declare class PivotModel {
      *  - Get the options of the pivot table. It is a copy of the options.
      * @returns {IPivotTableOptions} - The options of the pivot table.
      */
-    getOptions(): {
-        pageWrap?: number;
-        pageOverThenDown?: boolean;
-        showColHeaders?: boolean;
-        showColStripes?: boolean;
-        showLastColumn?: boolean;
-        showRowHeaders?: boolean;
-        showRowStripes?: boolean;
-        mergeItems?: boolean;
-    };
+    getOptions(): IPivotTableOptions;
     /**
      * @description Set the collapse status of the field. Those properties are used to save the collapse status of the field in the pivot table.
      * @param {string} fieldId - The id of the field.
@@ -115,7 +106,7 @@ export declare class PivotModel {
     getFieldFormat(fieldId: string): string | undefined;
     setFieldFormat(fieldId: string, format: string | undefined): void;
     setSortInfo(fieldId: string, sortInfo: IPivotTableSortInfo | undefined): void;
-    getSortInfo(fieldId: string): import('../types').IPivotTableLabelSortInfo | undefined;
+    getSortInfo(fieldId: string): IPivotTableSortInfo | undefined;
     getFilterInfo(fieldId: string): IPivotTableFilterInfo | undefined;
     iterateField(callback: (field: PivotTableLabelField | PivotTableValueField) => void): void;
     iterateFieldDim(callback: (field: PivotTableLabelField) => void): void;
@@ -129,12 +120,12 @@ export declare class PivotModel {
      */
     addField(field: PivotTableLabelField | PivotTableValueField, area: PivotTableFiledAreaEnum, index?: number): void;
     /**
-     * @description get where the field bo be position info by field id.
+     * @description Get where the field bo be position info by field id.
      * @param {string} fieldId - The id of the field.
-     * @typedef
+     * @typedef PositionInfo
      * @property {PivotTableFiledAreaEnum} area - The area of the field.
      * @property {number} index - The index of the field in the area.
-     * @returns PivotTableFiledAreaEnum
+     * @returns PositionInfo - The position info of the field. if the field is not in the pivot table, the area will be undefined and the index will be -1.
      */
     getFieldPositionInfoById(fieldId: string): {
         area: PivotTableFiledAreaEnum | undefined;
@@ -142,7 +133,7 @@ export declare class PivotModel {
     };
     updateFieldSourceInfo(fieldId: string, sourceName: string, dataFieldId: string): void;
     getFieldsAreaByType(type: PivotTableFiledAreaEnum): string[];
-    getFieldById(fieldId: string): PivotTableValueField | PivotTableLabelField | undefined;
+    getFieldById(fieldId: string): PivotTableLabelField | PivotTableValueField | undefined;
     isExistFieldName(fieldName: string): boolean;
     /**
      * @description Rename a field in the pivot table.

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

@@ -1,6 +1,7 @@
 import { FieldsCollection } from '../field/fields-collection';
-import { PivotDataFieldDataTypeEnum, PivotSubtotalTypeEnum, IPivotTableFilterInfo, IPivotTableOptions, IPivotTableQueryData, IPivotTableSnapshot, IPivotTableSortInfo, PivotTableFiledAreaEnum, PivotTableValuePositionEnum } from '../types';
+import { PivotDataFieldDataTypeEnum, PivotSubtotalTypeEnum, IPivotTableChangeSet, IPivotTableFilterInfo, IPivotTableOptions, IPivotTableQueryData, IPivotTableSnapshot, IPivotTableSortInfo, PivotTableFiledAreaEnum, PivotTableValuePositionEnum } from '../types';
 import { DataField } from '../field/data-field';
+import { PivotView } from '../layout/pivot-view';
 import { PivotModel } from './model';
 import { PivotTableLabelField, PivotTableValueField } from './table-field';
 /**
@@ -18,7 +19,7 @@ export declare class PivotTable {
     updateDataFieldsCollection(dataFieldsCollection: FieldsCollection): void;
     private _getModel;
     startCollectChangeset(): void;
-    endCollectChangeset(): import('../types').IPivotTableChangeSet[];
+    endCollectChangeset(): IPivotTableChangeSet[];
     _generateModel(): void;
     createLabelFieldByDataFieldId(dataFieldId: string, tableName?: string): PivotTableLabelField | undefined;
     createValueFieldByDataFieldId(dataFieldId: string): PivotTableValueField | undefined;
@@ -98,7 +99,7 @@ export declare class PivotTable {
      * @param {string} dataFieldId the data field id
      * @returns {DataField|undefined} the data field or undefined
      */
-    getDataFieldByDataFieldId(dataFieldId: string): DataField;
+    getDataFieldByDataFieldId(dataFieldId: string): DataField | undefined;
     getDataFieldItemInfo(dataField: DataField): {
         items: string[];
         itemTypes: PivotDataFieldDataTypeEnum[];
@@ -111,7 +112,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): PivotTableValueField | PivotTableLabelField | undefined;
+    addFieldWithSourceId(dataFieldId: string, area: PivotTableFiledAreaEnum, index?: number): PivotTableLabelField | PivotTableValueField | undefined;
     setOptions(options: IPivotTableOptions): void;
     /**
      *  the func is only use for when refresh
@@ -149,14 +150,14 @@ export declare class PivotTable {
      * @param fieldId - The id of the field.
      * @returns {IPivotTableSortInfo} -The sort information of the field.
      */
-    getSortInfo(fieldId: string): import('../types').IPivotTableLabelSortInfo | undefined;
+    getSortInfo(fieldId: string): IPivotTableSortInfo | undefined;
     getFilterInfo(fieldId: string): IPivotTableFilterInfo | undefined;
     /**
      * get the filter information by the filter index
      * @param {number} index - The index of the filter field.
      * @returns {string | undefined} the table field id
      */
-    getFilterFieldIdByIndex(index: number): string;
+    getFilterFieldIdByIndex(index: number): string | undefined;
     /**
      * - set the position of the field in the pivot table. which used in pivot panel drag field.
      * @param {string} fieldId - The id of the pivot table field.
@@ -189,16 +190,7 @@ export declare class PivotTable {
      */
     addField(field: PivotTableLabelField | PivotTableValueField, area: PivotTableFiledAreaEnum, index?: number): void;
     removeField(fieldId: string): void;
-    getOptions(): {
-        pageWrap?: number;
-        pageOverThenDown?: boolean;
-        showColHeaders?: boolean;
-        showColStripes?: boolean;
-        showLastColumn?: boolean;
-        showRowHeaders?: boolean;
-        showRowStripes?: boolean;
-        mergeItems?: boolean;
-    };
+    getOptions(): IPivotTableOptions;
     /**
      * @description Set the collapse status of the field. Those properties are used to save the collapse status of the field in the pivot table.
      * @param {string} fieldId - The id of the field.
@@ -212,12 +204,17 @@ export declare class PivotTable {
      * @returns {boolean} - need query or not
      */
     getNeedQuery(viewVersion: number): boolean;
+    /**
+     * @description Get the field position information by the field id.
+     * @param {string} fieldId the field id
+     * @returns {PositionInfo} - The position information of the field or undefined.
+     */
     getFieldPositionInfoById(fieldId: string): {
         area: PivotTableFiledAreaEnum | undefined;
         index: number;
     };
     private _getTupleCache;
-    query(config?: IPivotTableQueryData): import('..').PivotView;
+    query(config?: IPivotTableQueryData): PivotView;
     toJSON(): IPivotTableSnapshot;
     fromJSON(data: IPivotTableSnapshot): void;
     dispose(): void;

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

@@ -44,5 +44,5 @@ export declare class NodeTree {
     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;
+    getNode(path: string): NodeTree | undefined;
 }

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

@@ -1,5 +1,5 @@
 import { DataField } from '../field/data-field';
-import { IDimensionMapItem, IMeasuresMapItem, IPivotSummaryLevelPool, IPivotTableQueryData, ITupleItem, PivotSubtotalTypeEnum, PivotDataFieldSortOperatorEnum } from '../types';
+import { IDimensionMapItem, IMeasuresMapItem, IPivotSummaryLevelPool, IPivotTableQueryData, ITupleItem, PivotErrorTypeEnum, PivotSubtotalTypeEnum, PivotDataFieldSortOperatorEnum } from '../types';
 import { NodeTree } from './node-tree';
 import { TupleGroup } from './tuple-group';
 export declare class SummaryManager {
@@ -47,7 +47,7 @@ export declare class SummaryManager {
     constructor(queryData: IPivotTableQueryData, tupleGroup: TupleGroup);
     createSummaryLabelSortedMap(queryData: IPivotTableQueryData): void;
     getCellValue(index: number, id: string, subtotal: PivotSubtotalTypeEnum): number | {
-        errorType: import('../types').PivotErrorTypeEnum;
+        errorType: PivotErrorTypeEnum;
     } | undefined;
     getSortedMap(tableFieldId: string, dataField: DataField): Record<string, number>;
     doSummary(): void;

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

@@ -174,6 +174,9 @@ export interface INodeSizeInfo {
 export interface IColumnNodeSizeInfo extends INodeSizeInfo {
     colPathMap: Record<string, number>;
 }
+export interface IRowNodeSizeInfo extends INodeSizeInfo {
+    valueIndex?: number;
+}
 export interface IPivotLayoutCtx {
     view: PivotView;
     rowDeep: number;