@univerjs-pro/engine-pivot 0.6.7 → 0.6.9

package/lib/types/types/enum.d.ts

@@ -265,7 +265,11 @@ export declare enum PivotDataFieldSortOperatorEnum {
     /**
      * - the descending sort
      */
-    descending = 2
+    descending = 2,
+    /**
+     * - the custom sort
+     */
+    custom = 3
 }
 /**
  * Enum for IST_PivotFilter Operator
@@ -636,3 +640,93 @@ export declare enum PivotCallbackEnum {
      */
     onQueryEnd = "onQueryEnd"
 }
+/**
+ * Enum for pivot data field group type.
+ * @enum {number}
+ */
+export declare enum PivotDataFieldTypeEnum {
+    /**
+     * - the default data field
+     */
+    defaultNormalField = 1,
+    /**
+     * - the number group type
+     */
+    numberGroupField = 2,
+    /**
+     * - the date group type
+     */
+    dateGroupField = 3,
+    /**
+     * - the text group type
+     */
+    textGroupField = 4,
+    /**
+     * - the custom group type, if this grouping is used, the user needs to register the relevant records generation function
+     */
+    customGroupField = 5
+}
+/**
+ * Enum for representing different date group field types in a pivot table.
+ */
+export declare enum PivotDateGroupFieldDateTypeEnum {
+    /**
+     * The minute date type.
+     * Represents data grouped by minute.
+     */
+    Minute = "minute",
+    /**
+     * The hour date type.
+     * Represents data grouped by hour.
+     */
+    Hour = "hour",
+    /**
+     * The hour-minute date type.
+     * Represents data grouped by both hour and minute.
+     */
+    HourMinute = "hour-minute",
+    /**
+     * The date type.
+     * Represents data grouped by specific dates.
+     */
+    Date = "date",
+    /**
+     * The month date type.
+     * Represents data grouped by month.
+     */
+    Month = "month",
+    /**
+     * The month-date type.
+     * Represents data grouped by both month and specific dates.
+     */
+    MonthDate = "month-date",
+    /**
+     * The quarter date type.
+     * Represents data grouped by quarters (e.g., Q1, Q2).
+     */
+    Quarter = "quarter",
+    /**
+     * The year date type.
+     * Represents data grouped by year.
+     */
+    Year = "year",
+    /**
+     * The year-month date type.
+     * Represents data grouped by both year and month.
+     */
+    YearMonth = "year-month",
+    /**
+     * The year-quarter date type.
+     * Represents data grouped by both year and quarter.
+     */
+    YearQuarter = "year-quarter",
+    /**
+     * The year-month-date type.
+     * Represents data grouped by year, month, and specific dates.
+     */
+    YearMonthDate = "year-month-date"
+}
+export declare enum PivotDateGroupFieldDateSystemEnum {
+    Date1900 = "date1900",
+    Date1904 = "date1904"
+}

package/lib/types/types/interface.d.ts

@@ -1,4 +1,4 @@
-import { PivotDataFieldDataTypeEnum, PivotDataFieldSortOperatorEnum, PivotFilterTypeEnum, PivotShowAsTypeEnum, PivotSubtotalTypeEnum, ST_PivotFilterOperatorEnum } from './enum';
+import { PivotDataFieldDataTypeEnum, PivotDataFieldSortOperatorEnum, PivotDataFieldTypeEnum, PivotDateGroupFieldDateTypeEnum, PivotFilterTypeEnum, PivotShowAsTypeEnum, PivotSubtotalTypeEnum, ST_PivotFilterOperatorEnum } from './enum';
 export 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
@@ -25,6 +25,22 @@ export interface IDataFieldInfo {
     minDate: number;
     records: IDataFieldValue[];
     rangeKey: string;
+    /**
+     * @description the data field type, Used to distinguish between grouping and original data field
+     */
+    dataFieldType: PivotDataFieldTypeEnum;
+}
+export interface IBaseGroupFieldInfo extends IDataFieldInfo {
+    /**
+     * @description the original field id of the group field
+     */
+    originalFieldId: string;
+}
+export interface IDateGroupFieldInfo extends IBaseGroupFieldInfo {
+    /**
+     * @description the date type of the date group field
+     */
+    dateType?: PivotDateGroupFieldDateTypeEnum;
 }
 export interface IPivotField {
     id: string;
@@ -52,10 +68,18 @@ export interface IPivotTuple {
     squareSum: number;
 }
 export type IPivotTableFilterInfo = IPivotTableManualFilter | IPivotTableCustomFilter | IPivotTableValueFilter;
-export type IPivotTableSortInfo = IPivotTableLabelSortInfo | IPivotTableValueSortInfo;
+export type IPivotTableSortInfo = IPivotTableLabelSortInfo | IPivotTableValueSortInfo | IPivotTableLabelCustomSortInfo;
+export type IPivotTableGroupInfo = IPivotTableDateGroupInfo;
+export interface IPivotTableDateGroupInfo {
+    type: PivotDataFieldTypeEnum.dateGroupField;
+    dateType: PivotDateGroupFieldDateTypeEnum;
+}
 export interface IPivotTableLabelSortInfo {
     type: PivotDataFieldSortOperatorEnum;
 }
+export interface IPivotTableLabelCustomSortInfo extends IPivotTableLabelSortInfo {
+    customOrder: string[];
+}
 export interface IPivotTableValueSortInfo {
     /**
      * @property {PivotDataFieldSortOperatorEnum} - The sort operator of the field items.
@@ -123,7 +147,7 @@ export interface IPivotTableLabelFieldQueryData {
     /**
      * Information about the sort applied to the label field.
      */
-    sortInfo: IPivotTableSortInfo;
+    sortInfo?: IPivotTableSortInfo;
 }
 /**
  * Represents the data structure for a pivot table query.

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

@@ -1,4 +1,4 @@
-import { PivotDataFieldDataTypeEnum, PivotLayoutTypeEnum, PivotSubtotalTypeEnum, PivotTableFiledAreaEnum, PivotTableValuePositionEnum } from './enum';
+import { PivotDataFieldDataTypeEnum, PivotDataFieldTypeEnum, PivotDateGroupFieldDateTypeEnum, PivotLayoutTypeEnum, PivotSubtotalTypeEnum, PivotTableFiledAreaEnum, PivotTableValuePositionEnum } from './enum';
 import { IPivotTableFilterInfo, IPivotTableShowDataAsInfo, IPivotTableSortInfo, IPivotTableValueFilter, IValueFilterInfoItem } from './interface';
 import { IPivotTableOptions } from './layout-type';
 export interface IPivotTableValueFieldJSON {
@@ -90,10 +90,26 @@ export interface IDataFieldJSON {
     hexCode: string;
     fieldDataType: PivotDataFieldDataTypeEnum;
     rangeKey: string;
+    /**
+     * @description the data field type, Used to distinguish between grouping and original data field
+     */
+    dataFieldType: PivotDataFieldTypeEnum;
+}
+export interface IBaseGroupFieldJSON extends IDataFieldJSON {
+    /**
+     * @description the original field id of the group field
+     */
+    originalFieldId: string;
+}
+export interface IDateGroupFieldJSON extends IBaseGroupFieldJSON {
+    /**
+     * @description the date type of the date group field
+     */
+    dateType?: PivotDateGroupFieldDateTypeEnum;
 }
 export interface IDataFieldManagerBaseJSON {
     collections: Record<string, IFieldsCollectionJSON>;
-    dataFields: Record<string, IDataFieldJSON>;
+    dataFields: Record<string, IDataFieldJSON | IBaseGroupFieldJSON>;
 }
 /**
  * Represents the change type of the pivot table.

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

@@ -2,7 +2,7 @@ import { PivotView } from '../layout/pivot-view';
 import { NodeTree } from '../summary/node-tree';
 import { SummaryManager } from '../summary/summary-manager';
 import { PivotErrorTypeEnum } from './enum';
-import { IPivotTableQueryData, IPivotTableValueFieldQueryData, IValueFilterInfoItem } from './interface';
+import { IPivotTableGroupInfo, IPivotTableQueryData, IPivotTableValueFieldQueryData, IValueFilterInfoItem } from './interface';
 export interface IPivotViewItemData {
     [row: number]: IPivotViewColData;
 }
@@ -239,5 +239,6 @@ export interface IPivotViewJSON {
     cornerView: IPivotViewItemJSON;
     version: number;
     formatMap: Record<string, string>;
+    groupInfo: Record<string, IPivotTableGroupInfo>;
 }
 export {};

package/lib/types/util.d.ts

@@ -1,4 +1,7 @@
-import { IDataFieldValue, IDateValue, IMeasuresMapItem, IPivotTableCustomFilter, IPivotTableFilterInfo, IPivotTableManualFilter, IPivotTableSortInfo, ITupleItem, IValueFilterInfoItem, PivotErrorTypeEnum, ST_PivotFilterOperatorEnum, PivotCellStyleTypeEnum, PivotDataFieldDataTypeEnum, PivotSubtotalTypeEnum, PivotTableFiledAreaEnum } from './types';
+import { BaseGroupField } from './field/base-group-field';
+import { DataField } from './field/data-field';
+import { DateGroupField } from './field/date-group-field';
+import { IBaseGroupFieldJSON, IDataFieldJSON, IDataFieldValue, IDateGroupFieldJSON, IDateValue, IMeasuresMapItem, IPivotTableCustomFilter, IPivotTableDateGroupInfo, IPivotTableFilterInfo, IPivotTableGroupInfo, IPivotTableLabelCustomSortInfo, IPivotTableManualFilter, IPivotTableSortInfo, ITupleItem, IValueFilterInfoItem, PivotErrorTypeEnum, ST_PivotFilterOperatorEnum, PivotCellStyleTypeEnum, PivotDataFieldDataTypeEnum, PivotDateGroupFieldDateTypeEnum, PivotSubtotalTypeEnum, PivotTableFiledAreaEnum } from './types';
 import { PivotTuple } from './summary/pivot-tuple';
 /**
  * - judge the value is date like type
@@ -101,7 +104,7 @@ export declare function getFilterStatusAndValue(filterInfo: IPivotTableFilterInf
  * @param {IPivotTableSortInfo} sortInfo the sort info
  * @returns {PivotCellStyleTypeEnum} the cell style type
  */
-export declare function getDimFilterSortStatus(filterInfo: IPivotTableFilterInfo | undefined, sortInfo: IPivotTableSortInfo, valueFilterInfo: IValueFilterInfoItem): PivotCellStyleTypeEnum;
+export declare function getDimFilterSortStatus(filterInfo: IPivotTableFilterInfo | undefined, sortInfo: IPivotTableSortInfo | undefined, valueFilterInfo: IValueFilterInfoItem): PivotCellStyleTypeEnum;
 /**
  *  - use the paths and value index to get the unique key of in layout pivot view, which use same rule to create the key in pivot engine
  * @param {string[]} paths - the paths of the cell
@@ -133,3 +136,11 @@ export declare function isErrorTypeSubtotal(subtotal: number | {
 }): subtotal is {
     errorType: PivotErrorTypeEnum;
 };
+export declare function isLabelCustomSortInfo(sortInfo: IPivotTableSortInfo): sortInfo is IPivotTableLabelCustomSortInfo;
+export declare function excelDateToUnixMilliseconds(excelDate: number, useDefault1900DateSystem?: boolean): number;
+export declare function isDateGroupField(field: DataField): field is DateGroupField;
+export declare function isBaseGroupField(field: DataField): field is BaseGroupField;
+export declare function isBaseGroupFieldJSON(field: IDataFieldJSON | IBaseGroupFieldJSON): field is IBaseGroupFieldJSON;
+export declare function isDateGroupFieldJSON(field: IDataFieldJSON | IBaseGroupFieldJSON): field is IDateGroupFieldJSON;
+export declare function isDateGroupInfo(groupInfo: IPivotTableGroupInfo): groupInfo is IPivotTableDateGroupInfo;
+export declare function getDateGroupValue(excelDate: number, dateType: PivotDateGroupFieldDateTypeEnum, useDefault1900DateSystem?: boolean): string;