@univerjs-pro/engine-pivot 1.3.0 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -22,7 +22,7 @@ export declare const setDevMode: (value: boolean) => boolean;
22
22
  * Allows to set the default sorting type for pivot table row/col fields
23
23
  * @param type 'sorting type, can be ascending,descending,default
24
24
  */
25
- export declare const setDefaultSortType: (type: "ascending" | "descending" | "default") => void;
25
+ export declare const setDefaultSortType: (type: 'ascending' | 'descending' | 'default') => void;
26
26
  /**
27
27
  * allows to set the date system for date grouping calculations
28
28
  * @param value The date system to use, either date1900 ,date1904
@@ -0,0 +1,5 @@
1
+ import type { IPivotTableCustomFilter, IPivotTableFilterInfo } from './types/interface';
2
+ import { ST_PivotFilterOperatorEnum } from './types/enum';
3
+ export declare function isFixedPivotDateFilterOperator(operator: ST_PivotFilterOperatorEnum): boolean;
4
+ export declare function isPivotDateFilter(filter: IPivotTableFilterInfo | undefined): filter is IPivotTableCustomFilter;
5
+ export declare function compilePivotDateFilter(filter: IPivotTableCustomFilter): (serial: number) => boolean;
@@ -1,5 +1,6 @@
1
- import type { IPivotTableCustomFilter, IPivotTableValueFilter } from './types';
2
- import { ST_PivotFilterOperatorEnum } from './types';
1
+ import type { IPivotTableCustomFilter, IPivotTableValueFilter } from './types/interface';
2
+ import { ST_PivotFilterOperatorEnum } from './types/enum';
3
+ export declare function compilePivotCaptionFilter(filter: IPivotTableCustomFilter): (caption: string) => boolean;
3
4
  export declare function isValueFilterOperator(operator: ST_PivotFilterOperatorEnum): boolean;
4
5
  export declare function selectValueFilterRankCutoff(values: number[], keepCount: number, isBottom: boolean): number | undefined;
5
6
  export declare function getFilterExecuteFunc(filterInfo: IPivotTableValueFilter | IPivotTableCustomFilter): (value: number) => boolean;
@@ -1,4 +1,5 @@
1
1
  export { GlobalConfig, setDateSystem, setMaxLimitItemCount, } from './const';
2
+ export { compilePivotDateFilter, isPivotDateFilter } from './date-filter';
2
3
  export { BaseGroupField } from './field/base-group-field';
3
4
  export { createDataFieldFromJSON } from './field/create-data-field';
4
5
  export { DataField } from './field/data-field';
@@ -11,10 +12,10 @@ export { isValueFilterOperator } from './filter-util';
11
12
  export { isErrorValue, isPrefixValue, LabelViewItem, PivotView, PivotViewItem, } from './layout/pivot-view';
12
13
  export { PivotTable } from './pivot/pivot-table';
13
14
  export { createLabelField, createValueField, PivotTableLabelField, PivotTableValueField, } from './pivot/table-field';
14
- export { getPivotRecordMember, isPivotTableFilterRestrictive } from './record-filter';
15
+ export { getPivotRecordMember, hasPivotMultipleFilters, isPivotTableFilterRestrictive } from './record-filter';
15
16
  export { isDateValue, isRecordErrorValue } from './record-value';
16
- export { PivotCallbackEnum, PivotDataFieldDataTypeEnum, PivotDataFieldSortOperatorEnum, PivotDataFieldSortTypeEnum, PivotDataFieldTypeEnum, PivotDateGroupFieldDateTypeEnum, PivotDateGroupingMode, PivotErrorTypeEnum, PivotExcelDateGroupUnit, PivotFilterTypeEnum, PivotLayoutTypeEnum, PivotShowAsBaseItemTypeEnum, PivotShowAsTypeEnum, PivotSubtotalPositionEnum, PivotSubtotalTypeEnum, PivotTableFiledAreaEnum, PivotTableValuePositionEnum, ST_PivotFilterOperatorEnum, } from './types/enum';
17
- export type { IDataFieldInfo, IDataFieldValue, IDateValue, IErrorValue, IExcelDateGrouping, IManualGroup, IManualGrouping, INumberGrouping, IPivotTableDateGroupInfo, IPivotTableFilterInfo, IPivotTableGroupInfo, IPivotTableManualFilter, IPivotTableNumberGroupInfo, IPivotTableRecordFilter, IPivotTableShowDataAsInfo, IPivotTableSortInfo, IPivotTableValueFilter, IValueFilterInfoItem, } from './types/interface';
17
+ export { PivotCallbackEnum, PivotDataFieldDataTypeEnum, PivotDataFieldSortOperatorEnum, PivotDataFieldSortTypeEnum, PivotDataFieldTypeEnum, PivotDateGroupFieldDateTypeEnum, PivotDateGroupingMode, PivotErrorTypeEnum, PivotExcelDateGroupUnit, PivotFilterCategory, PivotFilterTypeEnum, PivotLayoutTypeEnum, PivotShowAsBaseItemTypeEnum, PivotShowAsTypeEnum, PivotSubtotalPositionEnum, PivotSubtotalTypeEnum, PivotTableFiledAreaEnum, PivotTableValuePositionEnum, ST_PivotFilterOperatorEnum, } from './types/enum';
18
+ export type { IDataFieldInfo, IDataFieldValue, IDateValue, IErrorValue, IExcelDateGrouping, IManualGroup, IManualGrouping, INumberGrouping, IPivotTableCustomFilter, IPivotTableDateGroupInfo, IPivotTableFilterInfo, IPivotTableGroupInfo, IPivotTableManualFilter, IPivotTableNumberGroupInfo, IPivotTableRecordFilter, IPivotTableShowDataAsInfo, IPivotTableSortInfo, IPivotTableValueFilter, IValueFilterInfoItem, PivotTableConditionFilter, } from './types/interface';
18
19
  export type { IBaseGroupFieldJSON, IDataFieldManagerBaseJSON, IFieldsCollectionJSON, IManualGroupFieldJSON, INumberGroupFieldJSON, IPivotTableLabelFieldJSON, IPivotTableSnapshot, IPivotTableValueFieldJSON, } from './types/json-types';
19
20
  export { PivotTableChangeTypeEnum } from './types/json-types';
20
21
  export type { IPivotTableAddFieldChange, IPivotTableChangeSet, IPivotTableRemoveFieldChange, IPivotTableRenameFieldChange, IPivotTableSetCollapseChange, IPivotTableSetFilterInfoChange, IPivotTableSetFormatChange, IPivotTableSetLayoutChange, IPivotTableSetOptionsChange, IPivotTableSetShowDataAsChange, IPivotTableSetSortInfoChange, IPivotTableSetSubtotalTypeChange, IPivotTableSetValueFilterChange, IPivotTableUpdatePositionChange, IPivotTableUpdateValuePositionChange, IPivotUpdateSourceChange, } from './types/json-types';
@@ -1,8 +1,8 @@
1
1
  import type { PivotSubtotalTypeEnum } from '../types/enum';
2
- import type { IPivotTableFilterInfo, IPivotTableQueryData, IPivotTableShowDataAsInfo, IPivotTableSortInfo, IPivotTableValueFilter, IValueFilterInfoItem } from '../types/interface';
2
+ import type { IPivotTableFilterInfo, IPivotTableQueryData, IPivotTableShowDataAsInfo, IPivotTableSortInfo, IPivotTableValueFilter, IValueFilterInfoItem, PivotTableConditionFilter } from '../types/interface';
3
3
  import type { IPivotTableChangeSet, IPivotTableSnapshot } from '../types/json-types';
4
4
  import type { IPivotTableOptions } from '../types/layout-type';
5
- import { PivotLayoutTypeEnum, PivotTableFiledAreaEnum, PivotTableValuePositionEnum } from '../types/enum';
5
+ import { PivotFilterCategory, PivotLayoutTypeEnum, PivotTableFiledAreaEnum, PivotTableValuePositionEnum } from '../types/enum';
6
6
  import { PivotTableLabelField, PivotTableValueField } from './table-field';
7
7
  /**
8
8
  * @class PivotModel represents a config model for a pivot table.
@@ -111,9 +111,19 @@ export declare class PivotModel {
111
111
  * @param {readonly string[]} [items] - Cached members used to expand one item of a fully collapsed field.
112
112
  */
113
113
  setCollapse(fieldId: string, collapse: boolean | Record<string, boolean> | undefined, item?: string, items?: readonly string[]): void;
114
- setLabelFilterInfo(fieldId: string, filterInfo: IPivotTableFilterInfo): void;
114
+ setLabelFilterInfo(fieldId: string, filterInfo: IPivotTableFilterInfo | undefined, category?: PivotFilterCategory): void;
115
+ /** Applies a prepared field state without reinterpreting the mutation as a filtering intent. */
116
+ setFieldFilterState(fieldId: string, filterInfo: IPivotTableFilterInfo | undefined, conditionFilter?: PivotTableConditionFilter): void;
115
117
  setValueFilterInfo(fieldId: string, filterInfo: IPivotTableValueFilter | undefined, index?: number): void;
118
+ /** Restores a prepared rule without replacing other filter categories. */
119
+ setValueFilterState(fieldId: string, filterInfo: IPivotTableValueFilter | undefined, index?: number): void;
120
+ private _setValueFilterState;
116
121
  getValueFilterInfo(fieldId: string): IPivotTableValueFilter | undefined;
122
+ getConditionFilterInfo(fieldId: string): PivotTableConditionFilter | undefined;
123
+ clearFieldFilters(fieldId: string): void;
124
+ clearFilters(): void;
125
+ private _clearSourceFilters;
126
+ private _clearSourceFilterCategory;
117
127
  getValueFilterInfos(): IValueFilterInfoItem[];
118
128
  removeValueFilterInfo(fieldId: string): void;
119
129
  removeValueFilterInfoByValueFieldId(valueFieldId: string): void;
@@ -2,10 +2,10 @@ import type { DataField } from '../field/data-field';
2
2
  import type { FieldsCollection } from '../field/fields-collection';
3
3
  import type { PivotView } from '../layout/pivot-view';
4
4
  import type { PivotTableValuePositionEnum } from '../types/enum';
5
- import type { IPivotTableFilterInfo, IPivotTableQueryData, IPivotTableShowDataAsInfo, IPivotTableSortInfo, IPivotTableValueFilter } from '../types/interface';
5
+ import type { IPivotTableCustomFilter, IPivotTableFilterInfo, IPivotTableQueryData, IPivotTableShowDataAsInfo, IPivotTableSortInfo, IPivotTableValueFilter, PivotTableConditionFilter } from '../types/interface';
6
6
  import type { IPivotTableChangeSet, IPivotTableSnapshot } from '../types/json-types';
7
7
  import type { IPivotTableOptions } from '../types/layout-type';
8
- import { PivotCallbackEnum, PivotDataFieldDataTypeEnum, PivotLayoutTypeEnum, PivotSubtotalTypeEnum, PivotTableFiledAreaEnum } from '../types/enum';
8
+ import { PivotCallbackEnum, PivotDataFieldDataTypeEnum, PivotFilterCategory, PivotLayoutTypeEnum, PivotSubtotalTypeEnum, PivotTableFiledAreaEnum } from '../types/enum';
9
9
  import { PivotModel } from './model';
10
10
  import { PivotTableLabelField, PivotTableValueField } from './table-field';
11
11
  /**
@@ -179,7 +179,14 @@ export declare class PivotTable {
179
179
  * @param fieldId
180
180
  * @param filterInfo
181
181
  */
182
- setLabelFilterInfo(fieldId: string, filterInfo: IPivotTableFilterInfo): void;
182
+ setLabelFilterInfo(fieldId: string, filterInfo: IPivotTableFilterInfo | undefined, category?: PivotFilterCategory): void;
183
+ getConditionFilterInfo(fieldId: string): PivotTableConditionFilter | undefined;
184
+ /** Clears member, condition and value filters for this source field, including hidden copies. */
185
+ clearFieldFilters(fieldId: string): void;
186
+ /** Applies serialized filter state without executing report-level replacement policy again. */
187
+ setFieldFilterState(fieldId: string, filterInfo: IPivotTableFilterInfo | undefined, conditionFilter?: PivotTableConditionFilter): void;
188
+ /** Replaces only the date category, applying the report's member/value coexistence policy. */
189
+ setDateFilterInfo(fieldId: string, filterInfo: IPivotTableCustomFilter | undefined): boolean;
183
190
  /**
184
191
  * - Set the sort information of the dimension field. only the dimension field can set the sort information.
185
192
  * @param {string} fieldId - The id of the field.
@@ -271,6 +278,8 @@ export declare class PivotTable {
271
278
  * @param {IPivotTableValueFilter} filterInfo The value filter information.
272
279
  */
273
280
  setValueFilterInfo(fieldId: string, filterInfo: IPivotTableValueFilter | undefined, index?: number): void;
281
+ /** Restores a prepared rule without reapplying user-intent replacement policy. */
282
+ setValueFilterState(fieldId: string, filterInfo: IPivotTableValueFilter | undefined, index?: number): void;
274
283
  /**
275
284
  * Get the value filter information list of the pivot table.
276
285
  * @returns {IPivotTableValueFilter[]} The value filter information list.
@@ -1,5 +1,6 @@
1
- import type { IPivotTableFilterInfo, IPivotTableLabelFieldJSON, IPivotTableLabelFieldQueryData, IPivotTableShowDataAsInfo, IPivotTableSortInfo, IPivotTableValueFieldJSON, IPivotTableValueFieldQueryData } from '../types';
2
- import { PivotSubtotalTypeEnum } from '../types';
1
+ import type { IPivotTableFilterInfo, IPivotTableLabelFieldQueryData, IPivotTableShowDataAsInfo, IPivotTableSortInfo, IPivotTableValueFieldQueryData, PivotTableConditionFilter } from '../types/interface';
2
+ import type { IPivotTableLabelFieldJSON, IPivotTableValueFieldJSON } from '../types/json-types';
3
+ import { PivotSubtotalTypeEnum } from '../types/enum';
3
4
  /**
4
5
  * Represents a base class for the field in a pivot table.
5
6
  * @abstract
@@ -74,7 +75,8 @@ export declare class PivotTableValueField extends PivotTableFieldBase {
74
75
  */
75
76
  export declare class PivotTableLabelField extends PivotTableFieldBase {
76
77
  sortInfo: IPivotTableSortInfo | undefined;
77
- filterInfo: IPivotTableFilterInfo;
78
+ filterInfo?: IPivotTableFilterInfo;
79
+ conditionFilter?: PivotTableConditionFilter;
78
80
  constructor(dataFieldId: string, id: string, displayName: string | undefined, sourceName: string);
79
81
  /**
80
82
  * @method setSortInfo
@@ -90,16 +92,18 @@ export declare class PivotTableLabelField extends PivotTableFieldBase {
90
92
  getSortInfo(): IPivotTableSortInfo | undefined;
91
93
  /**
92
94
  * @method setFilterInfo
93
- * @description Set the filter information of the label field. Only one of the manual filter, custom filter or value filter can be effective.
94
- * @param {IPivotTableFilterInfo} filterInfo - The filter information of the label field. the manual filter, custom filter or value filter is opposite to each other.
95
+ * @description Replaces the stored filter state. Report-level setters coordinate filter categories.
96
+ * @param {IPivotTableFilterInfo | undefined} filterInfo - The filter information, or undefined to remove it.
95
97
  */
96
- setFilterInfo(filterInfo: IPivotTableFilterInfo): void;
98
+ setFilterInfo(filterInfo: IPivotTableFilterInfo | undefined): void;
97
99
  /**
98
100
  * @method getFilterInfo
99
101
  * @description Get the filter information of the label field.
100
- * @returns {IPivotTableFilterInfo} The filter information of the label field.
102
+ * @returns {IPivotTableFilterInfo | undefined} The filter information of the label field, if present.
101
103
  */
102
- getFilterInfo(): IPivotTableFilterInfo;
104
+ getFilterInfo(): IPivotTableFilterInfo | undefined;
105
+ getConditionFilterInfo(): PivotTableConditionFilter | undefined;
106
+ setConditionFilterInfo(condition: PivotTableConditionFilter | undefined): void;
103
107
  getQueryData(): IPivotTableLabelFieldQueryData;
104
108
  toJSON(): IPivotTableLabelFieldJSON;
105
109
  fromJSON(data: IPivotTableLabelFieldJSON): void;
@@ -1,5 +1,10 @@
1
1
  import type { RecordValue } from '@univerjs/core';
2
2
  import type { IDataFieldValue, IPivotTableFilterInfo, IPivotTableRecordFilter } from './types/interface';
3
+ import type { IPivotTableLabelFieldJSON, IPivotTableSnapshot } from './types/json-types';
4
+ import { PivotFilterCategory } from './types/enum';
5
+ export declare function getPivotFieldFilterCategories(field: IPivotTableLabelFieldJSON): Set<PivotFilterCategory>;
6
+ /** Counts categories by source identity, including hidden copies, without normalizing old snapshots. */
7
+ export declare function hasPivotMultipleFilters(snapshot: IPivotTableSnapshot): boolean;
3
8
  export declare function getPivotRecordMember(value: IDataFieldValue): RecordValue;
4
9
  export declare function isPivotRecordFilter(filterInfo: IPivotTableFilterInfo | undefined): filterInfo is IPivotTableRecordFilter;
5
10
  export declare function isPivotTableFilterRestrictive(filterInfo: IPivotTableFilterInfo): boolean;
@@ -1,6 +1,7 @@
1
1
  import type { FieldsCollection } from '../field/fields-collection';
2
- import type { IDimensionMapItem, IMeasuresMapItem, IPivotTableQueryData, ITupleItem } from '../types';
3
- import { PivotDataFieldDataTypeEnum } from '../types';
2
+ import type { IPivotTableQueryData } from '../types/interface';
3
+ import type { IDimensionMapItem, IMeasuresMapItem, ITupleItem } from '../types/summary-type';
4
+ import { PivotDataFieldDataTypeEnum } from '../types/enum';
4
5
  export declare class TupleGroup {
5
6
  /**
6
7
  * @property The tuples of the pivot table, it contains the path, indexes, and save the measure value of each tuple.
@@ -780,3 +780,9 @@ export declare enum PivotDateGroupFieldDateTypeEnum {
780
780
  */
781
781
  YearMonthDate = "year-month-date"
782
782
  }
783
+ /** Independent filter categories of one report source field. */
784
+ export declare enum PivotFilterCategory {
785
+ Member = "member",
786
+ Condition = "condition",
787
+ Value = "value"
788
+ }
@@ -154,6 +154,8 @@ export interface IPivotTableCustomFilter {
154
154
  type: PivotFilterTypeEnum.CustomFilter;
155
155
  operator: ST_PivotFilterOperatorEnum;
156
156
  expected: any;
157
+ /** Compare calendar days instead of exact serials for fixed date conditions. Defaults to false. */
158
+ useWholeDay?: boolean;
157
159
  }
158
160
  export interface IPivotTableValueFilter {
159
161
  type: PivotFilterTypeEnum.ValueFilter;
@@ -163,6 +165,10 @@ export interface IPivotTableValueFilter {
163
165
  /** Whether a count/percent rank filter keeps the bottom values instead of the top values. */
164
166
  isBottom?: boolean;
165
167
  }
168
+ export type PivotTableConditionFilter = IPivotTableCustomFilter | (IPivotTableRecordFilter & {
169
+ dateRange: NonNullable<IPivotTableRecordFilter['dateRange']>;
170
+ selection?: never;
171
+ });
166
172
  export interface IPivotTableRecordFilter {
167
173
  type: PivotFilterTypeEnum.RecordFilter;
168
174
  selection?: RecordSelection;
@@ -194,6 +200,7 @@ export interface IPivotTableLabelFieldQueryData {
194
200
  * Information about the filter applied to the label field.
195
201
  */
196
202
  filterInfo?: IPivotTableFilterInfo;
203
+ conditionFilter?: PivotTableConditionFilter;
197
204
  /**
198
205
  * Information about the sort applied to the label field.
199
206
  */
@@ -286,5 +293,7 @@ export interface IValueFilterInfoItem {
286
293
  export interface IPivotDateRange {
287
294
  startDate: number;
288
295
  endDate: number;
296
+ /** Expand fractional bounds to whole days while retaining an integer exclusive end. */
297
+ useWholeDay?: boolean;
289
298
  }
290
299
  export {};
@@ -1,5 +1,5 @@
1
1
  import type { PivotDataFieldDataTypeEnum, PivotDataFieldTypeEnum, PivotDateGroupFieldDateTypeEnum, PivotLayoutTypeEnum, PivotSubtotalTypeEnum, PivotTableFiledAreaEnum, PivotTableValuePositionEnum } from './enum';
2
- import type { IExcelDateGroupFieldSpec, IManualGrouping, INumberGrouping, IPivotTableFilterInfo, IPivotTableShowDataAsInfo, IPivotTableSortInfo, IPivotTableValueFilter, IValueFilterInfoItem } from './interface';
2
+ import type { IExcelDateGroupFieldSpec, IManualGrouping, INumberGrouping, IPivotTableFilterInfo, IPivotTableShowDataAsInfo, IPivotTableSortInfo, IPivotTableValueFilter, IValueFilterInfoItem, PivotTableConditionFilter } from './interface';
3
3
  import type { IPivotTableOptions } from './layout-type';
4
4
  export interface IPivotTableValueFieldJSON {
5
5
  dataFieldId: string;
@@ -18,6 +18,8 @@ export interface IPivotTableLabelFieldJSON {
18
18
  format: string | undefined;
19
19
  sortInfo?: IPivotTableSortInfo;
20
20
  filterInfo?: IPivotTableFilterInfo;
21
+ /** A label/date condition independent of member selection when multiple filters are enabled. */
22
+ conditionFilter?: PivotTableConditionFilter;
21
23
  }
22
24
  /**
23
25
  * Represents a snapshot of a pivot table.
@@ -426,11 +428,14 @@ export interface IPivotTableSetFilterInfoChange {
426
428
  /**
427
429
  * @property {IPivotTableFilterInfo} oldFilterInfo The old filter information.
428
430
  */
429
- oldFilterInfo: IPivotTableFilterInfo;
431
+ oldFilterInfo: IPivotTableFilterInfo | undefined;
430
432
  /**
431
433
  * @property {IPivotTableFilterInfo} newFilterInfo The new filter information.
432
434
  */
433
- newFilterInfo: IPivotTableFilterInfo;
435
+ newFilterInfo: IPivotTableFilterInfo | undefined;
436
+ /** Present only when the independent condition changes; null explicitly clears it on replay. */
437
+ oldConditionFilter?: PivotTableConditionFilter | null;
438
+ newConditionFilter?: PivotTableConditionFilter | null;
434
439
  }
435
440
  export interface IPivotTableSetValueFilterChange {
436
441
  /**
@@ -163,6 +163,8 @@ export declare enum PivotCellStyleTypeEnum {
163
163
  export interface IPivotTableOptions {
164
164
  /** Missing in older snapshots; readers treat it as Legacy without rewriting the snapshot. */
165
165
  dateGroupingMode?: PivotDateGroupingMode;
166
+ /** Allow different filter categories on one field. Omitted and false use replacement semantics. */
167
+ allowMultipleFilters?: boolean;
166
168
  /**
167
169
  * The page wrap, it is the wrap of page, the page will wrap to next row when the wrapCursor is equal to pageWrap
168
170
  */