@univerjs/sheets-table 1.0.0-rc.0 → 1.0.0

package/lib/types/commands/mutations/set-table-filter.mutation.d.ts

@@ -20,6 +20,9 @@ export interface ISetSheetTableParams {
     tableId: string;
     column: number;
     tableFilter: ITableFilterItem | undefined;
+    filterOutRows?: number[];
+    subUnitId?: string;
+    tableFilteredOutRows?: number[];
 }
 export declare const SetSheetTableFilterMutation: IMutation<ISetSheetTableParams & {
     tableId: string;

package/lib/types/commands/utils/calculated-column.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { IMutationInfo } from '@univerjs/core';
+import type { LexerTreeBuilder } from '@univerjs/engine-formula';
+import type { Table } from '../../models/table';
+import type { ITableCalculatedColumnConfig } from '../../types/type';
+export declare function getCalculatedColumnFillMutation(table: Table, unitId: string, subUnitId: string, startRow: number, endRow: number, getLexerTreeBuilder: () => LexerTreeBuilder, config?: ITableCalculatedColumnConfig): IMutationInfo | undefined;

package/lib/types/controllers/sheet-table-formula.controller.d.ts

@@ -14,11 +14,14 @@
  * limitations under the License.
  */
 import { Disposable, ICommandService } from '@univerjs/core';
+import { IActiveDirtyManagerService } from '@univerjs/engine-formula';
 import { TableManager } from '../models/table-manager';
 export declare class SheetTableFormulaController extends Disposable {
     private _tableManager;
     private readonly _commandService;
-    constructor(_tableManager: TableManager, _commandService: ICommandService);
+    private readonly _activeDirtyManagerService;
+    constructor(_tableManager: TableManager, _commandService: ICommandService, _activeDirtyManagerService: IActiveDirtyManagerService);
+    private _initFilterDirtyRange;
     private _initRangeListener;
     private _updateSuperTable;
 }

package/lib/types/controllers/table-filter.controller.d.ts

@@ -14,16 +14,19 @@
  * limitations under the License.
  */
 import { Disposable, IUniverInstanceService } from '@univerjs/core';
+import { ISheetRowFilteredService } from '@univerjs/engine-formula';
 import { SheetInterceptorService, ZebraCrossingCacheController } from '@univerjs/sheets';
 import { TableManager } from '../models/table-manager';
 export declare class TableFilterController extends Disposable {
     private _tableManager;
     private readonly _sheetInterceptorService;
     private readonly _univerInstanceService;
+    private readonly _sheetRowFilteredService;
     private readonly _zebraCrossingCacheController;
     private readonly _tableFilteredOutRows;
     private _subscription;
-    constructor(_tableManager: TableManager, _sheetInterceptorService: SheetInterceptorService, _univerInstanceService: IUniverInstanceService, _zebraCrossingCacheController: ZebraCrossingCacheController);
+    constructor(_tableManager: TableManager, _sheetInterceptorService: SheetInterceptorService, _univerInstanceService: IUniverInstanceService, _sheetRowFilteredService: ISheetRowFilteredService, _zebraCrossingCacheController: ZebraCrossingCacheController);
+    private _registerFormulaRowFiltered;
     initTableHiddenRowIntercept(): void;
     private _initFilteredOutRows;
     registerFilterChangeEvent(): void;

package/lib/types/facade/f-enum.d.ts

@@ -19,10 +19,15 @@ import { TableColumnFilterTypeEnum, TableConditionTypeEnum, TableDateCompareType
  * @ignore
  */
 export interface IFSheetsTableEnumMixin {
+    /** Filter kinds available for table columns. */
     TableColumnFilterTypeEnum: typeof TableColumnFilterTypeEnum;
+    /** Value types used by table condition filters. */
     TableConditionTypeEnum: typeof TableConditionTypeEnum;
+    /** Comparison operators for numeric table filters. */
     TableNumberCompareTypeEnum: typeof TableNumberCompareTypeEnum;
+    /** Comparison operators for text table filters. */
     TableStringCompareTypeEnum: typeof TableStringCompareTypeEnum;
+    /** Comparison operators for date table filters. */
     TableDateCompareTypeEnum: typeof TableDateCompareTypeEnum;
 }
 export declare class FSheetsTableEnumMixin extends FEnum implements IFSheetsTableEnumMixin {

package/lib/types/facade/f-workbook.d.ts

@@ -22,7 +22,7 @@ export interface IFWorkbookSheetsTableMixin {
     /**
      * Get table information
      * @param {string} tableId The table id
-     * @returns {ITableInfo} The table information
+     * @returns {ITableInfoWithUnitId | undefined} The table information, including workbook and worksheet IDs, or `undefined` if not found.
      * @example
      * ```typescript
      * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -50,7 +50,7 @@ export interface IFWorkbookSheetsTableMixin {
     /**
      * Get table information by name
      * @param {string} tableName The table name
-     * @returns {ITableInfo} The table information
+     * @returns {ITableInfoWithUnitId | undefined} The table information, including workbook and worksheet IDs, or `undefined` if not found.
      * @example
      * ```typescript
      * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -93,7 +93,7 @@ export interface IFWorkbookSheetsTableMixin {
      * @param {ITableRange} rangeInfo The table range information
      * @param {string} [tableId] The table id
      * @param {ITableOptions} [options] The table options
-     * @returns {string} The table id
+     * @returns {Promise<string | undefined>} A promise resolving to the table ID, or `undefined` if the name is invalid or creation fails.
      * @example
      * ```typescript
      * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -123,7 +123,7 @@ export interface IFWorkbookSheetsTableMixin {
      * set table filter
      * @param {string} tableId The table id
      * @param {number} column The column index, starting from 0.
-     * @param {ITableFilterItem} filter The filter item
+     * @param {ITableFilterItem | undefined} filter The filter to apply, or `undefined` to clear the column filter.
      * @returns {Promise<boolean>} The result of set table filter
      * @example
      * ```typescript
@@ -158,11 +158,11 @@ export interface IFWorkbookSheetsTableMixin {
      * }
      * ```
      */
-    setTableFilter(tableId: string, column: number, filter: ITableFilterItem | undefined): void;
+    setTableFilter(tableId: string, column: number, filter: ITableFilterItem | undefined): Promise<boolean>;
     /**
      * Remove table
      * @param {string} tableId The table id
-     * @returns {boolean} The result of remove table
+     * @returns {Promise<boolean>} A promise resolving to whether the table was removed; `false` if the table is not found.
      * @example
      * ```typescript
      * const fWorkbook = univerAPI.getActiveWorkbook();

package/lib/types/facade/f-worksheet.d.ts

@@ -14,19 +14,36 @@
  * limitations under the License.
  */
 import type { IRangeThemeStyleJSON } from '@univerjs/sheets';
-import type { ITableFilterItem, ITableInfoWithUnitId, ITableOptions, ITableRange } from '@univerjs/sheets-table';
+import type { ITableFilterButtonConfig, ITableFilterItem, ITableInfoWithUnitId, ITableOptions, ITableRange } from '@univerjs/sheets-table';
 import { FWorksheet } from '@univerjs/sheets/facade';
 /**
  * @ignore
  */
 export interface IFWorksheetTableMixin {
+    /**
+     * Apply a formula to every data row of a table column, excluding header and footer.
+     * References are relative to the first data row. Empty string stops future auto-fill and preserves cells.
+     * @param tableId Table ID in this worksheet.
+     * @param columnId Stable column ID from getSubTableInfos().
+     * @param formula Formula to apply, or an empty string to stop automatic filling.
+     * @returns Whether the undoable update succeeded synchronously.
+     */
+    setTableColumnFormula(tableId: string, columnId: string, formula: string): boolean;
+    /**
+     * Update table filter button visibility without clearing filter criteria.
+     * Column overrides use stable column IDs from getSubTableInfos().
+     * @param tableId Table ID in this worksheet.
+     * @param config Partial table and column button visibility settings.
+     * @returns Whether the update succeeded synchronously.
+     */
+    setTableFilterButtons(tableId: string, config: ITableFilterButtonConfig): boolean;
     /**
      * Add a table to the worksheet
      * @param {string} tableName The table name
      * @param {ITableRange} rangeInfo The table range information
      * @param {string} [tableId] The table id
      * @param {ITableOptions} [options] The table options
-     * @returns {Promise<boolean>} Whether the table was added successfully
+     * @returns {Promise<boolean> | boolean} `false` for an invalid table name; otherwise, a promise resolving to whether the command succeeded.
      * @example
      * ```typescript
      * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -162,7 +179,7 @@ export interface IFWorksheetTableMixin {
      * Set the name of a table
      * @param {string} tableId The table id
      * @param {string} tableName The new table name
-     * @returns {Promise<boolean>} Whether the table name was set successfully
+     * @returns {Promise<boolean> | boolean} `false` for an invalid table name; otherwise, a promise resolving to whether the command succeeded.
      * @example
      * ```typescript
      * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -324,6 +341,8 @@ export interface IFWorksheetTableMixin {
     addTableTheme(tableId: string, themeStyleJSON: IRangeThemeStyleJSON): Promise<boolean>;
 }
 export declare class FWorksheetTableMixin extends FWorksheet implements IFWorksheetTableMixin {
+    setTableColumnFormula(tableId: string, columnId: string, formula: string): boolean;
+    setTableFilterButtons(tableId: string, config: ITableFilterButtonConfig): boolean;
     addTable(tableName: string, rangeInfo: ITableRange, tableId?: string, options?: ITableOptions): Promise<boolean> | boolean;
     setTableFilter(tableId: string, column: number, filter: ITableFilterItem): Promise<boolean>;
     removeTable(tableId: string): Promise<boolean>;

package/lib/types/index.d.ts

@@ -37,12 +37,13 @@ export { SHEET_TABLE_CUSTOM_THEME_PREFIX, TABLE_FILTER_EMPTY_VALUE } from './con
 export { SheetsTableThemeController } from './controllers/sheet-table-theme.controller';
 export { SheetsTableController } from './controllers/sheets-table.controller';
 export { customEmptyThemeWithBorderStyle, processStyleWithBorderStyle } from './controllers/table-theme.factory';
+export { compileTableRecordFilter, getTableRecordValue, getTableRecordValueKey } from './models/filter-util/record-filter';
 export { TableManager } from './models/table-manager';
 export { UniverSheetsTablePlugin } from './plugin';
 export { SheetTableService } from './services/table.service';
 export { SheetsTableButtonStateEnum, SheetsTableSortStateEnum, TableColumnDataTypeEnum, TableColumnFilterTypeEnum, TableConditionTypeEnum, TableDateCompareTypeEnum, TableNumberCompareTypeEnum, TableStringCompareTypeEnum, } from './types/enum';
-export type { ITableColorFilterItem, ITableColumnJson, ITableConditionFilterItem, ITableData, ITableFilterItem, ITableInfo, ITableInfoWithUnitId, ITableManualFilterItem, ITableOptions, ITableRange, ITableRangeWithState, TableMetaType, TableRelationTupleType, } from './types/type';
+export type { ITableCalculatedColumnConfig, ITableColorFilterItem, ITableColumnJson, ITableConditionFilterItem, ITableData, ITableFilterButtonConfig, ITableFilterItem, ITableInfo, ITableInfoWithUnitId, ITableManualFilterItem, ITableOptions, ITableRange, ITableRangeWithState, ITableRecordFilterItem, TableMetaType, TableRecordValue, TableRelationTupleType, } from './types/type';
 export type { ITableJson, ITableSetConfig } from './types/type';
-export { getExistingNamesSet, isColorTableFilter, isConditionFilter, isManualTableFilter } from './util';
+export { getExistingNamesSet, isColorTableFilter, isConditionFilter, isManualTableFilter, isRecordTableFilter } from './util';
 export { validateSheetTableName } from './util/table-name';
 export type { ISheetTableNameValidationResult, SheetTableNameValidationReason } from './util/table-name';

package/lib/types/model/filter-util/condition.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { IDocumentData, Worksheet } from '@univerjs/core';
+import type { TableStringCompareTypeEnum } from '../../types/enum';
+import type { ICalculatedOptions, ITableConditionFilterItem } from '../../types/type';
+import { TableConditionTypeEnum, TableDateCompareTypeEnum, TableNumberCompareTypeEnum } from '../../types/enum';
+type TableConditionCompareType = TableNumberCompareTypeEnum | TableDateCompareTypeEnum | TableStringCompareTypeEnum;
+export declare function isNumberDynamicFilter(compareType: TableConditionCompareType): compareType is TableNumberCompareTypeEnum;
+export declare function isDateDynamicFilter(compareType: TableConditionCompareType): compareType is TableDateCompareTypeEnum;
+export declare function getConditionExecuteFunc(filter: ITableConditionFilterItem, calculatedOptions: ICalculatedOptions | undefined): ((date: Date) => boolean) | ((value: number) => boolean) | ((value: string) => boolean);
+export declare function getCellValueWithConditionType(sheet: Worksheet, row: number, col: number, conditionType: TableConditionTypeEnum): string | number | Date | null | undefined;
+export declare const getStringFromDataStream: (data: IDocumentData) => string;
+export declare function excelSerialToDateTime(serial: number): Date;
+export {};

package/lib/types/model/filter-util/date-filter-util.d.ts

@@ -0,0 +1,225 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { ITableDateFilterInfo } from '../../types/type';
+/**
+ * The provided date is a date in Q1 of the year.
+ * @param {Date} date - The date to compare.
+ * @returns {boolean} return the date is match
+ */
+export declare const dateQ1: (date: Date) => boolean;
+/**
+ * The provided date is a date in Q2 of the year.
+ * @param {Date} date - The date to compare.
+ * @returns {boolean} return the date is match
+ */
+export declare const dateQ2: (date: Date) => boolean;
+/**
+ * The provided date is a date in Q3 of the year.
+ * @param {Date} date - The date to compare.
+ * @returns {boolean} return the date is match
+ */
+export declare const dateQ3: (date: Date) => boolean;
+/**
+ * The provided date is a date in Q4 of the year.
+ * @param {Date} date - The date to compare.
+ * @returns {boolean} return the date is match
+ */
+export declare const dateQ4: (date: Date) => boolean;
+/**
+ * The provided date is a date in January.
+ * @param {Date} date - The date to compare.
+ * @returns {boolean} return the date is match
+ */
+export declare const dateM1: (date: Date) => boolean;
+/**
+ * The provided date is a date in February.
+ * @param {Date} date - The date to compare.
+ * @returns {boolean} return the date is match
+ */
+export declare const dateM2: (date: Date) => boolean;
+/**
+ * The provided date is a date in March.
+ * @param {Date} date - The date to compare.
+ * @returns {boolean} return the date is match
+ */
+export declare const dateM3: (date: Date) => boolean;
+/**
+ * The provided date is a date in April.
+ * @param {Date} date - The date to compare.
+ * @returns {boolean} return the date is match
+ */
+export declare const dateM4: (date: Date) => boolean;
+/**
+ * The provided date is a date in May.
+ * @param {Date} date - The date to compare.
+ * @returns {boolean} return the date is match
+ */
+export declare const dateM5: (date: Date) => boolean;
+/**
+ * The provided date is a date in June.
+ * @param {Date} date - The date to compare.
+ * @returns {boolean} return the date is match
+ */
+export declare const dateM6: (date: Date) => boolean;
+/**
+ * The provided date is a date in July.
+ * @param {Date} date - The date to compare.
+ * @returns {boolean} return the date is match
+ */
+export declare const dateM7: (date: Date) => boolean;
+/**
+ * The provided date is a date in August.
+ * @param {Date} date - The date to compare.
+ * @returns {boolean} return the date is match
+ */
+export declare const dateM8: (date: Date) => boolean;
+/**
+ * The provided date is a date in September.
+ * @param {Date} date - The date to compare.
+ * @returns {boolean} return the date is match
+ */
+export declare const dateM9: (date: Date) => boolean;
+/**
+ * The provided date is a date in October.
+ * @param {Date} date - The date to compare.
+ * @returns {boolean} return the date is match
+ */
+export declare const dateM10: (date: Date) => boolean;
+/**
+ * The provided date is a date in November.
+ * @param {Date} date - The date to compare.
+ * @returns {boolean} return the date is match
+ */
+export declare const dateM11: (date: Date) => boolean;
+/**
+ * The provided date is a date in December.
+ * @param {Date} date - The date to compare.
+ * @returns {boolean} return the date is match
+ */
+export declare const dateM12: (date: Date) => boolean;
+/**
+ * The provided date is today.
+ * @param {Date} expectedDate - The date to compare.
+ * @param {Date} [anchorTime] - The reference date.
+ * @returns {boolean} return the date is match
+ */
+export declare const today: (expectedDate: Date, anchorTime?: Date) => boolean;
+/**
+ * The provided date is tomorrow.
+ * @param {Date} date - The date to compare.
+ * @param {Date} [anchorTime] - The reference date.
+ * @returns {boolean} return the date is match
+ */
+export declare const tomorrow: (date: Date, anchorTime?: Date) => boolean;
+/**
+ * The provided date is yesterday.
+ * @param {Date} date - The date to compare.
+ * @param {Date} [anchorTime] - The reference date.
+ * @returns {boolean} return the date is match
+ */
+export declare const yesterday: (date: Date, anchorTime?: Date) => boolean;
+/**
+ * The provided date is in the current week.
+ * @param {Date} date - The date to compare.
+ * @param {Date} [anchorTime] - The reference date.
+ * @returns {boolean} return the date is match
+ */
+export declare const thisWeek: (date: Date, anchorTime?: Date) => boolean;
+/**
+ * The provided date is in the next week.
+ * @param {Date} date - The date to compare.
+ * @param {Date} [anchorTime] - The reference date.
+ * @returns {boolean} return the date is match
+ */
+export declare const nextWeek: (date: Date, anchorTime?: Date) => boolean;
+/**
+ * The provided date is in the last week.
+ * @param {Date} date - The date to compare.
+ * @param {Date} [anchorTime] - The reference date.
+ * @returns {boolean} return the date is match
+ */
+export declare const lastWeek: (date: Date, anchorTime?: Date) => boolean;
+/**
+ * The provided date is in the current month.
+ * @param {Date} date - The date to compare.
+ * @param {Date} [anchorTime] - The reference date.
+ * @returns {boolean} return the date is match
+ */
+export declare const thisMonth: (date: Date, anchorTime?: Date) => boolean;
+/**
+ * The provided date is in the next month.
+ * @param {Date} date - The date to compare.
+ * @param {Date} [anchorTime] - The reference date.
+ * @returns {boolean} return the date is match
+ */
+export declare const nextMonth: (date: Date, anchorTime?: Date) => boolean;
+/**
+ * The provided date is in the last month.
+ * @param {Date} date - The date to compare.
+ * @param {Date} [anchorTime] - The reference date.
+ * @returns {boolean} return the date is match
+ */
+export declare const lastMonth: (date: Date, anchorTime?: Date) => boolean;
+/**
+ * The provided date is in the current quarter.
+ * @param {Date} date - The date to compare.
+ * @param {Date} [anchorTime] - The reference date.
+ * @returns {boolean} return the date is match
+ */
+export declare const thisQuarter: (date: Date, anchorTime?: Date) => boolean;
+/**
+ * The provided date is in the next quarter.
+ * @param {Date} date - The date to compare.
+ * @param {Date} [anchorTime] - The reference date.
+ * @returns {boolean} return the date is match
+ */
+export declare const nextQuarter: (date: Date, anchorTime?: Date) => boolean;
+/**
+ * The provided date is in the last quarter.
+ * @param {Date} date - The date to compare.
+ * @param {Date} [anchorTime] - The reference date.
+ * @returns {boolean} return the date is match
+ */
+export declare const lastQuarter: (date: Date, anchorTime?: Date) => boolean;
+/**
+ * The provided date is in the current year.
+ * @param {Date} date - The date to compare.
+ * @param {Date} [anchorTime] - The reference date.
+ * @returns {boolean} return the date is match
+ */
+export declare const thisYear: (date: Date, anchorTime?: Date) => boolean;
+/**
+ * The provided date is in the next year.
+ * @param {Date} date - The date to compare.
+ * @param {Date} [anchorTime] - The reference date.
+ * @returns {boolean} return the date is match
+ */
+export declare const nextYear: (date: Date, anchorTime?: Date) => boolean;
+/**
+ * The provided date is in the last year.
+ * @param {Date} date - The date to compare.
+ * @param {Date} [anchorTime] - The reference date.
+ * @returns {boolean} return the date is match
+ */
+export declare const lastYear: (date: Date, anchorTime?: Date) => boolean;
+/**
+ * The provided date is in the year to date.
+ * @param {Date} date - The date to compare.
+ * @param {Date} [anchorTime] - The reference date.
+ * @returns {boolean} return the date is match
+ */
+export declare const yearToDate: (date: Date, anchorTime?: Date) => boolean;
+export declare function getDateFilterExecuteFunc(filterInfo: ITableDateFilterInfo): (date: Date) => boolean;

package/lib/types/model/filter-util/number-filter-util.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { ICalculatedOptions, ITableNumberFilterInfo } from '../../types/type';
+/**
+ * @description Checks if a value is above the average.
+ * @param {number} value - The value to check.
+ * @param {number} average - The average value.
+ * @returns {boolean} A boolean value indicating whether the value is above the average.
+ */
+export declare const above: (value: number, average: number) => boolean;
+/**
+ * @description Checks if a value is below the average.
+ * @param {number} value - The value to check.
+ * @param {number} average - The average value.
+ * @returns {boolean} A boolean value indicating whether the value is below the average.
+ */
+export declare const below: (value: number, average: number) => boolean;
+/**
+ * @description Gets the largest N values from a list and checks if the expected value is included.
+ * @param {number[]} list - The list of numbers.
+ * @param {number} top - The number of top values to retrieve.
+ * @param {number} expectedValue - The expected value to check for inclusion.
+ * @returns {boolean} A boolean value indicating whether the expected value is included in the top N values.
+ */
+export declare const getTopN: (list: number[], top: number, expectedValue: number) => boolean;
+/**
+ * @description Gets the smallest N values from a list and checks if the expected value is included.
+ * @param {number[]} list - The list of numbers.
+ * @param {number} bottom - The number of bottom values to retrieve.
+ * @param {number} expectedValue - The expected value to check for inclusion.
+ * @returns {boolean} A boolean value indicating whether the expected value is included in the bottom N values.
+ */
+export declare const getBottomN: (list: number[], bottom: number, expectedValue: number) => boolean;
+export declare function getNumberFilterExecuteFunc(filter: ITableNumberFilterInfo, calculatedOptions: ICalculatedOptions | undefined): (value: number) => boolean;

package/lib/types/model/filter-util/text-filter-util.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { ITableStringFilterInfo } from '../../types/type';
+export declare const textEqual: (compareValue: string, expectedValue: string) => boolean;
+export declare const textNotEqual: (compareValue: string, expectedValue: string) => boolean;
+export declare const textContain: (compareValue: string, expectedValue: string) => boolean;
+export declare const textNotContain: (compareValue: string, expectedValue: string) => boolean;
+export declare const textStartWith: (compareValue: string, expectedValue: string) => boolean;
+export declare const textEndWith: (compareValue: string, expectedValue: string) => boolean;
+export declare function getTextFilterExecuteFunc(filter: ITableStringFilterInfo): (value: string) => boolean;

package/lib/types/model/filter-util/top-n.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Returns the kth largest element from the given list using a min heap.
+ * @param {number[]} list The list of numbers.
+ * @param {number} k The value of k.
+ * @returns The kth largest element.
+ */
+export declare const getLargestK: (list: number[], k: number) => number[];
+/**
+ * Returns the kth smallest element from the given list using a max heap.
+ * @param {number[]} list The list of numbers.
+ * @param {number} k The value of k.
+ * @returns The kth smallest element.
+ */
+export declare const getSmallestK: (list: number[], k: number) => number[];

package/lib/types/model/table-column.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { IStyleData } from '@univerjs/core';
+import type { TableMetaType } from '../types/type';
+import { TableColumnDataTypeEnum } from '../types/enum';
+export declare class TableColumn {
+    dataType: TableColumnDataTypeEnum;
+    id: string;
+    displayName: string;
+    formula: string;
+    meta: TableMetaType;
+    style: IStyleData;
+    constructor(id: string, name: string);
+    getMeta(): TableMetaType;
+    setMeta(meta: TableMetaType): void;
+    getDisplayName(): string;
+    toJSON(): {
+        id: string;
+        displayName: string;
+        dataType: TableColumnDataTypeEnum;
+        formula: string;
+        meta: TableMetaType;
+        style: IStyleData;
+    };
+    fromJSON(json: any): void;
+}

package/lib/types/model/table-filter.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { Worksheet } from '@univerjs/core';
+import type { SheetsTableButtonStateEnum } from '../types/enum';
+import type { ITableFilterItem, ITableFilterJSON, ITableRange } from '../types/type';
+import { SheetsTableSortStateEnum } from '../types/enum';
+export declare class TableFilters {
+    private _tableColumnFilterList;
+    private _tableSortInfo;
+    private _filterOutRows;
+    constructor();
+    setColumnFilter(columnIndex: number, filter: ITableFilterItem | undefined): void;
+    setSortState(columnIndex: number, sortState: SheetsTableSortStateEnum): void;
+    getColumnFilter(columnIndex: number): ITableFilterItem | undefined;
+    getFilterState(columnIndex: number): SheetsTableButtonStateEnum;
+    getSortState(): {
+        columnIndex: number;
+        sortState: SheetsTableSortStateEnum;
+    };
+    getFilterStates(range: ITableRange): SheetsTableButtonStateEnum[];
+    getFilterOutRows(): Set<number>;
+    doFilter(sheet: Worksheet, range: ITableRange): Set<number>;
+    doColumnFilter(sheet: Worksheet, range: ITableRange, columnIndex: number, filterOutRows: Set<number>): void;
+    private _getNumberCalculatedOptions;
+    getExecuteFunc(sheet: Worksheet, range: ITableRange, columnIndex: number, filter: ITableFilterItem): (value: any) => boolean;
+    toJSON(): ITableFilterJSON;
+    fromJSON(json: ITableFilterJSON): void;
+    dispose(): void;
+}