@univerjs-pro/engine-pivot 0.4.2 → 0.5.0-alpha.0

package/lib/types/index.d.ts

@@ -1,11 +1,2539 @@
-export * from './types';
-export { SummaryManager } from './summary/summary-manager';
-export { PivotTuple } from './summary/pivot-tuple';
-export { FieldsCollection } from './field/fields-collection';
-export { DataField } from './field/data-field';
-export { PivotTable } from './pivot/pivot-table';
-export { PivotModel } from './pivot/model';
-export { cloneLabelFieldToValueField, cloneValueFieldToLabelField, createLabelField, createValueField, PivotTableFieldBase, PivotTableLabelField, PivotTableValueField, } from './pivot/table-field';
-export { DataFieldManager } from './field/data-field-manager';
-export { isErrorValue, isPrefixValue, LabelViewItem, PageViewItem, PivotView, PivotViewItem } from './layout/pivot-view';
-export { generateHexNumber, getAutoDisplayName, isCustomFilter, isDateValue, isManualFilter, isValueFilter, } from './util';
+declare type autoDisplayNameFunction = (name: string, subtotalType: PivotSubtotalTypeEnum) => string;
+
+/**
+ * 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 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;
+
+/**
+ * - 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;
+
+/**
+ * Represents a data field in a pivot table , it match the excel pivot cache field data structure.
+ * @param {string} id - The unique identifier of the data field.
+ * @param {string} name - The name of the data field. Almost is the row header of pivot table data source, the custom field such as calculated field or grouped field will have a different name.
+ * @method addRecord - Add a record to the data field.
+ */
+export declare class DataField {
+    /**
+     * @property {string} id - The unique identifier of the data field.
+     */
+    readonly id: string;
+    /**
+     * @property {string} name - The name of the data field.
+     */
+    name: string;
+    /**
+     * @property {string} hexCode - The hex code of the data field, which is used to create unique path in tuple group.
+     */
+    hexCode: string;
+    /**
+     * @property {string} rangeKey - The range key of the data field.
+     */
+    rangeKey: string;
+    /**
+     * @property {IDataFieldValue[]} records - The records of the data field.
+     */
+    records: IDataFieldValue[];
+    /**
+     * @property {string[]} items - The items of the data field.
+     */
+    items: string[];
+    /**
+     * @property {PivotDataFieldDataTypeEnum[]} itemTypes - The item types of the data field.
+     */
+    itemTypes: PivotDataFieldDataTypeEnum[];
+    /**
+     * @property {PivotDataFieldDataTypeEnum} fieldDataType - The data type of the data field.
+     */
+    private _fieldDataType;
+    /**
+     * @property {boolean} hasInteger - Whether the data field has integer value. this property is used in number group.
+     */
+    hasInteger: boolean;
+    /**
+     * @property {boolean} hasDecimal - Whether the data field has decimal value. this property is used in number group.
+     */
+    hasDecimal: boolean;
+    /**
+     * @property {boolean} hasDate - Whether the data field has date value. this property is used in date group.
+     */
+    hasDate: boolean;
+    /**
+     * @property {boolean} hasBlank - Whether the data field has blank value. The blank value is represented by a placeholder in Pivot table. in en-us locale, the placeholder is "(blank)".
+     */
+    hasBlank: boolean;
+    /**
+     * @property {boolean} hasText - Whether the data field has text value.
+     */
+    hasText: boolean;
+    /**
+     * @property {string} format - The format of the data field. only date field has format property, the format is the date format string.
+     */
+    format: string;
+    /**
+     * @property {number} maxNumber - The max number of the data field. this property is used in number group to set the max value of the number group.
+     */
+    maxNumber: number;
+    /**
+     * @property {number} minNumber - The min number of the data field. this property is used in number group to set the min value of the number group.
+     */
+    minNumber: number;
+    /**
+     * @property {number} maxDate - The max date of the data field. this property is used in date group to set the max value of the date group.
+     */
+    maxDate: number;
+    /**
+     * @property {number} minDate - The min date of the data field. this property is used in date group to set the min value of the date group.
+     */
+    minDate: number;
+    /**
+     * @property {Record<string, number>} - The index of the items in the data field.
+     */
+    private _itemIndexMap;
+    /**
+     * @property {Record<string, number[]>} itemsMap -Save the index of the items in the data field. The key is the item key, the value is the index array of the item in the data field.
+     */
+    private _itemsMap;
+    constructor(id: string, name: string, hexCode: string);
+    /**
+     * - Returns the name of the data field.
+     * @returns {string} the range key of the data field.
+     */
+    getRangeKey(): string;
+    getformat(): string;
+    /**
+     * - set the range key of the data field.
+     * @param {string} rangeKey the range key of the data field.
+     */
+    setRangeKey(rangeKey: string): void;
+    getId(): string;
+    getName(): string;
+    setName(name: string): void;
+    /**
+     * - if the field contains date value and blank only, the field data type is date. if the field contains number value and blank only, the field data type is number. otherwise, the field data type is text.
+     * @returns {string} the name of the data field.
+     */
+    getFieldDataType(): PivotDataFieldDataTypeEnum;
+    /**
+     * - Returns the shared key with the data field item, this can be combined in the tuple group with other data field item key to create a unique path.
+     * @param {string} dataIndex the index in data records
+     * @returns {string} key with field and item info
+     */
+    getItemSharedKey(key: string): string;
+    /**
+     * - Returns the key of the data field item. the key logic should be same with addRecord method.
+     * @param {number} index - the index of data records
+     * @returns {string} The key of the data field item.
+     */
+    getItemKey(index: number): string;
+    /**
+     * - get the type of date by key
+     * @param {string} key - the key of the data field item.
+     * @returns {PivotDataFieldDataTypeEnum} the data type
+     */
+    getTypeByKey(key: string): PivotDataFieldDataTypeEnum;
+    /**
+     * - Returns the value of the data field  record
+     * @param {number} index - The index of the data field record.
+     * @returns {IDataFieldValue} - The value of the data field record.
+     */
+    getValue(index: number): IDataFieldValue;
+    /**
+     * @description Add a record to the data field.
+     * @param {IDataFieldValue} record - The record to be added.
+     * @param {number} index - The index of the record.
+     * @returns {void}
+     */
+    addRecord(record: IDataFieldValue, index: number): void;
+    getIndexesByKey(key: string): number[];
+    /**
+     * @description Update the item key in the data field.
+     * @param {IDateValue} record - The date value.
+     * @param {number} index - The index of the record.
+     * @returns {void}
+     */
+    private _updateDateItemKey;
+    private _updateBlankItemKey;
+    private _updateStringItemKey;
+    private _updateNumberItemKey;
+    private _updateItemKey;
+    getItemsMap(): Record<string, number>;
+    /**
+     * @description Get the data field info for pivot table, some properties are not included in the data field info because they are not necessary for the pivot table. only the import/export need them.
+     * @returns {IDataFieldInfo} The data field info.
+     */
+    getFieldInfo(): IDataFieldInfo;
+    toJSON(): IDataFieldJSON;
+    fromJSON(data: IDataFieldJSON): void;
+    reset(): void;
+}
+
+export declare abstract class DataFieldManager {
+    dataFields: Record<string, DataField>;
+    collections: Record<string, FieldsCollection>;
+    constructor();
+    createDataFieldId(): string;
+    getAutoDisplayNameFunction(): autoDisplayNameFunction | null;
+    getNoUsedDataFieldIds(excludeCollectionToken: string): string[];
+    createCollection(id: string, rangeStr: unknown): FieldsCollection;
+    dispose(): void;
+    toJSON(): IDataFieldManagerBaseJSON;
+    addCollection(token: string, collection: FieldsCollection, sourceRangeInfo: any, ...args: any): void;
+    fromJSON(jsonData: IDataFieldManagerBaseJSON): void;
+    abstract getRangeData(rangeKey: unknown): {
+        header: unknown[];
+        data: IDataFieldValue[][];
+    };
+}
+
+/**
+ * Represents the collection of fields in the pivot table. which one to one with a pivot table.
+ * @description The collection of fields in the pivot table. The fields collection uses shared the base data field id.For Grouped fields or calculated fields, it will save in custom field.
+ * @class FieldsCollection
+ * @param {DataFieldManager} host - The data field manager.
+ */
+export declare class FieldsCollection {
+    /**
+     * @property The base fields id which saved in host <the DataFieldManager>, this part of fields are the original fields in the pivot table.
+     */
+    fieldIds: string[];
+    /**
+     * @property The display name of the fields in the pivot table. key is field id, value is the display name.
+     */
+    displayNameRecord: Record<string, string>;
+    /**
+     * @property The custom fields in the pivot table. such as calculated fields or grouped fields.
+     */
+    customFields: Record<string, DataField>;
+    range: any;
+    dataRecordCount: number;
+    readonly host: DataFieldManager;
+    constructor(host: DataFieldManager);
+    getFieldIds(): string[];
+    hasField(fieldId: string): boolean;
+    /**
+     * find the is there has a data field whose name is the same as the sourceName.
+     * @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;
+    /**
+     * - add a field to the collection. the field should be ensured in the host.
+     * @param fieldId
+     */
+    addField(fieldId: string, displayName: string): void;
+    /**
+     * get the display name of the field by the field id in this collection, in different collection, the display name may be different.
+     * @param {string} fieldId the data field id.
+     * @returns {string} the display name of the field.
+     */
+    getDisplayName(fieldId: string): string;
+    setDisplayName(fieldId: string, fieldName: string, displayNameRecord?: Record<string, string>): void;
+    getUniqueDataFieldName(displayName: string, displayNameRecord?: Record<string, string>): string;
+    /**
+     * @description remove the field from the collection.
+     */
+    updateAllDisplayName(): void;
+    /**
+     * @description Gets the field by the specified id.
+     * @param {string} id - The field id.
+     * @returns {DataField} - The field.
+     */
+    getFieldById(id: string): DataField;
+    setDataRecordCount(count: number): void;
+    getDataRecordCount(): number;
+    getDataFieldBySourceName(sourceName: string): DataField | undefined;
+    /**
+     * @description Gets the field by the specified name.
+     * @returns {IDataFieldInfo[]} -returns the field infos.
+     */
+    getFieldInfo(): IDataFieldInfo[];
+    toJSON(): IFieldsCollectionJSON;
+    fromJSON(jsonData: IFieldsCollectionJSON): void;
+    dispose(): void;
+}
+
+/**
+ * - Generate a random hex number text with specified length
+ * @param {number} length the length of the generated hex number
+ * @returns {string} the generated hex number
+ */
+export declare function generateHexNumber(length: number): string;
+
+/**
+ * - Get the auto display name of the value field.
+ * @description - which may use prefix text like excel
+ * - the prefix text is create by subtotal type
+ * @param {string} baseName the name without prefix text
+ * @param {PivotSubtotalTypeEnum} subtotalType the type of subtotal to be displayed for this value field.
+ * @returns {string} the auto display name of the value field.
+ */
+export declare function getAutoDisplayName(baseName: string, subtotalType: PivotSubtotalTypeEnum): string;
+
+declare type IBlankValue = null | undefined;
+
+export declare interface IColumnNodeSizeInfo extends INodeSizeInfo {
+    colPathMap: Record<string, number>;
+}
+
+export declare interface IDataFieldInfo {
+    id: string;
+    name: string;
+    fieldDataType: PivotDataFieldDataTypeEnum;
+    format: string;
+    maxNumber: number;
+    minNumber: number;
+    maxDate: number;
+    minDate: number;
+    records: IDataFieldValue[];
+    rangeKey: string;
+}
+
+/**
+ * Represents the data field serialized to JSON data structure.
+ */
+export declare interface IDataFieldJSON {
+    id: string;
+    name: string;
+    hexCode: string;
+    rangeKey: string;
+}
+
+export declare interface IDataFieldManagerBaseJSON {
+    collections: Record<string, IFieldsCollectionJSON>;
+    dataFields: Record<string, IDataFieldJSON>;
+}
+
+/**
+ * Represents the value of a data field in a pivot table data field
+ */
+export declare type IDataFieldValue = string | number | boolean | IDateValue | IBlankValue;
+
+export declare interface IDateValue {
+    /**
+     * @description the date value,  it stores the number of seconds since January 1, 1970, 00:00:00 UTC, it is same to excel date value
+     */
+    v: number;
+    /**
+     * @description only date type has this property, we can use it to format the date
+     */
+    f: string;
+}
+
+export declare interface IDimensionMapItem {
+    field: DataField;
+}
+
+export declare interface IFieldsCollectionJSON {
+    fieldIds: string[];
+    customFields: IDataFieldJSON[];
+    displayNameRecord: Record<string, string>;
+    dataRecordCount: number;
+    range: unknown;
+    fields: Record<string, IDataFieldJSON>;
+}
+
+export declare interface ILabelViewHeaderMapItem {
+    isValue: boolean;
+    level: number;
+    tableFieldId: string;
+    dataFieldId: string;
+}
+
+export declare interface ILabelViewItemJSON extends IPivotViewItemJSON {
+    headerMap: ILabelViewHeaderMapItem[];
+}
+
+export declare interface IMeasuresMapItem {
+    field: DataField;
+    subTotal: PivotSubtotalTypeEnum[];
+}
+
+export declare interface IMeasureTupleItem {
+    [DataFieldId: string]: PivotTuple;
+}
+
+export declare interface INodeSizeInfo {
+    /**
+     * The size of the item
+     */
+    itemSize: number;
+    /**
+     *  The size of the children item top total size
+     */
+    topTotalSize: number;
+    /**
+     * The size of the children item bottom total size
+     */
+    bottomTotalSize: number;
+}
+
+export declare interface IPageViewItemJSON extends IPivotViewItemJSON {
+    lastRow: number;
+    lastCol: number;
+    ranges: IPageViewItemRange[];
+}
+
+export declare interface IPageViewItemRange {
+    row: number;
+    col: number;
+    rowCount: number;
+    colCount: number;
+}
+
+export declare interface IPivotField {
+    id: string;
+    displayName: string;
+    subtotalType: PivotSubtotalTypeEnum;
+}
+
+export declare interface IPivotLayoutCtx {
+    view: PivotView;
+    rowDeep: number;
+    colDeep: number;
+    rowNodeTree: NodeTree;
+    colNodeTree: NodeTree;
+    measureCount: number;
+    pageWrap: number;
+    pageOverThenDown: boolean;
+    queryData: IPivotTableQueryData;
+    isColMultiMeasure: boolean;
+    isRowMultiMeasure: boolean;
+    valueIndex: number;
+    valueQueryInfo: IPivotTableValueFieldQueryData[];
+    measuresMap: Record<string, IPivotTableValueFieldQueryData>;
+    colMap: Record<string, number>;
+    summaryManager: SummaryManager;
+    measureIndexesMap: Record<string, number>;
+    collapseInfo: Record<string, boolean | Record<string, boolean>>;
+}
+
+export declare interface IPivotSummaryLevelPool {
+    [level: number]: IPivotSummaryLevelPoolItem[];
+}
+
+export declare interface IPivotSummaryLevelPoolItem {
+    v: number;
+    p: number;
+}
+
+export declare interface IPivotTableAddFieldChange {
+    type: PivotTableChangeTypeEnum.AddField;
+    fieldJson: IPivotTableValueFieldJSON | IPivotTableLabelFieldJSON;
+    area: PivotTableFiledAreaEnum;
+    index: number;
+}
+
+export declare type IPivotTableChangeSet = IPivotTableAddFieldChange | IPivotTableSetSubtotalTypeChange | IPivotTableRemoveFieldChange | IPivotTableRenameFieldChange | IPivotTableSetFilterInfoChange | IPivotTableSetSortInfoChange | IPivotTableUpdatePositionChange | IPivotTableUpdateValuePositionChange | IPivotTableSetOptionsChange | IPivotTableSetFormatChange | IPivotTableSetCollapseChange | IPivotUpdateSourceChange;
+
+export declare interface IPivotTableCustomFilter {
+    type: PivotFilterTypeEnum.CustomFilter;
+    operator: ST_PivotFilterOperatorEnum;
+    expected: any;
+}
+
+export declare type IPivotTableFilterInfo = IPivotTableManualFilter | IPivotTableCustomFilter | IPivotTableValueFilter;
+
+export declare interface IPivotTableLabelFieldJSON {
+    dataFieldId: string;
+    id: string;
+    sourceName: string;
+    displayName: string;
+    format: string | undefined;
+    sortInfo?: IPivotTableSortInfo;
+    filterInfo?: IPivotTableFilterInfo;
+}
+
+/**
+ * Represents the query data for a label field in a pivot table.
+ */
+export declare interface IPivotTableLabelFieldQueryData {
+    /**
+     * The unique identifier of the label field.
+     */
+    id: string;
+    /**
+     * The unique identifier of the data field associated with the label field.
+     */
+    dataFieldId: string;
+    /**
+     * The display name of the label field.
+     */
+    displayName: string;
+    /**
+     * Information about the filter applied to the label field.
+     */
+    filterInfo?: IPivotTableFilterInfo;
+    /**
+     * Information about the sort applied to the label field.
+     */
+    sortInfo: IPivotTableSortInfo;
+}
+
+export declare interface IPivotTableLabelSortInfo {
+    type: PivotDataFieldSortOperatorEnum;
+}
+
+/**
+ * Represents the Pivot Table Manual Filter info
+ */
+export declare interface IPivotTableManualFilter {
+    /**
+     * @property {PivotFilterTypeEnum} - The filter type.
+     */
+    type: PivotFilterTypeEnum.ManualFilter;
+    /**
+     * @property {string[]} - The list of selected items.
+     */
+    list: string[];
+    isAll?: boolean;
+}
+
+/**
+ * Represents the query data for a measure field in a pivot table.
+ */
+export declare interface IPivotTableMeasureData {
+    /**
+     * @property {IPivotTableLabelFieldQueryData[]} - The query data for the value fields.
+     */
+    values: IPivotTableValueFieldQueryData[];
+}
+
+/**
+ * Represents the data structure for a pivot table config, which is match CT_pivotTableDefinition
+ */
+export declare interface IPivotTableOptions {
+    /**
+     * The page wrap, it is the wrap of page, the page will wrap to next row when the wrapCursor is equal to pageWrap
+     */
+    pageWrap?: number;
+    /**
+     * The page over then down, it is the layout of page, if the pageOverThenDown is true, the page will layout over then down, otherwise, the page will layout down then over
+     */
+    pageOverThenDown?: boolean;
+    showColHeaders?: boolean;
+    showColStripes?: boolean;
+    showLastColumn?: boolean;
+    showRowHeaders?: boolean;
+    showRowStripes?: boolean;
+    /**
+     * use span in the pivot table header
+     */
+    mergeItems?: boolean;
+}
+
+/**
+ * Represents the data structure for a pivot table query.
+ */
+export declare interface IPivotTableQueryData {
+    /**
+     * The query info of row fields in the pivot table.
+     */
+    rowQueryInfo: IPivotTableLabelFieldQueryData[];
+    /**
+     * The query info of column fields in the pivot table.
+     */
+    colQueryInfo: IPivotTableLabelFieldQueryData[];
+    /**
+     * The query info of filter fields in the pivot table.
+     */
+    filterQueryInfo: IPivotTableLabelFieldQueryData[];
+    /**
+     * The query info of value fields in the pivot table.
+     */
+    valueQueryInfo: IPivotTableValueFieldQueryData[];
+    /**
+     * The collapse state of the fields.
+     * @property {Record<string, boolean|Record<string, boolean>>} - The collapse state of the pivot table.
+     */
+    collapseInfo: Record<string, boolean | Record<string, boolean>>;
+}
+
+export declare interface IPivotTableRemoveFieldChange {
+    type: PivotTableChangeTypeEnum.RemoveField;
+    fieldId: string;
+    area: PivotTableFiledAreaEnum;
+    index: number;
+    fieldJson: IPivotTableValueFieldJSON | IPivotTableLabelFieldJSON;
+}
+
+export declare interface IPivotTableRenameFieldChange {
+    type: PivotTableChangeTypeEnum.RenameField;
+    fieldId: string;
+    oldName: string;
+    newName: string;
+}
+
+export declare interface IPivotTableSetCollapseChange {
+    type: PivotTableChangeTypeEnum.SetCollapse;
+    fieldId: string;
+    collapse: boolean;
+    item?: string;
+}
+
+export declare interface IPivotTableSetFilterInfoChange {
+    type: PivotTableChangeTypeEnum.SetFilterInfo;
+    fieldId: string;
+    oldFilterInfo: IPivotTableFilterInfo;
+    newFilterInfo: IPivotTableFilterInfo;
+}
+
+export declare interface IPivotTableSetFormatChange {
+    type: PivotTableChangeTypeEnum.SetFieldFormat;
+    fieldId: string;
+    oldFormat: string | undefined;
+    newFormat: string | undefined;
+}
+
+export declare interface IPivotTableSetOptionsChange {
+    type: PivotTableChangeTypeEnum.SetOptions;
+    oldOptions: IPivotTableOptions;
+    newOptions: IPivotTableOptions;
+}
+
+export declare interface IPivotTableSetSortInfoChange {
+    type: PivotTableChangeTypeEnum.SetSortInfo;
+    fieldId: string;
+    oldSortInfo: IPivotTableSortInfo | undefined;
+    newSortInfo: IPivotTableSortInfo | undefined;
+}
+
+export declare interface IPivotTableSetSubtotalTypeChange {
+    type: PivotTableChangeTypeEnum.SetSubtotalType;
+    fieldId: string;
+    newSubtotalType: PivotSubtotalTypeEnum;
+    oldSubtotalType: PivotSubtotalTypeEnum;
+}
+
+export declare interface IPivotTableShowDataAsInfo {
+    type: PivotShowAsTypeEnum;
+    baseFieldId: string;
+    baseItem: string;
+}
+
+/**
+ * Represents a snapshot of a pivot table.
+ */
+export declare interface IPivotTableSnapshot {
+    /**
+     * Represents the label fields in the pivot table.
+     */
+    dimension: Record<string, IPivotTableLabelFieldJSON>;
+    /**
+     * Represents the value fields in the pivot table.
+     */
+    measure: Record<string, IPivotTableValueFieldJSON>;
+    /**
+     * Represents the fields id used for grouping value in the pivot table.
+     */
+    valueFields: string[];
+    /**
+     * Represents the fields id used for filtering in the pivot table.
+     */
+    filterFields: string[];
+    /**
+     * Represents the fields id used for grouping rows in the pivot table.
+     */
+    rowFields: string[];
+    /**
+     * Represents the fields id used for grouping columns in the pivot table.
+     */
+    columnFields: string[];
+    /**
+     * Represents the fields id that are hidden in the pivot table.
+     */
+    hiddenFields: string[];
+    /**
+     * Represents the special ΣValue fields order index in the dimension fields.
+     */
+    valueIndex: number;
+    /**
+     * Represents the special ΣValue fields position in row or column area.
+     */
+    valuePosition: PivotTableValuePositionEnum;
+    /**
+     * Represents the layout of the pivot table.
+     */
+    layout: PivotLayoutTypeEnum;
+    /**
+     * Represents the collapse information of the pivot table.
+     */
+    collapseInfo: Record<string, any>;
+    options: IPivotTableOptions;
+}
+
+export declare type IPivotTableSortInfo = IPivotTableLabelSortInfo | IPivotTableValueSortInfo;
+
+export declare interface IPivotTableUpdatePositionChange {
+    type: PivotTableChangeTypeEnum.UpdateFieldPosition;
+    fieldId: string;
+    oldArea: PivotTableFiledAreaEnum;
+    newArea: PivotTableFiledAreaEnum;
+    oldIndex: number;
+    newIndex: number;
+}
+
+export declare interface IPivotTableUpdateValuePositionChange {
+    type: PivotTableChangeTypeEnum.UpdateValuePosition;
+    oldValuePosition: PivotTableValuePositionEnum;
+    newValuePosition: PivotTableValuePositionEnum;
+    oldIndex: number;
+    newIndex: number;
+}
+
+export declare interface IPivotTableValueFieldJSON {
+    dataFieldId: string;
+    id: string;
+    sourceName: string;
+    displayName: string;
+    format: string | undefined;
+    subtotal: PivotSubtotalTypeEnum;
+    showDataAs: IPivotTableShowDataAsInfo;
+}
+
+/**
+ * Represents the query data for a value field in a pivot table.
+ */
+export declare interface IPivotTableValueFieldQueryData {
+    /**
+     * The unique identifier of the value field.
+     */
+    id: string;
+    /**
+     * The unique identifier of the data field associated with the value field.
+     */
+    dataFieldId: string;
+    /**
+     * The display name of the value field.
+     */
+    displayName: string;
+    /**
+     * The type of subtotal to be displayed for this value field.
+     */
+    subtotal: PivotSubtotalTypeEnum;
+    /**
+     * Information about how to show the data for this value field.
+     */
+    showDataAs: IPivotTableShowDataAsInfo;
+}
+
+export declare interface IPivotTableValueFilter {
+    type: PivotFilterTypeEnum.ValueFilter;
+    operator: ST_PivotFilterOperatorEnum;
+    expected: any;
+}
+
+export declare interface IPivotTableValueSortInfo {
+    /**
+     * @property {PivotDataFieldSortOperatorEnum} - The sort operator of the field items.
+     */
+    type: PivotDataFieldSortOperatorEnum;
+    /**
+     * @property {string} - The base field id of the field items to sort.
+     */
+    baseFieldId: string;
+    /**
+     * @property {string[]} - The path list of field items to sort.
+     */
+    sortItems: string[];
+}
+
+/**
+ * @description using Wefloder to store the pivot table data
+ * @typedef Tuple@typedef Tuple
+ * @property {number} sum - The sum of the values in the tuple.
+ * @property {number} count - The count of the values in the tuple.
+ * @property {number} countN - The count of the number values in the tuple.
+ * @property {number} product - The product of the values in the tuple.
+ * @property {number} min - The minimum value in the tuple.
+ * @property {number} max - The maximum value in the tuple.
+ * @property {number} squareSum - The sum of the squares of the values in the tuple.
+ */
+export declare interface IPivotTuple {
+    sum: number;
+    count: number;
+    countN: number;
+    product: number;
+    min: number;
+    max: number;
+    squareSum: number;
+}
+
+export declare interface IPivotUpdateSourceChange {
+    type: PivotTableChangeTypeEnum.UpdateSource;
+    tableFieldId: string;
+    oldSourceName: string;
+    newSourceName: string;
+    oldDataFieldId: string;
+    newDataFieldId: string;
+}
+
+export declare interface IPivotViewCellData {
+    v?: IPivotViewValueType;
+    s?: PivotCellStyleTypeEnum;
+    /**
+     * @description only for the pivot table page filter cell, the value is the page filter index
+     */
+    i?: number;
+    /**
+     * means the cell is blank, the  only value is 1
+     */
+    t?: PivotViewCellValueTypeEnum;
+}
+
+declare interface IPivotViewColData {
+    [col: number]: IPivotViewCellData;
+}
+
+export declare interface IPivotViewErrorValue {
+    errorType: PivotErrorTypeEnum;
+}
+
+/**
+ * Represents the pivot view info data structure, which is used to store row /col path and value index
+ */
+export declare interface IPivotViewInfo {
+    /**
+     * The pivot table field id
+     */
+    tableFieldId: string;
+    /**
+     * The paths of the row/col
+     */
+    paths: string[];
+    /**
+     * The value index of the row/col
+     */
+    valueIndex: number;
+    /**
+     * is this row/col is bottom total, in excel, maybe has top total in outline layout
+     */
+    isBottomTotal?: boolean;
+    /**
+     * the node level of row or col
+     */
+    level: number;
+    /**
+     * only for col view, to match some node does not save in node tree
+     */
+    colPathMap?: Record<string, number>;
+    /**
+     * the info is ΣValue
+     */
+    isValue?: boolean;
+    /**
+     * the data field id
+     */
+    dataFieldId?: string;
+}
+
+export declare interface IPivotViewItemData {
+    [row: number]: IPivotViewColData;
+}
+
+export declare interface IPivotViewItemJSON {
+    data: IPivotViewItemData;
+    info: IPivotViewInfo[];
+    rowCount: number;
+    colCount: number;
+    lastCol: number;
+    lastRow: number;
+}
+
+export declare interface IPivotViewJSON {
+    pageView: IPageViewItemJSON;
+    rowView: ILabelViewItemJSON;
+    colView: ILabelViewItemJSON;
+    dataView: IPivotViewItemJSON;
+    cornerView: IPivotViewItemJSON;
+    version: number;
+    formatMap: Record<string, string>;
+}
+
+export declare interface IPivotViewPrefixValue {
+    prefix: string;
+    value: string;
+}
+
+export declare type IPivotViewValueType = number | string | undefined | IPivotViewErrorValue | IPivotViewPrefixValue;
+
+export declare interface IRowNodeSizeInfo extends INodeSizeInfo {
+    valueIndex?: number;
+}
+
+/**
+ * -judge the filter info is customFilter filter
+ * @param {IPivotTableFilterInfo} filterInfo - the dimension filter info
+ * @returns {boolean} return true if the filter info is custom filter
+ */
+export declare function isCustomFilter(filterInfo: IPivotTableFilterInfo): filterInfo is IPivotTableCustomFilter;
+
+/**
+ * - judge the value is date like type
+ * @param {IDataFieldValue} value the date like value
+ * @returns {boolean} - return true if the value is date like type
+ */
+export declare function isDateValue(value: IDataFieldValue): value is IDateValue;
+
+/**
+ * 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;
+
+/**
+ * -judge the filter info is manual filter
+ * @param {IPivotTableFilterInfo} filterInfo - the dimension filter info
+ * @returns {boolean} return true if the filter info is manual filter
+ */
+export declare function isManualFilter(filterInfo: IPivotTableFilterInfo): filterInfo is IPivotTableManualFilter;
+
+/**
+ * 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 filter info is customFilter filter
+ * @param {IPivotTableFilterInfo} filterInfo - the dimension filter info
+ * @returns {boolean} return true if the filter info is custom filter
+ */
+export declare function isValueFilter(filterInfo: IPivotTableFilterInfo): filterInfo is IPivotTableCustomFilter;
+
+export declare interface ITPivotTupleInfo {
+    sum: number;
+    count: number;
+    countN: number;
+    product: number;
+    min: number;
+    max: number;
+    squareSum: number;
+}
+
+export declare interface ITupleItem {
+    path: string[];
+    types: PivotDataFieldDataTypeEnum[];
+    tuple: IMeasureTupleItem;
+    indexes: number[];
+    summary?: Record<string, ITupleItemSummary>;
+}
+
+export declare type ITupleItemSummary = ITPivotTupleInfo & {
+    [subtotalType in PivotSubtotalTypeEnum]?: number | {
+        errorType: PivotErrorTypeEnum;
+    };
+};
+
+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;
+}
+
+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 | undefined;
+}
+
+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;
+}
+
+/**
+ * Represents the pivot cell style type enum
+ */
+export declare enum PivotCellStyleTypeEnum {
+    /**
+     * the pivot table page filter selected all
+     */
+    FilterAll = 1,
+    /**
+     * the pivot table page filter selected partial
+     */
+    FilterPartial = 2,
+    /**
+     * the pivot table page filter selected one
+     */
+    FilterSingle = 3,
+    /**
+     * the pivot table area cell is blank
+     */
+    BlankValue = 4,
+    /**
+     * the pivot table dimension cell has filter but not sort
+     */
+    FilteredSortNone = 5,
+    /**
+     * the pivot table dimension cell has filter and sort asc
+     */
+    FilteredSortAsc = 6,
+    /**
+     * the pivot table dimension cell has filter and sort desc
+     */
+    FilteredSortDesc = 7,
+    /**
+     * the pivot table dimension cell has no filter and sort
+     */
+    FilterNoneSortNone = 8,
+    /**
+     * the pivot table dimension cell has no filter and sort asc
+     */
+    FilterNoneSortAsc = 9,
+    /**
+     * the pivot table dimension cell has no filter and sort desc
+     */
+    FilterNoneSortDesc = 10,
+    /**
+     * the branch node of tree can be collapse
+     */
+    Collapse = 11,
+    /**
+     * the branch node of tree can be expand
+     */
+    Expand = 12,
+    /**
+     * the subtotal cell, the real value should be  `${value} Total` or `${value} 汇总`
+     */
+    Subtotal = 13,
+    /**
+     * the grand total cell, the value template should be `GrandTotal` or `总计`
+     */
+    GrandTotal = 14,
+    /**
+     * the grandtotal has more than oen value,  the real value should be  `Total ${value}` or `总计 ${value}`
+     */
+    MultipleGrandTotal = 15
+}
+
+/**
+ * Enum for pivot table data field types.
+ * @readonly
+ * @enum {number}
+ */
+export declare enum PivotDataFieldDataTypeEnum {
+    /**
+     *the string data type
+     */
+    text = 1,
+    /**
+     * the number data type
+     */
+    number = 2,
+    /**
+     * the boolean data type
+     */
+    boolean = 3,
+    /**
+     * the date data type
+     */
+    date = 4,
+    /**
+     * the blank data type
+     */
+    blank = 5
+}
+
+/**
+ * Enum for pivot table data field sort types.
+ * @readonly
+ * @enum {number}
+ * @property {number} ascending - the ascending sort
+ * @property {number} descending - the descending sort
+ * @property {number} manual - the manual sort
+ */
+export declare enum PivotDataFieldSortOperatorEnum {
+    /**
+     * - the ascending sort
+     */
+    ascending = 1,
+    /**
+     * - the descending sort
+     */
+    descending = 2
+}
+
+/**
+ * Represents the sort types for pivot data fields.
+ */
+export declare enum PivotDataFieldSortTypeEnum {
+    /**
+     * Sorts by the value of the data field.
+     */
+    value = 1,
+    /**
+     * Sorts by the field name of the data field.
+     */
+    field = 2
+}
+
+/**
+ * Enum for pivot table error types.
+ * @description those error types almost occur in the pivot table show data as calculation.
+ */
+export declare enum PivotErrorTypeEnum {
+    /**
+     * #DIV/0! - the divide by zero error
+     */
+    Div0 = 1,
+    /**
+     * #N/A - the not available error
+     */
+    NotNumber = 2,
+    /**
+     * #NAME! -  The error occurs when a function is used incorrectly in a formula.
+     */
+    NotFunction = 3,
+    /**
+     * #NAME? error, The error occurs a function not defined in the workbook.
+     */
+    NotName = 4,
+    /**
+     * #REF! - the reference error , The error occurs when a cell reference is not valid.
+     */
+    BadReference = 5
+}
+
+/**
+ * Enum for pivot table data field types.
+ * @readonly
+ * @enum {number}
+ */
+export declare enum PivotFilterTypeEnum {
+    /**
+     * the label filter
+     */
+    CustomFilter = 1,
+    /**
+     * - the value filter
+     */
+    ValueFilter = 2,
+    /**
+     *- the manual filter
+     */
+    ManualFilter = 3
+}
+
+/**
+ * Enum for pivot table layout types.
+ * @readonly
+ * @enum {number}
+ */
+export declare enum PivotLayoutTypeEnum {
+    /**
+     * @property {number} compact - the compact layout
+     */
+    compact = 1,
+    /**
+     * @property {number} outline - the outline layout
+     */
+    outline = 2,
+    /**
+     * @property {number} tabular - the tabular layout
+     */
+    tabular = 3
+}
+
+/**
+ * @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@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(): 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.
+     * @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): IPivotTableSortInfo | 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 PositionInfo@typedef PositionInfo
+     * @property {PivotTableFiledAreaEnum} area - The area of the field.
+     * @property {number} index - The index of the field in the area.
+     * @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;
+        index: number;
+    };
+    updateFieldSourceInfo(fieldId: string, sourceName: string, dataFieldId: string): void;
+    getFieldsAreaByType(type: PivotTableFiledAreaEnum): string[];
+    getFieldById(fieldId: string): PivotTableLabelField | PivotTableValueField | 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;
+}
+
+/**
+ * Enum for pivot table show as types.
+ * @readonly
+ * @enum {number}
+ */
+export declare enum PivotShowAsTypeEnum {
+    /**
+     * - the normal value
+     */
+    normal = 1,
+    /**
+     * - the value as a percentage of the column total
+     */
+    percentOfColumnTotal = 2,
+    /**
+     * - the value as a percentage of the row total
+     */
+    percentOfRowTotal = 3,
+    /**
+     * - the value as a percentage of the grand total
+     */
+    percentOfGrandTotal = 4,
+    /**
+     * - the value as a percentage of the parent column total
+     */
+    percentOfParentColumnTotal = 5,
+    /**
+     * - the value as a percentage of the parent row total
+     */
+    percentOfParentRowTotal = 6,
+    /**
+     * - the value as a percentage of the parent grand total
+     */
+    percentOfParentGrandTotal = 7,
+    /**
+     * - the index of the value
+     */
+    index = 8,
+    /**
+     * - the difference from the value
+     */
+    differenceFrom = 9,
+    /**
+     * - the percentage difference from the value
+     */
+    percentDifferenceFrom = 10,
+    /**
+     * - the running total of the value
+     */
+    runningTotal = 11,
+    /**
+     * - the percentage running total of the value
+     */
+    percentRunningTotal = 12,
+    /**
+     *- the percentage of the value
+     */
+    percentOf = 13,
+    /**
+     * - the percentage of the parent value
+     */
+    percentOfParent = 14
+}
+
+/**
+ *Enum for pivot table subtotal types.
+ @readonly
+ @enum {number}
+ */
+export declare enum PivotSubtotalTypeEnum {
+    /**
+     *- the average of the values
+     */
+    average = 1,
+    /**
+     *- the count of the values
+     */
+    count = 2,
+    /**
+     *- the count of the numbers in the values
+     */
+    countNums = 3,
+    /**
+     *- the maximum value in the values
+     */
+    max = 4,
+    /**
+     *- the minimum value in the values
+     */
+    min = 5,
+    /**
+     *- the product of the values
+     */
+    product = 6,
+    /**
+     *- the standard deviation of the values
+     */
+    stdDev = 7,
+    /**
+     *- the population standard deviation of the values
+     */
+    stdDevp = 8,
+    /**
+     *- the sum of the values
+     */
+    sum = 9,
+    /**
+     *- the variance of the values
+     */
+    var = 10,
+    /**
+     *- the population variance of the values
+     */
+    varp = 11
+}
+
+/**
+ * @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(): 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 | undefined;
+    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): PivotTableLabelField | PivotTableValueField | 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): 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 | 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.
+     * @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(): 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.
+     * @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;
+    /**
+     * @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;
+    /**
+     * 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,
+     * summarize and sort to get all the relevant source data rows
+     *
+     * 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
+     * @returns {number[]} -Sorted row numbers
+     */
+    getIndexesByPathStr(tuple: string[][]): number[];
+    setDirty(dirty: boolean): void;
+    query(config?: IPivotTableQueryData): PivotView;
+    toJSON(): IPivotTableSnapshot;
+    fromJSON(data: IPivotTableSnapshot): void;
+    dispose(): void;
+}
+
+export declare enum PivotTableChangeTypeEnum {
+    AddField = 0,
+    SetSubtotalType = 1,
+    RemoveField = 2,
+    RenameField = 3,
+    SetFilterInfo = 4,
+    SetSortInfo = 5,
+    UpdateFieldPosition = 6,
+    UpdateValuePosition = 7,
+    SetOptions = 8,
+    SetFieldFormat = 9,
+    SetCollapse = 10,
+    UpdateSource = 11
+}
+
+/**
+ * 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;
+}
+
+/**
+ * Enum for pivot table field types.
+ * @description those field types are used in the pivot table or pivot chart.
+ * @readonly
+ * @typedef {number} PivotTableFieldTypeEnum
+ * @property {number} Column - the label field position in the pivot table column area
+ * @property {number} Row - the label field position in the pivot table row area
+ * @property {number} Value - the value field position in the pivot table
+ * @property {number} Filter - the filter field position in the pivot table, it called the page field in Excel
+ * @property {number} Hidden - the hidden field, it is not shown in the pivot table, but when a slice is created, it will be relation to the slice.
+ */
+export declare enum PivotTableFiledAreaEnum {
+    /**
+     * Column - the column field
+     */
+    Column = 1,
+    /**
+     * Row - the row field
+     */
+    Row = 2,
+    /**
+     * Value - the value field
+     */
+    Value = 3,
+    /**
+     * Filter - the filter field
+     */
+    Filter = 4,
+    /**
+     * Hidden - the hidden field, it is not shown in the pivot table, but when a slice is created, it will be relation to the slice.
+     */
+    Hidden = 5
+}
+
+/**
+ * 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;
+}
+
+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;
+}
+
+/**
+ * Enum for pivot table value field position types. in the pivot table, the value field can be placed in the column or row field.
+ * @readonly
+ * @enum {number}
+ */
+export declare enum PivotTableValuePositionEnum {
+    /**
+     * - the value field not exist in the column or row field
+     */
+    None = -1,
+    /**
+     * - the value field position in the column field
+     */
+    Column = 1,
+    /**
+     * - the value field position in the row field
+     */
+    Row = 2
+}
+
+/**
+ * @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;
+    };
+}
+
+/**
+ * @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 enum PivotViewCellValueTypeEnum {
+    blank = 2,
+    date = 4
+}
+
+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;
+    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): 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;
+    fromJSON(json: IPivotViewItemJSON): void;
+}
+
+/**
+ * Enum for IST_PivotFilter Operator
+ * @enum {number}
+ */
+export declare enum ST_PivotFilterOperatorEnum {
+    /**
+     * Filter by caption that begins with a specific value
+     * @type {number}
+     */
+    captionBeginsWith = 1,
+    /**
+     * Filter by caption that is between two values
+     * @type {number}
+     */
+    captionBetween = 2,
+    /**
+     * Filter by caption that contains a specific value
+     * @type {number}
+     */
+    captionContains = 3,
+    /**
+     * Filter by caption that ends with a specific value
+     * @type {number}
+     */
+    captionEndsWith = 4,
+    /**
+     * Filter by caption that is equal to a specific value
+     * @type {number}
+     */
+    captionEqual = 5,
+    /**
+     * Filter by caption that is greater than a specific value
+     * @type {number}
+     */
+    captionGreaterThan = 6,
+    /**
+     * Filter by caption that is greater than or equal to a specific value
+     * @type {number}
+     */
+    captionGreaterThanOrEqual = 7,
+    /**
+     * Filter by caption that is less than a specific value
+     * @type {number}
+     */
+    captionLessThan = 8,
+    /**
+     * Filter by caption that is less than or equal to a specific value
+     * @type {number}
+     */
+    captionLessThanOrEqual = 9,
+    /**
+     * Filter by caption that does not begin with a specific value
+     * @type {number}
+     */
+    captionNotBeginsWith = 10,
+    /**
+     * Filter by caption that is not between two values
+     * @type {number}
+     */
+    captionNotBetween = 11,
+    /**
+     * Filter by caption that does not contain a specific value
+     * @type {number}
+     */
+    captionNotContains = 12,
+    /**
+     * Filter by caption that does not end with a specific value
+     * @type {number}
+     */
+    captionNotEndsWith = 13,
+    /**
+     * Filter by caption that is not equal to a specific value
+     * @type {number}
+     */
+    captionNotEqual = 14,
+    /**
+     * Filter by count
+     * @type {number}
+     */
+    count = 15,
+    /**
+     * Filter by date that is between two values
+     * @type {number}
+     */
+    dateBetween = 16,
+    /**
+     * Filter by date that is equal to a specific value
+     * @type {number}
+     */
+    dateEqual = 17,
+    /**
+     * Filter by date that is newer than a specific value
+     * @type {number}
+     */
+    dateNewerThan = 18,
+    /**
+     * Filter by date that is newer than or equal to a specific value
+     * @type {number}
+     */
+    dateNewerThanOrEqual = 19,
+    /**
+     * Filter by date that is not between two values
+     * @type {number}
+     */
+    dateNotBetween = 20,
+    /**
+     * Filter by date that is not equal to a specific value
+     * @type {number}
+     */
+    dateNotEqual = 21,
+    /**
+     * Filter by date that is older than a specific value
+     * @type {number}
+     */
+    dateOlderThan = 22,
+    /**
+     * Filter by date that is older than or equal to a specific value
+     * @type {number}
+     */
+    dateOlderThanOrEqual = 23,
+    /**
+     * Filter by last month
+     * @type {number}
+     */
+    lastMonth = 24,
+    /**
+     * Filter by last quarter
+     * @type {number}
+     */
+    lastQuarter = 25,
+    /**
+     * Filter by last week
+     * @type {number}
+     */
+    lastWeek = 26,
+    /**
+     * Filter by last year
+     * @type {number}
+     */
+    lastYear = 27,
+    /**
+     * Filter by dates in January
+     * @type {number}
+     */
+    M1 = 28,
+    /**
+     * Filter by dates in October
+     * @type {number}
+     */
+    M10 = 29,
+    /**
+     * Filter by dates in November
+     * @type {number}
+     */
+    M11 = 30,
+    /**
+     * Filter by dates in December
+     * @type {number}
+     */
+    M12 = 31,
+    /**
+     * Filter by dates in February
+     * @type {number}
+     */
+    M2 = 32,
+    /**
+     * Filter by dates in March
+     * @type {number}
+     */
+    M3 = 33,
+    /**
+     * Filter by dates in April
+     * @type {number}
+     */
+    M4 = 34,
+    /**
+     * Filter by dates in May
+     * @type {number}
+     */
+    M5 = 35,
+    /**
+     * Filter by dates in June
+     * @type {number}
+     */
+    M6 = 36,
+    /**
+     * Filter by dates in July
+     * @type {number}
+     */
+    M7 = 37,
+    /**
+     * Filter by dates in August
+     * @type {number}
+     */
+    M8 = 38,
+    /**
+     * Filter by dates in September
+     * @type {number}
+     */
+    M9 = 39,
+    /**
+     * Filter by next month
+     * @type {number}
+     */
+    nextMonth = 40,
+    /**
+     * Filter by next quarter
+     * @type {number}
+     */
+    nextQuarter = 41,
+    /**
+     * Filter by next week
+     * @type {number}
+     */
+    nextWeek = 42,
+    /**
+     * Filter by next year
+     * @type {number}
+     */
+    nextYear = 43,
+    /**
+     * Filter by percent
+     * @type {number}
+     */
+    percent = 44,
+    /**
+     * Filter by first quarter
+     * @type {number}
+     */
+    Q1 = 45,
+    /**
+     * Filter by second quarter
+     * @type {number}
+     */
+    Q2 = 46,
+    /**
+     * Filter by third quarter
+     * @type {number}
+     */
+    Q3 = 47,
+    /**
+     * Filter by fourth quarter
+     * @type {number}
+     */
+    Q4 = 48,
+    /**
+     * Filter by sum
+     * @type {number}
+     */
+    sum = 49,
+    /**
+     * Filter by this month
+     * @type {number}
+     */
+    thisMonth = 50,
+    /**
+     * Filter by this quarter
+     * @type {number}
+     */
+    thisQuarter = 51,
+    /**
+     * Filter by this week
+     * @type {number}
+     */
+    thisWeek = 52,
+    /**
+     * Filter by this year
+     * @type {number}
+     */
+    thisYear = 53,
+    /**
+     * Filter by today
+     * @type {number}
+     */
+    today = 54,
+    /**
+     * Filter by tomorrow
+     * @type {number}
+     */
+    tomorrow = 55,
+    /**
+     * Filter by unknown
+     * @type {number}
+     */
+    unknown = 56,
+    /**
+     * Filter by value that is between two values
+     * @type {number}
+     */
+    valueBetween = 57,
+    /**
+     * Filter by value that is equal to a specific value
+     * @type {number}
+     */
+    valueEqual = 58,
+    /**
+     * Filter by value that is greater than a specific value
+     * @type {number}
+     */
+    valueGreaterThan = 59,
+    /**
+     * Filter by value that is greater than or equal to a specific value
+     * @type {number}
+     */
+    valueGreaterThanOrEqual = 60,
+    /**
+     * Filter by value that is less than a specific value
+     * @type {number}
+     */
+    valueLessThan = 61,
+    /**
+     * Filter by value that is less than or equal to a specific value
+     * @type {number}
+     */
+    valueLessThanOrEqual = 62,
+    /**
+     * Filter by value that is not between two values
+     * @type {number}
+     */
+    valueNotBetween = 63,
+    /**
+     * Filter by value that is not equal to a specific value
+     * @type {number}
+     */
+    valueNotEqual = 64,
+    /**
+     * Filter by year-to-date
+     * @type {number}
+     */
+    yearToDate = 65,
+    /**
+     * Filter by yesterday
+     * @type {number}
+     */
+    yesterday = 66
+}
+
+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: 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;
+}
+
+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;
+}
+
+export { }