@univerjs-pro/engine-pivot 0.2.9

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

@@ -0,0 +1,63 @@
+import { IColumnNodeSizeInfo, INodeSizeInfo, IPivotLayoutCtx, IPivotTableLabelFieldQueryData, IPivotTableQueryData } from '../types';
+import { SummaryManager } from '../summary/summary-manager';
+import { NodeTree } from '../summary/node-tree';
+import { PivotTable } from '../pivot/pivot-table';
+import { PageViewItem } from './pivot-view';
+export declare class BaseLayout {
+    /**
+     *
+     * @param pivotTable - the pivot table
+     * @param summaryManager - the summary manager
+     * @returns {IPivotLayoutCtx} the layout context
+     */
+    static prepareLayoutCtx(pivotTable: PivotTable, summaryManager: SummaryManager, queryData: IPivotTableQueryData): IPivotLayoutCtx;
+    static layoutPage(ctx: IPivotLayoutCtx): void;
+    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 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 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
+     * @param {NodeTree} nodeTree - the node tree
+     * @param {number} deep - the deep of the tree
+     * @returns {boolean} - the node is leaf node or not
+     */
+    static isLeafNode(nodeTree: NodeTree, deep: number): boolean;
+    static getRealSize(sizeInfo: INodeSizeInfo): number;
+    /**
+     * - get the node value from the summary manager, the node index is the tuples of summary manager
+     * @param {IPivotLayoutCtx} ctx
+     * @param {NodeTree} nodeTree
+     * @param {number} measureIndex
+     * @returns {number} - the value of the node
+     */
+    static getNodeValue(ctx: IPivotLayoutCtx, nodeTree: NodeTree, measureIndex: number): number | {
+        errorType: import('../types').PivotErrorTypeEnum;
+    } | undefined;
+    static doColLeafNode(ctx: IPivotLayoutCtx, nodeTree: NodeTree, col: number, valueIds: string[]): IColumnNodeSizeInfo;
+    static buildColPathMap(ctx: IPivotLayoutCtx, nodeTree: NodeTree): Record<string, number>;
+    static iterateColLeafNodeChildren(ctx: IPivotLayoutCtx, nodeTree: NodeTree, paths: string[], map: Record<string, number>): void;
+    /**
+     * - build the path map for the collapse node
+     * @param ctx - the layout context
+     * @param nodeTree - the node tree
+     * @param colPathMapList - the path map list
+     */
+    static buildColPathMapForCollapse(ctx: IPivotLayoutCtx, nodeTree: NodeTree, colPathMapList: Record<string, number>[]): void;
+    static doColBranchNode(ctx: IPivotLayoutCtx, nodeTree: NodeTree, col: number, valueIds: string[]): IColumnNodeSizeInfo;
+    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 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/compact.d.ts

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

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

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

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

@@ -0,0 +1,125 @@
+import { PivotModel } from '../pivot/model';
+import { ILabelViewHeaderMapItem, ILabelViewItemJSON, IPageViewItemJSON, IPageViewItemRange, 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
+ */
+export declare class PivotView {
+    /**
+     * the page view of the pivot table
+     */
+    pageView: PageViewItem;
+    /**
+     * the row view of the pivot table
+     */
+    rowView: LabelViewItem;
+    /**
+     * the col view of the pivot table
+     */
+    colView: LabelViewItem;
+    /**
+     * the data view of the pivot table
+     */
+    dataView: PivotViewItem;
+    /**
+     * the corner view of the pivot table
+     */
+    cornerView: PivotViewItem;
+    /**
+     * the version of the pivot view, it will be used to check the view is the latest
+     */
+    version: number;
+    /**
+     * the format map of the table field id, it will be used to store the format of the pivot view
+     */
+    formatMap: Record<string, string>;
+    constructor();
+    setVersion(version?: number): void;
+    /**
+     * - the func effect is to set the format code , for label view, it will used to format the header , such as date type data, in the data view, it will used to format the data of show data as
+     * @param model the pivot model, it will be used to set the format of the pivot view
+     */
+    setFormat(model: PivotModel): void;
+    getVersion(): number;
+    toJSON(): IPivotViewJSON;
+    formJSON(data: IPivotViewJSON): void;
+}
+export declare class PivotViewItem {
+    /**
+     * - how many rows in the view
+     */
+    rowCount: number;
+    /**
+     * - how many cols in the view
+     */
+    colCount: number;
+    /**
+     * the data of the view, the key is the row index, the value is the column data
+     */
+    data: IPivotViewItemData;
+    /**
+     * the info of the view, the index is the index of the view item, the value is the info of the view item
+     */
+    info: IPivotViewInfo[];
+    lastCol: number;
+    lastRow: 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;
+    setInfo(index: number, info: IPivotViewInfo): void;
+    buildPathMap(considerValue: boolean): Record<string, number>;
+    setRowCount(rowCount: number): void;
+    setColCount(colCount: number): void;
+    getValue(row: number, col: number): IPivotViewValueType;
+    getStyle(row: number, col: number): PivotCellStyleTypeEnum | undefined;
+    toJSON(): IPivotViewItemJSON;
+    fromJSON(json: IPivotViewItemJSON): void;
+}
+export declare class PageViewItem extends PivotViewItem {
+    /**
+     * the range group of the page view, all range is base on the left top of the page view
+     */
+    ranges: IPageViewItemRange[];
+    /**
+     * the last col index of the page view
+     */
+    lastCol: number;
+    /**
+     * the last row index of the page view
+     */
+    lastRow: number;
+    setPageIndex(row: number, col: number, index: number): void;
+    addRange(range: IPageViewItemRange): void;
+    getRanges(): IPageViewItemRange[];
+    setLastCol(col: number): void;
+    setLastRow(row: number): void;
+    getLastCol(): number;
+    getLastRow(): number;
+    toJSON(): IPageViewItemJSON;
+    fromJSON(json: IPageViewItemJSON): void;
+}
+export declare class LabelViewItem extends PivotViewItem {
+    /**
+     * this property is used to store the header map of the label view
+     *  -  in the row view, the header map saved the every column in row view, the key is the column index, the value is the header map item
+     * -  in the col view, the header map saved the every row in col view, the key is the row index, the value is the header map item
+     */
+    headerMap: ILabelViewHeaderMapItem[];
+    addHeaderMapItem(index: number, item: ILabelViewHeaderMapItem): void;
+    getHeaderMapItem(index: number): ILabelViewHeaderMapItem;
+    toJSON(): ILabelViewItemJSON;
+    fromJSON(json: ILabelViewItemJSON): void;
+}
+/**
+ * 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
+ * @returns {boolean} the value is the prefix value
+ */
+export declare const isPrefixValue: (value: IPivotViewValueType) => value is IPivotViewPrefixValue;
+/**
+ * judge the value is the error value, it will be a error value when the show data as or the product bigger than the max value of number in javascript
+ * @param {IPivotViewValueType} value - the pivot view value
+ * @returns {boolean} the value is the error value
+ */
+export declare const isErrorValue: (value: IPivotViewValueType) => value is IPivotViewErrorValue;

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

@@ -0,0 +1,41 @@
+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 { BaseLayout } from './base-layout';
+export declare class TabularLayout extends BaseLayout {
+    static layout(pivotTable: PivotTable, summaryManager: SummaryManager, queryData: IPivotTableQueryData): import('./pivot-view').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;
+    };
+    /**
+     *  - layout the data area of the pivot table
+     * @param {IPivotLayoutCtx} ctx the context of layout
+     * @param {NodeTree} nodeTree the current node
+     * @param {number} row the current row index
+     * @param {number} measureIndex the current measure index, if the row does not have multiple measures, the measureIndex is -1
+     */
+    static startContent(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, measureIndex: number): void;
+    static layoutValueNode(ctx: IPivotLayoutCtx, nodeTree: NodeTree, row: number, measureIndex: number, paths: string[]): void;
+    static layoutValueNodeSubtotal(ctx: IPivotLayoutCtx, row: number): void;
+    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 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

@@ -0,0 +1,198 @@
+import { IPivotTableChangeSet, IPivotTableFilterInfo, IPivotTableOptions, IPivotTableQueryData, IPivotTableSnapshot, IPivotTableSortInfo, PivotSubtotalTypeEnum, PivotLayoutTypeEnum, PivotTableFiledAreaEnum, PivotTableValuePositionEnum } from '../types';
+import { PivotTableLabelField, PivotTableValueField } from './table-field';
+/**
+ * @class PivotModel represents a config model for a pivot table.
+ * @description The pivot model is a class that stores the pivot table's configuration information.
+ * @typedef PivotModel
+ * @property {string[]} rowFields - An array of row fields id.
+ * @property {string[]} columnFields - An array of column fields id.
+ * @property {string[]} valueFields - An array of value fields id.
+ * @property {string[]} filterFields - An array of filter fields id.
+ * @property {string[]} hiddenFields - An array of hidden fields id.
+ * @property {Record<string, PivotTableLabelField>} dimension - A object of dimension fields, which key is the field id and value is the field.
+ * @property {Record<string, PivotTableValueField>} measure - A object of measure fields, which key is the field id and value is the field.
+ * @property {number} valueIndex - The special ΣValue fields order index in the dimension fields
+ * @property {PivotTableValuePositionEnum} valuePosition - The special ΣValue fields position in row or column area.
+ * @property {PivotLayoutTypeEnum} layout - The layout type of the pivot table.
+ * @property {Record<string, any>} collapseInfo - The collapse information of the pivot table. Which data structure is {fieldId: boolean | {item: boolean}}
+ */
+export declare class PivotModel {
+    /**
+     *@property An array of row fields id.
+     */
+    rowFields: string[];
+    /**
+     *@property An array of column fields id.
+     */
+    columnFields: string[];
+    /**
+     *@property An array of value fields id.
+     */
+    valueFields: string[];
+    /**
+     *@property An array of filter fields id.
+     */
+    filterFields: string[];
+    /**
+     *@property An array of hidden fields id.
+     */
+    hiddenFields: string[];
+    /**
+     *@property An array of dimension fields.
+     */
+    dimension: Record<string, PivotTableLabelField>;
+    /**
+     *@property An array of measure fields.
+     */
+    measure: Record<string, PivotTableValueField>;
+    /**
+     *@property The special ΣValue fields order index in the dimension fields.
+     *@description The special ΣValue fields order index in the dimension fields， the index value is equal to the index of the field in the row or column area which the ΣValue field followed.
+     */
+    valueIndex: number;
+    /**
+     *@property The special ΣValue fields position in row or column area.
+     */
+    valuePosition: PivotTableValuePositionEnum;
+    /**
+     *@property The layout type of the pivot table.
+     */
+    layout: PivotLayoutTypeEnum;
+    /**
+     * @property The collapse information of the pivot table.
+     */
+    collapseInfo: Record<string, boolean | Record<string, boolean>>;
+    /**
+     * Creates an instance of PivotModel.
+     */
+    options: IPivotTableOptions;
+    _changeStack: IPivotTableChangeSet[];
+    /**
+     * 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;
+    constructor();
+    startChangeStack(): void;
+    endChangeStack(): IPivotTableChangeSet[];
+    /**
+     * - set a dirty status to flag the pivot table whether it is changed.
+     * @param {boolean} dirty
+     */
+    setDirty(dirty: boolean): void;
+    /**
+     * - get the dirty status of the pivot table.
+     * @returns {boolean} - The dirty status of the pivot table.
+     */
+    getDirty(): boolean;
+    /**
+     * - Set the options of the pivot table.
+     * @param {IPivotTableOptions} options  - The options to be set.
+     * @returns {void}
+     */
+    setOptions(options: IPivotTableOptions): void;
+    /**
+     *  - 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;
+    };
+    /**
+     * @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.
+     * @param {boolean} collapse - The collapse status of the field.
+     * @param {string} [item] - The item of the field.
+     */
+    setCollapse(fieldId: string, collapse: boolean, item?: string): void;
+    setFilterInfo(fieldId: string, filterInfo: IPivotTableFilterInfo): void;
+    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;
+    getFilterInfo(fieldId: string): IPivotTableFilterInfo | undefined;
+    iterateField(callback: (field: PivotTableLabelField | PivotTableValueField) => void): void;
+    iterateFieldDim(callback: (field: PivotTableLabelField) => void): void;
+    iterateFieldMeasure(callback: (field: PivotTableValueField) => void): void;
+    iterateFieldByArea(area: PivotTableFiledAreaEnum, callback: (field: PivotTableLabelField | PivotTableValueField) => void): void;
+    /**
+     * @description Add a field to the pivot table.
+     * @param {PivotTableLabelField | PivotTableValueField} field -the field to be added.
+     * @param {PivotTableFiledAreaEnum} area -The area to add the field.
+     * @param {number} index  - The index of the field in the area.
+     */
+    addField(field: PivotTableLabelField | PivotTableValueField, area: PivotTableFiledAreaEnum, index?: number): void;
+    /**
+     * @description get where the field bo be position info by field id.
+     * @param {string} fieldId - The id of the field.
+     * @typedef
+     * @property {PivotTableFiledAreaEnum} area - The area of the field.
+     * @property {number} index - The index of the field in the area.
+     * @returns PivotTableFiledAreaEnum
+     */
+    getFieldPositionInfoById(fieldId: string): {
+        area: PivotTableFiledAreaEnum | undefined;
+        index: number;
+    };
+    updateFieldSourceInfo(fieldId: string, sourceName: string, dataFieldId: string): void;
+    getFieldsAreaByType(type: PivotTableFiledAreaEnum): string[];
+    getFieldById(fieldId: string): PivotTableValueField | PivotTableLabelField | undefined;
+    isExistFieldName(fieldName: string): boolean;
+    /**
+     * @description Rename a field in the pivot table.
+     * @param {string} fieldId - The id of the field to be renamed.
+     * @param displayName - The new display name of the field.
+     * @returns {void}
+     */
+    renameField(fieldId: string, displayName: string): void;
+    /**
+     * @description Remove a field from the pivot table by the field id.
+     * @param {string} fieldId - The id of the field to be removed.
+     * @returns {void} -void
+     */
+    removeField(fieldId: string): void;
+    updateFieldPosition(fieldId: string, area: PivotTableFiledAreaEnum, index: number): void;
+    /**
+     * - Update the value position of the pivot table.
+     * @param valuePosition
+     * @param valueIndex
+     */
+    updateValuePosition(valuePosition: PivotTableValuePositionEnum, valueIndex: number): void;
+    /**
+     * - The special ΣValue fields order index in the dimension fields
+     * @returns {number} the index
+     */
+    getValueIndex(): number;
+    getValuePosition(): PivotTableValuePositionEnum;
+    /**
+     *  - Whether the pivot table has the special ΣValue fields in column area.
+     * @returns {boolean} - has or not.
+     */
+    isColMultiMeasure(): boolean;
+    /**
+     *  - Whether the pivot table has the special ΣValue fields in row area.
+     * @returns {boolean} - has or not.
+     */
+    isRowMultiMeasure(): boolean;
+    isEmpty(): boolean;
+    /**
+     * - set or update a field's subtotal type. , the table field must in the value area.
+     * @param {string} tableFieldId - The id of the pivot table field.
+     * @param {PivotSubtotalTypeEnum} subtotal - The subtotal type.
+     */
+    setSubtotalType(tableFieldId: string, subtotal: PivotSubtotalTypeEnum): void;
+    /**
+     * Represents the query data of the pivot table.Which is used to query the data from the data collection.
+     * @returns {IPivotTableQueryData} - The query data of the pivot table.
+     */
+    getQueryData(): IPivotTableQueryData;
+    fromJSON(data: IPivotTableSnapshot): void;
+    toJSON(): IPivotTableSnapshot;
+    cloneBufferModel(): PivotModel;
+}

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

@@ -0,0 +1,224 @@
+import { FieldsCollection } from '../field/fields-collection';
+import { PivotDataFieldDataTypeEnum, PivotSubtotalTypeEnum, IPivotTableFilterInfo, IPivotTableOptions, IPivotTableQueryData, IPivotTableSnapshot, IPivotTableSortInfo, PivotTableFiledAreaEnum, PivotTableValuePositionEnum } from '../types';
+import { DataField } from '../field/data-field';
+import { PivotModel } from './model';
+import { PivotTableLabelField, PivotTableValueField } from './table-field';
+/**
+ * @class PivotTable - represents the wrapper class pivot table.
+ * @description The pivot table is a wrapper class which references the data fields collection and pivot table model.
+ * @implements IPivotTable
+ */
+export declare class PivotTable {
+    dataFieldsCollection: FieldsCollection;
+    private _viewVersion;
+    private _model;
+    _bufferModel: PivotModel;
+    private _tupleGroupCache;
+    constructor(dataFieldsCollection: FieldsCollection, model?: PivotModel);
+    updateDataFieldsCollection(dataFieldsCollection: FieldsCollection): void;
+    private _getModel;
+    startCollectChangeset(): void;
+    endCollectChangeset(): import('../types').IPivotTableChangeSet[];
+    _generateModel(): void;
+    createLabelFieldByDataFieldId(dataFieldId: string, tableName?: string): PivotTableLabelField | undefined;
+    createValueFieldByDataFieldId(dataFieldId: string): PivotTableValueField | undefined;
+    updateValuePosition(valuePosition: PivotTableValuePositionEnum, valueIndex: number): void;
+    isColMultiMeasure(): boolean;
+    isRowMultiMeasure(): boolean;
+    /**
+     * get the order index of ΣValue  in row or col
+     * @returns {number} -1 means not exist, otherwise the index of the ΣValue
+     */
+    getValueIndex(): number;
+    /**
+     *  - get the value position
+     * @returns {PivotTableValuePositionEnum} the value position, only row or column
+     */
+    getValuePosition(): PivotTableValuePositionEnum;
+    /**
+     * - iterate all pivot table fields
+     * @param {(field: PivotTableLabelField | PivotTableValueField) => void} callback the callback function
+     */
+    iterateField(callback: (field: PivotTableLabelField | PivotTableValueField) => void): void;
+    /**
+     * - iterate the dimension field, it means all the label fields
+     * @param {(field: PivotTableLabelField | PivotTableValueField) => void} callback the callback function
+     */
+    iterateFieldDim(callback: (field: PivotTableLabelField) => void): void;
+    /**
+     * - iterate the field by the area
+     * @param {PivotTableFiledAreaEnum} area the area of the field enum
+     * @param {(field: PivotTableLabelField | PivotTableValueField) => void} callback the callback function
+     */
+    iterateFieldByArea(area: PivotTableFiledAreaEnum, callback: (field: PivotTableLabelField | PivotTableValueField) => void): void;
+    /**
+     * - get how many fields in the area
+     * @param {PivotTableFiledAreaEnum} area - the area of the field enum
+     * @returns {number} the field count
+     */
+    getFieldCountByArea(area: PivotTableFiledAreaEnum): number;
+    getValueFields(): string[];
+    /**
+     * - get a unique field name in the pivot table
+     * @param {string} autoName the given field name
+     * @returns {string} the unique field name
+     */
+    getUniqueValueFieldName(autoName: string): string;
+    /**
+     * - get the data field by the table field id
+     * @param {string} tableField - the table field id
+     * @returns {DataField|undefined} the data field or undefined
+     */
+    getDataFieldByTableId(tableField: string): DataField | undefined;
+    /**
+     * - get all the table fields by use the data field id
+     * @param dataFieldId
+     * @returns {string[]} the table field ids
+     */
+    getTableFieldsByDataFieldId(dataFieldId: string): (PivotTableLabelField | PivotTableValueField)[];
+    /**
+     * - get the table field by the table field id
+     * @param {string} tableFieldId - the table field id
+     * @returns {PivotTableLabelField | PivotTableValueField | undefined} the table field or undefined
+     */
+    getTableFieldById(tableFieldId: string): PivotTableLabelField | PivotTableValueField | undefined;
+    /**
+     * - check the field is exist in the pivot table or not
+     * @param {string} tableFieldId the check field id
+     * @returns {boolean} exist or not
+     */
+    isExistField(tableFieldId: string): boolean;
+    /**
+     * - get the pivot table is empty or not
+     * @returns {boolean} empty or not
+     */
+    isEmpty(): boolean;
+    /**
+     * - get the data field by the data field id
+     * @param {string} dataFieldId the data field id
+     * @returns {DataField|undefined} the data field or undefined
+     */
+    getDataFieldByDataFieldId(dataFieldId: string): DataField;
+    getDataFieldItemInfo(dataField: DataField): {
+        items: string[];
+        itemTypes: PivotDataFieldDataTypeEnum[];
+    };
+    getUniqueFieldId(): string;
+    /**
+     * - add a field to the pivot table by the source name , if the field is a measure field, it will be use auto name.
+     * @param {string} dataFieldId data field name
+     * @param {PivotTableFiledAreaEnum} area the area of the added field
+     * @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;
+    setOptions(options: IPivotTableOptions): void;
+    /**
+     *  the func is only use for when refresh
+     * @param {string} fieldId the table field id
+     * @param {string} sourceName  the source name of the field
+     * @param {string} dataFieldId the data field id
+     */
+    updateFieldSourceInfo(fieldId: string, sourceName: string, dataFieldId: string): void;
+    /**
+     * - Set the subtotal type of the field. only the value field can set the subtotal type. only effective for the value field.
+     * @param {string} fieldId - The id of the field.
+     * @param {PivotSubtotalTypeEnum} subtotalType - The subtotal type of the field.
+     */
+    setSubtotalType(fieldId: string, subtotalType: PivotSubtotalTypeEnum): void;
+    /**
+     * - Rename the field.
+     * @param {string} fieldId - The id of the field.
+     * @param {string} displayName - The display name of the field.
+     */
+    renameField(fieldId: string, displayName: string): void;
+    /**
+     *  - Set the filter information of the dimension field. only the dimension field can set the filter information.
+     * @param fieldId
+     * @param filterInfo
+     */
+    setFilterInfo(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.
+     * @param {IPivotTableSortInfo} sortInfo - The sort information of the field.
+     */
+    setSortInfo(fieldId: string, sortInfo: IPivotTableSortInfo | undefined): void;
+    /**
+     * - get the sort information of the dimension field.
+     * @param fieldId - The id of the field.
+     * @returns {IPivotTableSortInfo} -The sort information of the field.
+     */
+    getSortInfo(fieldId: string): import('../types').IPivotTableLabelSortInfo | 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;
+    /**
+     * - 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.
+     * @param {PivotTableFiledAreaEnum} area which area the field will be placed.
+     * @param {number} index the index of the field in the area.
+     */
+    updateFieldPosition(fieldId: string, area: PivotTableFiledAreaEnum, index: number): void;
+    /**
+     * - get a format for pivot table field, which will be applied in the pivot table view. the label field will use the format to format the date value.
+     * @description when a show data as type is selected, we should set the format for the field.
+     * @param {string} fieldId -the field id
+     * @returns {string} the field  format code
+     */
+    getFieldFormat(fieldId: string): string | undefined;
+    /**
+     * - set the format for pivot table field, which will be applied in the pivot table view. the label field will use the format to format the date value.
+     * @description when a show data as type is selected, we should set the format for the field. a label field which contains the date value should set the format.
+     * @param {string} fieldId
+     * @param {string|undefined} format
+     */
+    setFieldFormat(fieldId: string, format: string | undefined): void;
+    /**
+     *
+     * @param field
+     * @param area
+     * @example
+     * const pt= new PivotTable(fieldsCollection);
+     * var areaField = pt.addFieldWithSourceName('区域', PivotTableFiledAreaEnum.Column);
+     * pt.addFieldWithSourceName('省份', PivotTableFiledAreaEnum.Filter);
+     */
+    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;
+    };
+    /**
+     * @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.
+     * @param {boolean} collapse - The collapse status of the field.
+     * @param {string} [item] - The item of the field.
+     */
+    setCollapse(fieldId: string, collapse: boolean, item?: string): void;
+    /**
+     * - get the pivot view need query or not
+     * @param {number} viewVersion
+     * @returns {boolean} - need query or not
+     */
+    getNeedQuery(viewVersion: number): boolean;
+    getFieldPositionInfoById(fieldId: string): {
+        area: PivotTableFiledAreaEnum | undefined;
+        index: number;
+    };
+    private _getTupleCache;
+    query(config?: IPivotTableQueryData): import('..').PivotView;
+    toJSON(): IPivotTableSnapshot;
+    fromJSON(data: IPivotTableSnapshot): void;
+    dispose(): void;
+}