@univerjs-pro/engine-pivot 1.0.0-rc.0 → 1.0.0

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

@@ -1,5 +1,8 @@
-import type { IPivotTableChangeSet, IPivotTableFilterInfo, IPivotTableOptions, IPivotTableQueryData, IPivotTableShowDataAsInfo, IPivotTableSnapshot, IPivotTableSortInfo, IPivotTableValueFilter, IValueFilterInfoItem, PivotSubtotalTypeEnum } from '../types';
-import { PivotLayoutTypeEnum, PivotTableFiledAreaEnum, PivotTableValuePositionEnum } from '../types';
+import type { PivotSubtotalTypeEnum } from '../types/enum';
+import type { IPivotTableFilterInfo, IPivotTableQueryData, IPivotTableShowDataAsInfo, IPivotTableSortInfo, IPivotTableValueFilter, IValueFilterInfoItem } from '../types/interface';
+import type { IPivotTableChangeSet, IPivotTableSnapshot } from '../types/json-types';
+import type { IPivotTableOptions } from '../types/layout-type';
+import { PivotLayoutTypeEnum, PivotTableFiledAreaEnum, PivotTableValuePositionEnum } from '../types/enum';
 import { PivotTableLabelField, PivotTableValueField } from './table-field';
 /**
  * @class PivotModel represents a config model for a pivot table.
@@ -102,10 +105,11 @@ export declare class PivotModel {
     /**
      * @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 {boolean | Record<string, boolean> | undefined} collapse - The field state, or undefined to clear it.
      * @param {string} [item] - The item of the field.
+     * @param {readonly string[]} [items] - Cached members used to expand one item of a fully collapsed field.
      */
-    setCollapse(fieldId: string, collapse: boolean, item?: string): void;
+    setCollapse(fieldId: string, collapse: boolean | Record<string, boolean> | undefined, item?: string, items?: readonly string[]): void;
     setLabelFilterInfo(fieldId: string, filterInfo: IPivotTableFilterInfo): void;
     setValueFilterInfo(fieldId: string, filterInfo: IPivotTableValueFilter | undefined, index?: number): void;
     getValueFilterInfo(fieldId: string): IPivotTableValueFilter | undefined;

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

@@ -239,10 +239,17 @@ export declare class PivotTable {
     /**
      * @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 {boolean | Record<string, boolean> | undefined} collapse - The field state, or undefined to clear it.
      * @param {string} [item] - The item of the field.
      */
-    setCollapse(fieldId: string, collapse: boolean, item?: string): void;
+    setCollapse(fieldId: string, collapse: boolean | Record<string, boolean> | undefined, item?: string): void;
+    /**
+     * @description Set the visible row hierarchy depth without querying the pivot table. Ancestors are expanded,
+     * the target and deeper parent fields are collapsed. Column fields and the Values position are unchanged.
+     * @param {string} fieldId - The row field to display as the deepest category.
+     * @returns {boolean} Whether the target is a row field.
+     */
+    setRowCollapseLevel(fieldId: string): boolean;
     /**
      * - get the pivot view need query or not
      * @param {number} viewVersion

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

@@ -504,12 +504,16 @@ export interface IPivotTableSetCollapseChange {
      */
     fieldId: string;
     /**
-     * @property {boolean} collapse The collapse state of the field.
+     * @property {boolean | Record<string, boolean> | undefined} collapse The field state, or undefined to clear it.
      */
-    collapse: boolean;
+    collapse: boolean | Record<string, boolean> | undefined;
     /**
      * @property {string} [item] The item associated with the collapse state.
      */
     item?: string;
+    /** Previous full field state. Absent on legacy item-only changesets. */
+    previous?: {
+        collapse?: boolean | Record<string, boolean>;
+    };
 }
 export type IPivotTableChangeSet = IPivotTableAddFieldChange | IPivotTableSetSubtotalTypeChange | IPivotTableSetShowDataAsChange | IPivotTableRemoveFieldChange | IPivotTableRenameFieldChange | IPivotTableSetFilterInfoChange | IPivotTableSetSortInfoChange | IPivotTableUpdatePositionChange | IPivotTableUpdateValuePositionChange | IPivotTableSetOptionsChange | IPivotTableSetFormatChange | IPivotTableSetCollapseChange | IPivotUpdateSourceChange | IPivotTableSetValueFilterChange | IPivotTableSetLayoutChange;

package/lib/types/util.d.ts

@@ -1,9 +1,13 @@
 import type { BaseGroupField } from './field/base-group-field';
 import type { DataField } from './field/data-field';
 import type { DateGroupField } from './field/date-group-field';
-import type { IBaseGroupFieldJSON, IDataFieldJSON, IDataFieldValue, IDateGroupFieldJSON, IDateValue, IMeasuresMapItem, IPivotTableCustomFilter, IPivotTableDateGroupInfo, IPivotTableFilterInfo, IPivotTableLabelCustomSortInfo, IPivotTableManualFilter, IPivotTableSortInfo, ITupleItem, IValueFilterInfoItem, PivotErrorTypeEnum, ST_PivotFilterOperatorEnum } from './types';
+import type { PivotErrorTypeEnum, ST_PivotFilterOperatorEnum } from './types/enum';
+import type { IDataFieldValue, IDateValue, IPivotTableCustomFilter, IPivotTableDateGroupInfo, IPivotTableFilterInfo, IPivotTableLabelCustomSortInfo, IPivotTableManualFilter, IPivotTableSortInfo, IValueFilterInfoItem } from './types/interface';
+import type { IBaseGroupFieldJSON, IDataFieldJSON, IDateGroupFieldJSON } from './types/json-types';
+import type { IMeasuresMapItem, ITupleItem } from './types/summary-type';
 import { PivotTuple } from './summary/pivot-tuple';
-import { PivotCellStyleTypeEnum, PivotDataFieldDataTypeEnum, PivotDateGroupFieldDateTypeEnum, PivotSubtotalTypeEnum, PivotTableFiledAreaEnum } from './types';
+import { PivotDataFieldDataTypeEnum, PivotDateGroupFieldDateTypeEnum, PivotSubtotalTypeEnum, PivotTableFiledAreaEnum } from './types/enum';
+import { PivotCellStyleTypeEnum } from './types/layout-type';
 /**
  * - judge the value is date like type
  * @param {IDataFieldValue} value the date like value