@univerjs/sheets-table 0.7.0 → 0.8.0-beta.0

package/lib/cjs/facade.js

@@ -1 +1 @@
-"use strict";const s=require("@univerjs/sheets-table"),c=require("@univerjs/sheets/facade"),T=require("@univerjs/core");class m extends c.FWorkbook{getTableInfo(e){const t=this.getId();return this._injector.get(s.SheetTableService).getTableInfo(t,e)}getTableList(){const e=this.getId();return this._injector.get(s.SheetTableService).getTableList(e)}async addTable(e,t,i,a,d){var o;const n=this._injector.get(s.SheetTableService),r={unitId:this.getId(),name:t,subUnitId:e,range:i,options:d,tableId:a};if(await this._commandService.executeCommand(s.AddSheetTableCommand.id,r))return(o=n.getTableList(this.getId()).find(l=>l.name===t))==null?void 0:o.id}async removeTable(e){var a;const t=(a=this.getTableInfo(e))==null?void 0:a.subUnitId;if(!t)return!1;const i={unitId:this.getId(),subUnitId:t,tableId:e};return this._commandService.executeCommand(s.DeleteSheetTableCommand.id,i)}getTableInfoByName(e){return this.getTableList().find(i=>i.name===e)}setTableFilter(e,t,i){const a={unitId:this.getId(),tableId:e,column:t,tableFilter:i};return this._commandService.executeCommand(s.SetSheetTableFilterCommand.id,a)}}c.FWorkbook.extend(m);class u extends c.FWorksheet{addTable(e,t,i,a){const d=this._injector.get(s.SheetTableService),n=this.getSheetId(),r=this.getWorkbook().getUnitId(),b=this._injector.get(s.TableManager),o=this._injector.get(T.LocaleService),l=b.getColumnHeader(r,n,t,o.t("sheets-table.columnPrefix"));return d.addTable(r,n,e,t,l,i,a)}addTableFilter(e,t,i){const a={unitId:this.getWorkbook().getUnitId(),tableId:e,column:t,tableFilter:i};return this._commandService.executeCommand(s.SetSheetTableFilterCommand.id,a)}}c.FWorksheet.extend(u);
+"use strict";const a=require("@univerjs/sheets-table"),d=require("@univerjs/sheets/facade"),c=require("@univerjs/core"),h=require("@univerjs/sheets"),T=require("@univerjs/core/facade");class g extends d.FWorkbook{getTableInfo(e){const t=this.getId();return this._injector.get(a.SheetTableService).getTableInfo(t,e)}getTableList(){const e=this.getId();return this._injector.get(a.SheetTableService).getTableList(e)}async addTable(e,t,n,i,o){var b;const s=this._injector.get(a.SheetTableService),r={unitId:this.getId(),name:t,subUnitId:e,range:n,options:o,id:i};if(await this._commandService.executeCommand(a.AddSheetTableCommand.id,r))return(b=s.getTableList(this.getId()).find(u=>u.name===t))==null?void 0:b.id}async removeTable(e){var i;const t=(i=this.getTableInfo(e))==null?void 0:i.subUnitId;if(!t)return!1;const n={unitId:this.getId(),subUnitId:t,tableId:e};return this._commandService.executeCommand(a.DeleteSheetTableCommand.id,n)}getTableInfoByName(e){return this.getTableList().find(n=>n.name===e)}setTableFilter(e,t,n){const i={unitId:this.getId(),tableId:e,column:t,tableFilter:n};return this._commandService.executeCommand(a.SetSheetTableFilterCommand.id,i)}}d.FWorkbook.extend(g);class S extends d.FWorksheet{addTable(e,t,n,i){const o=this.getSheetId(),r={unitId:this.getWorkbook().getUnitId(),subUnitId:o,name:e,range:t,id:n,options:i};return this._commandService.executeCommand(a.AddSheetTableCommand.id,r)}setTableFilter(e,t,n){const i={unitId:this.getWorkbook().getUnitId(),tableId:e,column:t,tableFilter:n};return this._commandService.executeCommand(a.SetSheetTableFilterCommand.id,i)}removeTable(e){const t={unitId:this._fWorkbook.getId(),subUnitId:this.getSheetId(),tableId:e};return this._commandService.executeCommand(a.DeleteSheetTableCommand.id,t)}setTableRange(e,t){const n={unitId:this.getWorkbook().getUnitId(),tableId:e,updateRange:{newRange:t}};return this._commandService.executeCommand(a.SetSheetTableCommand.id,n)}setTableName(e,t){const n={unitId:this.getWorkbook().getUnitId(),tableId:e,name:t};return this._commandService.executeCommand(a.SetSheetTableCommand.id,n)}getSubTableInfos(){const e=this._fWorkbook.getId();return this._injector.get(a.SheetTableService).getTableList(e).filter(n=>n.subUnitId===this.getSheetId())}resetFilter(e,t){const n={unitId:this._fWorkbook.getId(),tableId:e,column:t,tableFilter:void 0};return this._commandService.executeCommand(a.SetSheetTableFilterCommand.id,n)}getTableByCell(e,t){const n=this._fWorkbook.getId(),o=this._injector.get(a.SheetTableService).getTableList(n).filter(r=>r.subUnitId===this.getSheetId()),s=c.cellToRange(e,t);return o.find(r=>{const m=r.range;return c.Rectangle.intersects(m,s)})}addTableTheme(e,t){const n=new h.RangeThemeStyle("table-style");return n.fromJson(t),this._commandService.executeCommand(a.AddTableThemeCommand.id,{unitId:this._fWorkbook.getId(),tableId:e,themeStyle:n})}}d.FWorksheet.extend(S);class I extends T.FEnum{get TableColumnFilterTypeEnum(){return a.TableColumnFilterTypeEnum}get TableConditionTypeEnum(){return a.TableConditionTypeEnum}get TableNumberCompareTypeEnum(){return a.TableNumberCompareTypeEnum}get TableStringCompareTypeEnum(){return a.TableStringCompareTypeEnum}get TableDateCompareTypeEnum(){return a.TableDateCompareTypeEnum}}T.FEnum.extend(I);

package/lib/es/facade.js

@@ -1,7 +1,9 @@
-import { SheetTableService as o, AddSheetTableCommand as g, DeleteSheetTableCommand as u, SetSheetTableFilterCommand as b, TableManager as I } from "@univerjs/sheets-table";
-import { FWorkbook as m, FWorksheet as h } from "@univerjs/sheets/facade";
-import { LocaleService as S } from "@univerjs/core";
-class v extends m {
+import { SheetTableService as o, AddSheetTableCommand as u, DeleteSheetTableCommand as T, SetSheetTableFilterCommand as d, SetSheetTableCommand as c, AddTableThemeCommand as C, TableColumnFilterTypeEnum as f, TableConditionTypeEnum as v, TableNumberCompareTypeEnum as k, TableStringCompareTypeEnum as p, TableDateCompareTypeEnum as _ } from "@univerjs/sheets-table";
+import { FWorkbook as h, FWorksheet as g } from "@univerjs/sheets/facade";
+import { cellToRange as x, Rectangle as y } from "@univerjs/core";
+import { RangeThemeStyle as F } from "@univerjs/sheets";
+import { FEnum as I } from "@univerjs/core/facade";
+class W extends h {
   getTableInfo(e) {
     const t = this.getId();
     return this._injector.get(o).getTableInfo(t, e);
@@ -10,58 +12,137 @@ class v extends m {
     const e = this.getId();
     return this._injector.get(o).getTableList(e);
   }
-  async addTable(e, t, i, a, d) {
-    var r;
-    const n = this._injector.get(o), s = {
+  async addTable(e, t, n, i, r) {
+    var b;
+    const s = this._injector.get(o), a = {
       unitId: this.getId(),
       name: t,
       subUnitId: e,
-      range: i,
-      options: d,
-      tableId: a
+      range: n,
+      options: r,
+      id: i
     };
-    if (await this._commandService.executeCommand(g.id, s))
-      return (r = n.getTableList(this.getId()).find((c) => c.name === t)) == null ? void 0 : r.id;
+    if (await this._commandService.executeCommand(u.id, a))
+      return (b = s.getTableList(this.getId()).find((S) => S.name === t)) == null ? void 0 : b.id;
   }
   async removeTable(e) {
-    var a;
-    const t = (a = this.getTableInfo(e)) == null ? void 0 : a.subUnitId;
+    var i;
+    const t = (i = this.getTableInfo(e)) == null ? void 0 : i.subUnitId;
     if (!t)
       return !1;
-    const i = {
+    const n = {
       unitId: this.getId(),
       subUnitId: t,
       tableId: e
     };
-    return this._commandService.executeCommand(u.id, i);
+    return this._commandService.executeCommand(T.id, n);
   }
   getTableInfoByName(e) {
-    return this.getTableList().find((i) => i.name === e);
+    return this.getTableList().find((n) => n.name === e);
   }
-  setTableFilter(e, t, i) {
-    const a = {
+  setTableFilter(e, t, n) {
+    const i = {
       unitId: this.getId(),
       tableId: e,
       column: t,
-      tableFilter: i
+      tableFilter: n
     };
-    return this._commandService.executeCommand(b.id, a);
+    return this._commandService.executeCommand(d.id, i);
   }
 }
-m.extend(v);
-class f extends h {
-  addTable(e, t, i, a) {
-    const d = this._injector.get(o), n = this.getSheetId(), s = this.getWorkbook().getUnitId(), l = this._injector.get(I), r = this._injector.get(S), c = l.getColumnHeader(s, n, t, r.t("sheets-table.columnPrefix"));
-    return d.addTable(s, n, e, t, c, i, a);
-  }
-  addTableFilter(e, t, i) {
-    const a = {
+h.extend(W);
+class E extends g {
+  addTable(e, t, n, i) {
+    const r = this.getSheetId(), a = {
+      unitId: this.getWorkbook().getUnitId(),
+      subUnitId: r,
+      name: e,
+      range: t,
+      id: n,
+      options: i
+    };
+    return this._commandService.executeCommand(u.id, a);
+  }
+  setTableFilter(e, t, n) {
+    const i = {
       unitId: this.getWorkbook().getUnitId(),
       tableId: e,
       column: t,
-      tableFilter: i
+      tableFilter: n
+    };
+    return this._commandService.executeCommand(d.id, i);
+  }
+  removeTable(e) {
+    const t = {
+      unitId: this._fWorkbook.getId(),
+      subUnitId: this.getSheetId(),
+      tableId: e
+    };
+    return this._commandService.executeCommand(T.id, t);
+  }
+  setTableRange(e, t) {
+    const n = {
+      unitId: this.getWorkbook().getUnitId(),
+      tableId: e,
+      updateRange: {
+        newRange: t
+      }
     };
-    return this._commandService.executeCommand(b.id, a);
+    return this._commandService.executeCommand(c.id, n);
+  }
+  setTableName(e, t) {
+    const n = {
+      unitId: this.getWorkbook().getUnitId(),
+      tableId: e,
+      name: t
+    };
+    return this._commandService.executeCommand(c.id, n);
+  }
+  getSubTableInfos() {
+    const e = this._fWorkbook.getId();
+    return this._injector.get(o).getTableList(e).filter((n) => n.subUnitId === this.getSheetId());
+  }
+  resetFilter(e, t) {
+    const n = {
+      unitId: this._fWorkbook.getId(),
+      tableId: e,
+      column: t,
+      tableFilter: void 0
+    };
+    return this._commandService.executeCommand(d.id, n);
+  }
+  getTableByCell(e, t) {
+    const n = this._fWorkbook.getId(), r = this._injector.get(o).getTableList(n).filter((a) => a.subUnitId === this.getSheetId()), s = x(e, t);
+    return r.find((a) => {
+      const l = a.range;
+      return y.intersects(l, s);
+    });
+  }
+  addTableTheme(e, t) {
+    const n = new F("table-style");
+    return n.fromJson(t), this._commandService.executeCommand(C.id, {
+      unitId: this._fWorkbook.getId(),
+      tableId: e,
+      themeStyle: n
+    });
+  }
+}
+g.extend(E);
+class U extends I {
+  get TableColumnFilterTypeEnum() {
+    return f;
+  }
+  get TableConditionTypeEnum() {
+    return v;
+  }
+  get TableNumberCompareTypeEnum() {
+    return k;
+  }
+  get TableStringCompareTypeEnum() {
+    return p;
+  }
+  get TableDateCompareTypeEnum() {
+    return _;
   }
 }
-h.extend(f);
+I.extend(U);

package/lib/facade.js

@@ -1,7 +1,9 @@
-import { SheetTableService as o, AddSheetTableCommand as g, DeleteSheetTableCommand as u, SetSheetTableFilterCommand as b, TableManager as I } from "@univerjs/sheets-table";
-import { FWorkbook as m, FWorksheet as h } from "@univerjs/sheets/facade";
-import { LocaleService as S } from "@univerjs/core";
-class v extends m {
+import { SheetTableService as o, AddSheetTableCommand as u, DeleteSheetTableCommand as T, SetSheetTableFilterCommand as d, SetSheetTableCommand as c, AddTableThemeCommand as C, TableColumnFilterTypeEnum as f, TableConditionTypeEnum as v, TableNumberCompareTypeEnum as k, TableStringCompareTypeEnum as p, TableDateCompareTypeEnum as _ } from "@univerjs/sheets-table";
+import { FWorkbook as h, FWorksheet as g } from "@univerjs/sheets/facade";
+import { cellToRange as x, Rectangle as y } from "@univerjs/core";
+import { RangeThemeStyle as F } from "@univerjs/sheets";
+import { FEnum as I } from "@univerjs/core/facade";
+class W extends h {
   getTableInfo(e) {
     const t = this.getId();
     return this._injector.get(o).getTableInfo(t, e);
@@ -10,58 +12,137 @@ class v extends m {
     const e = this.getId();
     return this._injector.get(o).getTableList(e);
   }
-  async addTable(e, t, i, a, d) {
-    var r;
-    const n = this._injector.get(o), s = {
+  async addTable(e, t, n, i, r) {
+    var b;
+    const s = this._injector.get(o), a = {
       unitId: this.getId(),
       name: t,
       subUnitId: e,
-      range: i,
-      options: d,
-      tableId: a
+      range: n,
+      options: r,
+      id: i
     };
-    if (await this._commandService.executeCommand(g.id, s))
-      return (r = n.getTableList(this.getId()).find((c) => c.name === t)) == null ? void 0 : r.id;
+    if (await this._commandService.executeCommand(u.id, a))
+      return (b = s.getTableList(this.getId()).find((S) => S.name === t)) == null ? void 0 : b.id;
   }
   async removeTable(e) {
-    var a;
-    const t = (a = this.getTableInfo(e)) == null ? void 0 : a.subUnitId;
+    var i;
+    const t = (i = this.getTableInfo(e)) == null ? void 0 : i.subUnitId;
     if (!t)
       return !1;
-    const i = {
+    const n = {
       unitId: this.getId(),
       subUnitId: t,
       tableId: e
     };
-    return this._commandService.executeCommand(u.id, i);
+    return this._commandService.executeCommand(T.id, n);
   }
   getTableInfoByName(e) {
-    return this.getTableList().find((i) => i.name === e);
+    return this.getTableList().find((n) => n.name === e);
   }
-  setTableFilter(e, t, i) {
-    const a = {
+  setTableFilter(e, t, n) {
+    const i = {
       unitId: this.getId(),
       tableId: e,
       column: t,
-      tableFilter: i
+      tableFilter: n
     };
-    return this._commandService.executeCommand(b.id, a);
+    return this._commandService.executeCommand(d.id, i);
   }
 }
-m.extend(v);
-class f extends h {
-  addTable(e, t, i, a) {
-    const d = this._injector.get(o), n = this.getSheetId(), s = this.getWorkbook().getUnitId(), l = this._injector.get(I), r = this._injector.get(S), c = l.getColumnHeader(s, n, t, r.t("sheets-table.columnPrefix"));
-    return d.addTable(s, n, e, t, c, i, a);
-  }
-  addTableFilter(e, t, i) {
-    const a = {
+h.extend(W);
+class E extends g {
+  addTable(e, t, n, i) {
+    const r = this.getSheetId(), a = {
+      unitId: this.getWorkbook().getUnitId(),
+      subUnitId: r,
+      name: e,
+      range: t,
+      id: n,
+      options: i
+    };
+    return this._commandService.executeCommand(u.id, a);
+  }
+  setTableFilter(e, t, n) {
+    const i = {
       unitId: this.getWorkbook().getUnitId(),
       tableId: e,
       column: t,
-      tableFilter: i
+      tableFilter: n
+    };
+    return this._commandService.executeCommand(d.id, i);
+  }
+  removeTable(e) {
+    const t = {
+      unitId: this._fWorkbook.getId(),
+      subUnitId: this.getSheetId(),
+      tableId: e
+    };
+    return this._commandService.executeCommand(T.id, t);
+  }
+  setTableRange(e, t) {
+    const n = {
+      unitId: this.getWorkbook().getUnitId(),
+      tableId: e,
+      updateRange: {
+        newRange: t
+      }
     };
-    return this._commandService.executeCommand(b.id, a);
+    return this._commandService.executeCommand(c.id, n);
+  }
+  setTableName(e, t) {
+    const n = {
+      unitId: this.getWorkbook().getUnitId(),
+      tableId: e,
+      name: t
+    };
+    return this._commandService.executeCommand(c.id, n);
+  }
+  getSubTableInfos() {
+    const e = this._fWorkbook.getId();
+    return this._injector.get(o).getTableList(e).filter((n) => n.subUnitId === this.getSheetId());
+  }
+  resetFilter(e, t) {
+    const n = {
+      unitId: this._fWorkbook.getId(),
+      tableId: e,
+      column: t,
+      tableFilter: void 0
+    };
+    return this._commandService.executeCommand(d.id, n);
+  }
+  getTableByCell(e, t) {
+    const n = this._fWorkbook.getId(), r = this._injector.get(o).getTableList(n).filter((a) => a.subUnitId === this.getSheetId()), s = x(e, t);
+    return r.find((a) => {
+      const l = a.range;
+      return y.intersects(l, s);
+    });
+  }
+  addTableTheme(e, t) {
+    const n = new F("table-style");
+    return n.fromJson(t), this._commandService.executeCommand(C.id, {
+      unitId: this._fWorkbook.getId(),
+      tableId: e,
+      themeStyle: n
+    });
+  }
+}
+g.extend(E);
+class U extends I {
+  get TableColumnFilterTypeEnum() {
+    return f;
+  }
+  get TableConditionTypeEnum() {
+    return v;
+  }
+  get TableNumberCompareTypeEnum() {
+    return k;
+  }
+  get TableStringCompareTypeEnum() {
+    return p;
+  }
+  get TableDateCompareTypeEnum() {
+    return _;
   }
 }
-h.extend(f);
+I.extend(U);

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

@@ -0,0 +1,23 @@
+import { FEnum } from '@univerjs/core/facade';
+import { TableColumnFilterTypeEnum, TableConditionTypeEnum, TableDateCompareTypeEnum, TableNumberCompareTypeEnum, TableStringCompareTypeEnum } from '@univerjs/sheets-table';
+/**
+ * @ignore
+ */
+export interface ITableEnumMixin {
+    TableColumnFilterTypeEnum: typeof TableColumnFilterTypeEnum;
+    TableConditionTypeEnum: typeof TableConditionTypeEnum;
+    TableNumberCompareTypeEnum: typeof TableNumberCompareTypeEnum;
+    TableStringCompareTypeEnum: typeof TableStringCompareTypeEnum;
+    TableDateCompareTypeEnum: typeof TableDateCompareTypeEnum;
+}
+export declare class TableEnum extends FEnum implements ITableEnumMixin {
+    get TableColumnFilterTypeEnum(): typeof TableColumnFilterTypeEnum;
+    get TableConditionTypeEnum(): typeof TableConditionTypeEnum;
+    get TableNumberCompareTypeEnum(): typeof TableNumberCompareTypeEnum;
+    get TableStringCompareTypeEnum(): typeof TableStringCompareTypeEnum;
+    get TableDateCompareTypeEnum(): typeof TableDateCompareTypeEnum;
+}
+declare module '@univerjs/core/facade' {
+    interface FEnum extends ITableEnumMixin {
+    }
+}

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

@@ -11,21 +11,52 @@ export interface IFWorkbookSheetsTableMixin {
      * @example
      * ```typescript
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fSheet = fWorkbook.getActiveSheet();
-     * const id = fWorkbook.addTable('Table1', {
-     *  unitId: fWorkbook.getId(),
-     *  subUnitId:fSheet.getSheetId(),
-     *  range: {
-     *      startRow: 1,
-     *      startColumn: 1,
-     *      endRow: 10,
-     *      endColumn: 5,
-     * },
-     * }, { showHeader: true });
-     * const tableInfo = fWorkbook.getTableInfo(fWorkbook.getId(), id);
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     *
+     * // Insert a table in the range B2:F11
+     * const fRange = fWorksheet.getRange('B2:F11');
+     * const success = await fWorksheet.addTable(
+     *   'name-1',
+     *   fRange.getRange(),
+     *   'id-1',
+     *   {
+     *     showHeader: true,
+     *   }
+     * );
+     *
+     * if (success) {
+     *   const tableInfo = fWorkbook.getTableInfo('id-1');
+     *   console.log('debugger tableInfo', tableInfo);
+     * }
      * ```
      */
     getTableInfo(tableId: string): ITableInfoWithUnitId | undefined;
+    /**
+     * Get table information by name
+     * @param {string} tableName The table name
+     * @returns {ITableInfo} The table information
+     * @example
+     * ```typescript
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     *
+     * // Insert a table in the range B2:F11
+     * const fRange = fWorksheet.getRange('B2:F11');
+     * const success = await fWorksheet.addTable(
+     *   'name-1',
+     *   fRange.getRange(),
+     *   'id-1',
+     *   {
+     *     showHeader: true,
+     *   }
+     * );
+     *
+     * if (success) {
+     *   const tableInfo = fWorkbook.getTableInfoByName('name-1');
+     *   console.log('debugger tableInfo', tableInfo);
+     * }
+     * ```
+     */
     getTableInfoByName(tableName: string): ITableInfoWithUnitId | undefined;
     /**
      * Get table list
@@ -33,45 +64,98 @@ export interface IFWorkbookSheetsTableMixin {
      * @example
      * ```typescript
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fSheet = fWorkbook.getActiveSheet();
-     * const id = fWorkbook.addTable('Table1', {
-     *  unitId: fWorkbook.getId(),
-     *  subUnitId:fSheet.getSheetId(),
-     *  range: {
-     *      startRow: 1,
-     *      startColumn: 1,
-     *      endRow: 10,
-     *      endColumn: 5,
-     * },
-     * }, { showHeader: true });
-     * const tableList = fWorkbook.getTableList(fWorkbook.getId());
+     * const tables = fWorkbook.getTableList();
+     * console.log('debugger tables', tables);
      * ```
      */
     getTableList(): ITableInfo[];
     /**
      * Add table
+     * @param {string} subUnitId The sub unit id
      * @param {string} tableName The table name
      * @param {ITableRange} rangeInfo The table range information
-     * @param {ITableOptions} options The table options
+     * @param {string} [tableId] The table id
+     * @param {ITableOptions} [options] The table options
      * @returns {string} The table id
      * @example
      * ```typescript
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fSheet = fWorkbook.getActiveSheet();
-     * const id = fWorkbook.addTable('Table1', {
-     *  unitId: fWorkbook.getId(),
-     *  subUnitId:fSheet.getSheetId(),
-     *  range: {
-     *      startRow: 1,
-     *      startColumn: 1,
-     *      endRow: 10,
-     *      endColumn: 5,
-     * },
-     * }, 'table1' ,{ showHeader: true });
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     *
+     * // Insert a table in the range B2:F11
+     * const fRange = fWorksheet.getRange('B2:F11');
+     * const id = await fWorkbook.addTable(
+     *   fWorksheet.getSheetId(),
+     *   'name-1',
+     *   fRange.getRange(),
+     *   'id-1',
+     *   {
+     *     showHeader: true,
+     *   }
+     * );
+     *
+     * if (id) {
+     *   const tableInfo = fWorkbook.getTableInfo(id);
+     *   console.log('debugger tableInfo', tableInfo);
+     * }
      * ```
      */
     addTable(subUnitId: string, tableName: string, rangeInfo: ITableRange, tableId?: string, options?: ITableOptions): Promise<string | undefined>;
+    /**
+     * set table filter
+     * @param {string} tableId The table id
+     * @param {number} column The column index, starting from 0.
+     * @param {ITableFilterItem} filter The filter item
+     * @returns {Promise<boolean>} The result of set table filter
+     * @example
+     * ```typescript
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     *
+     * // Insert a table in the range B2:F11
+     * const fRange = fWorksheet.getRange('B2:F11');
+     * const success = await fWorksheet.addTable(
+     *   'name-1',
+     *   fRange.getRange(),
+     *   'id-1',
+     *   {
+     *     showHeader: true,
+     *   }
+     * );
+     *
+     * if (success) {
+     *   // Set the filter for the second column
+     *   await fWorkbook.setTableFilter('id-1', 1, {
+     *     filterType: univerAPI.Enum.TableColumnFilterTypeEnum.condition,
+     *     filterInfo: {
+     *       conditionType: univerAPI.Enum.TableConditionTypeEnum.Number,
+     *       compareType: univerAPI.Enum.TableNumberCompareTypeEnum.GreaterThan,
+     *       expectedValue: 10,
+     *     },
+     *   });
+     *
+     *   const tableInfo = fWorkbook.getTableInfo('id-1');
+     *   console.log('debugger tableInfo', tableInfo);
+     * }
+     * ```
+     */
     setTableFilter(tableId: string, column: number, filter: ITableFilterItem | undefined): void;
+    /**
+     * Remove table
+     * @param {string} tableId The table id
+     * @returns {boolean} The result of remove table
+     * @example
+     * ```typescript
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const tableInfo = fWorkbook.getTableInfo('id-1');
+     * console.log('debugger tableInfo', tableInfo);
+     *
+     * if (tableInfo) {
+     *   // Remove the table with the specified id
+     *   await fWorkbook.removeTable('id-1');
+     * }
+     * ```
+     */
     removeTable(tableId: string): Promise<boolean>;
 }
 export declare class FWorkbookSheetsTableMixin extends FWorkbook implements IFWorkbookSheetsTableMixin {

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

@@ -1,15 +1,301 @@
-import { ITableFilterItem, ITableOptions, ITableRange } from '@univerjs/sheets-table';
+import { IRangeThemeStyleJSON } from '@univerjs/sheets';
+import { ITableFilterItem, ITableInfoWithUnitId, ITableOptions, ITableRange } from '@univerjs/sheets-table';
 import { FWorksheet } from '@univerjs/sheets/facade';
 /**
  * @ignore
  */
 export interface IFWorkSheetTableMixin {
-    addTable(tableName: string, rangeInfo: ITableRange, tableId?: string, options?: ITableOptions): string;
-    addTableFilter(tableId: string, column: number, filter: ITableFilterItem): Promise<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
+     * @example
+     * ```typescript
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     *
+     * // Insert a table in the range B2:F11
+     * const fRange = fWorksheet.getRange('B2:F11');
+     * const success = await fWorksheet.addTable(
+     *   'name-1',
+     *   fRange.getRange(),
+     *   'id-1',
+     *   {
+     *     showHeader: true,
+     *   }
+     * );
+     *
+     * if (success) {
+     *   const tableInfo = fWorkbook.getTableInfo('id-1');
+     *   console.log('debugger tableInfo', tableInfo);
+     * }
+     * ```
+     */
+    addTable(tableName: string, rangeInfo: ITableRange, tableId?: string, options?: ITableOptions): Promise<boolean>;
+    /**
+     * Set the filter for a table column
+     * @param {string} tableId The table id
+     * @param {number} column The table column index, starting from 0. For example, the first column is 0, the second column is 1, and so on.
+     * @param {ITableFilterItem} filter The filter item
+     * @returns {Promise<boolean>} Whether the table filter was set successfully
+     * @example
+     * ```typescript
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     *
+     * // Insert a table in the range B2:F11
+     * const fRange = fWorksheet.getRange('B2:F11');
+     * const success = await fWorksheet.addTable(
+     *   'name-1',
+     *   fRange.getRange(),
+     *   'id-1',
+     *   {
+     *     showHeader: true,
+     *   }
+     * );
+     *
+     * if (success) {
+     *   // Set the filter for the second column
+     *   await fWorksheet.setTableFilter('id-1', 1, {
+     *     filterType: univerAPI.Enum.TableColumnFilterTypeEnum.condition,
+     *     filterInfo: {
+     *       conditionType: univerAPI.Enum.TableConditionTypeEnum.Number,
+     *       compareType: univerAPI.Enum.TableNumberCompareTypeEnum.GreaterThan,
+     *       expectedValue: 10,
+     *     },
+     *   });
+     *
+     *   const tableInfo = fWorkbook.getTableInfo('id-1');
+     *   console.log('debugger tableInfo', tableInfo);
+     * }
+     * ```
+     */
+    setTableFilter(tableId: string, column: number, filter: ITableFilterItem): Promise<boolean>;
+    /**
+     * Remove a table from the worksheet
+     * @param {string} tableId The table id
+     * @returns {Promise<boolean>} Whether the table was removed successfully
+     * @example
+     * ```typescript
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const tableInfo = fWorkbook.getTableInfo('id-1');
+     * console.log('debugger tableInfo', tableInfo);
+     *
+     * if (tableInfo) {
+     *   // Remove the table with the specified id
+     *   await fWorksheet.removeTable('id-1');
+     * }
+     * ```
+     */
+    removeTable(tableId: string): Promise<boolean>;
+    /**
+     * Set the range of a table
+     * @param {string} tableId The table id
+     * @param {ITableRange} rangeInfo The new range information
+     * @returns {Promise<boolean>} Whether the table range was set successfully
+     * @example
+     * ```typescript
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     *
+     * // Insert a table in the range B2:F11
+     * const fRange = fWorksheet.getRange('B2:F11');
+     * const success = await fWorksheet.addTable(
+     *   'name-1',
+     *   fRange.getRange(),
+     *   'id-1',
+     *   {
+     *     showHeader: true,
+     *   }
+     * );
+     *
+     * if (success) {
+     *   // Update the table range to B2:F21 after 3 seconds
+     *   setTimeout(async () => {
+     *     const newRange = fWorksheet.getRange('B2:F21');
+     *     await fWorksheet.setTableRange('id-1', newRange.getRange());
+     *
+     *     const tableInfo = fWorkbook.getTableInfo('id-1');
+     *     console.log('debugger tableInfo', tableInfo);
+     *   }, 3000);
+     * }
+     * ```
+     */
+    setTableRange(tableId: string, rangeInfo: ITableRange): Promise<boolean>;
+    /**
+     * 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
+     * @example
+     * ```typescript
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     *
+     * // Insert a table in the range B2:F11
+     * const fRange = fWorksheet.getRange('B2:F11');
+     * const success = await fWorksheet.addTable(
+     *   'name-1',
+     *   fRange.getRange(),
+     *   'id-1',
+     *   {
+     *     showHeader: true,
+     *   }
+     * );
+     *
+     * if (success) {
+     *   // Update the table name after 3 seconds
+     *   setTimeout(async () => {
+     *     await fWorksheet.setTableName('id-1', 'new-name');
+     *
+     *     const tableInfo = fWorkbook.getTableInfo('id-1');
+     *     console.log('debugger tableInfo', tableInfo);
+     *   }, 3000);
+     * }
+     * ```
+     */
+    setTableName(tableId: string, tableName: string): Promise<boolean>;
+    /**
+     * Get the list of tables in the worksheet
+     * @returns {ITableInfoWithUnitId[]} The list of tables
+     * @example
+     * ```typescript
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const tables = fWorksheet.getSubTableInfos();
+     * console.log('debugger tables', tables);
+     * ```
+     */
+    getSubTableInfos(): ITableInfoWithUnitId[];
+    /**
+     * Reset the column filter of a table
+     * @param {string} tableId The table id
+     * @param {number} column The column index, starting from 0. For example, the first column is 0, the second column is 1, and so on.
+     * @returns {Promise<boolean>} Whether the table filter was reset successfully
+     * @example
+     * ```typescript
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     *
+     * // Insert a table in the range B2:F11
+     * const fRange = fWorksheet.getRange('B2:F11');
+     * const success = await fWorksheet.addTable(
+     *   'name-1',
+     *   fRange.getRange(),
+     *   'id-1',
+     *   {
+     *     showHeader: true,
+     *   }
+     * );
+     *
+     * if (success) {
+     *   // Set the filter for the second column
+     *   await fWorksheet.setTableFilter('id-1', 1, {
+     *     filterType: univerAPI.Enum.TableColumnFilterTypeEnum.condition,
+     *     filterInfo: {
+     *       conditionType: univerAPI.Enum.TableConditionTypeEnum.Number,
+     *       compareType: univerAPI.Enum.TableNumberCompareTypeEnum.GreaterThan,
+     *       expectedValue: 10,
+     *     },
+     *   });
+     *
+     *   // Reset the filter for the second column after 3 seconds
+     *   setTimeout(async () => {
+     *     await fWorksheet.resetFilter('id-1', 1);
+     *   }, 3000);
+     *
+     *   const tableInfo = fWorkbook.getTableInfo('id-1');
+     *   console.log('debugger tableInfo', tableInfo);
+     * }
+     * ```
+     */
+    resetFilter(tableId: string, column: number): Promise<boolean>;
+    /**
+     * Get the table information by cell position
+     * @param {number} row The cell row index, starting from 0.
+     * @param {number} column The cell column index, starting from 0.
+     * @returns {ITableInfoWithUnitId | undefined} The table information or undefined if not found
+     * @example
+     * ```typescript
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     *
+     * const cellB2 = fWorksheet.getRange('B2');
+     * const row = cellB2.getRow();
+     * const column = cellB2.getColumn();
+     * console.log('debugger tableInfo', fWorksheet.getTableByCell(row, column));
+     *
+     * // Insert a table in the range B2:F11
+     * const fRange = fWorksheet.getRange('B2:F11');
+     * const success = await fWorksheet.addTable(
+     *   'name-1',
+     *   fRange.getRange(),
+     *   'id-1',
+     *   {
+     *     showHeader: true,
+     *   }
+     * );
+     * console.log('debugger tableInfo2', fWorksheet.getTableByCell(row, column));
+     * ```
+     */
+    getTableByCell(row: number, column: number): ITableInfoWithUnitId | undefined;
+    /**
+     * Add a theme to the table
+     * @param {string} tableId The table id
+     * @param {IRangeThemeStyleJSON} themeStyleJSON The theme style JSON
+     * @returns {Promise<boolean>} Whether the theme was added successfully
+     * @example
+     * ```typescript
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     *
+     * // Insert a table in the range B2:F11
+     * const fRange = fWorksheet.getRange('B2:F11');
+     * const success = await fWorksheet.addTable(
+     *   'name-1',
+     *   fRange.getRange(),
+     *   'id-1',
+     *   {
+     *     showHeader: true,
+     *   }
+     * );
+     *
+     * if (success) {
+     *   await fWorksheet.addTableTheme('id-1', {
+     *     name: 'table-custom-1',
+     *     headerRowStyle: {
+     *       bg: {
+     *         rgb: '#145f82',
+     *       },
+     *     },
+     *     firstRowStyle: {
+     *       bg: {
+     *         rgb: '#c0e4f5',
+     *       },
+     *     },
+     *   });
+     *
+     *   const tableInfo = fWorkbook.getTableInfo('id-1');
+     *   console.log('debugger tableInfo', tableInfo);
+     * }
+     * ```
+     */
+    addTableTheme(tableId: string, themeStyleJSON: IRangeThemeStyleJSON): Promise<boolean>;
 }
 export declare class FWorkSheetTableMixin extends FWorksheet implements IFWorkSheetTableMixin {
-    addTable(tableName: string, rangeInfo: ITableRange, tableId?: string, options?: ITableOptions): string;
-    addTableFilter(tableId: string, column: number, filter: ITableFilterItem): Promise<boolean>;
+    addTable(tableName: string, rangeInfo: ITableRange, tableId?: string, options?: ITableOptions): Promise<boolean>;
+    setTableFilter(tableId: string, column: number, filter: ITableFilterItem): Promise<boolean>;
+    removeTable(tableId: string): Promise<boolean>;
+    setTableRange(tableId: string, rangeInfo: ITableRange): Promise<boolean>;
+    setTableName(tableId: string, tableName: string): Promise<boolean>;
+    getSubTableInfos(): ITableInfoWithUnitId[];
+    resetFilter(tableId: string, column: number): Promise<boolean>;
+    getTableByCell(row: number, column: number): ITableInfoWithUnitId | undefined;
+    addTableTheme(tableId: string, themeStyleJSON: IRangeThemeStyleJSON): Promise<boolean>;
 }
 declare module '@univerjs/sheets/facade' {
     interface FWorksheet extends IFWorkSheetTableMixin {

package/lib/types/facade/index.d.ts

@@ -15,5 +15,6 @@
  */
 import './f-workbook';
 import './f-worksheet';
+import './f-enum';
 export type * from './f-workbook';
 export type * from './f-worksheet';

package/lib/umd/facade.js

@@ -1 +1 @@
-(function(i,s){typeof exports=="object"&&typeof module<"u"?s(require("@univerjs/sheets-table"),require("@univerjs/sheets/facade"),require("@univerjs/core")):typeof define=="function"&&define.amd?define(["@univerjs/sheets-table","@univerjs/sheets/facade","@univerjs/core"],s):(i=typeof globalThis<"u"?globalThis:i||self,s(i.UniverSheetsTable,i.UniverSheetsFacade,i.UniverCore))})(this,function(i,s,u){"use strict";class b extends s.FWorkbook{getTableInfo(e){const t=this.getId();return this._injector.get(i.SheetTableService).getTableInfo(t,e)}getTableList(){const e=this.getId();return this._injector.get(i.SheetTableService).getTableList(e)}async addTable(e,t,n,r,c){var d;const a=this._injector.get(i.SheetTableService),o={unitId:this.getId(),name:t,subUnitId:e,range:n,options:c,tableId:r};if(await this._commandService.executeCommand(i.AddSheetTableCommand.id,o))return(d=a.getTableList(this.getId()).find(l=>l.name===t))==null?void 0:d.id}async removeTable(e){var r;const t=(r=this.getTableInfo(e))==null?void 0:r.subUnitId;if(!t)return!1;const n={unitId:this.getId(),subUnitId:t,tableId:e};return this._commandService.executeCommand(i.DeleteSheetTableCommand.id,n)}getTableInfoByName(e){return this.getTableList().find(n=>n.name===e)}setTableFilter(e,t,n){const r={unitId:this.getId(),tableId:e,column:t,tableFilter:n};return this._commandService.executeCommand(i.SetSheetTableFilterCommand.id,r)}}s.FWorkbook.extend(b);class m extends s.FWorksheet{addTable(e,t,n,r){const c=this._injector.get(i.SheetTableService),a=this.getSheetId(),o=this.getWorkbook().getUnitId(),h=this._injector.get(i.TableManager),d=this._injector.get(u.LocaleService),l=h.getColumnHeader(o,a,t,d.t("sheets-table.columnPrefix"));return c.addTable(o,a,e,t,l,n,r)}addTableFilter(e,t,n){const r={unitId:this.getWorkbook().getUnitId(),tableId:e,column:t,tableFilter:n};return this._commandService.executeCommand(i.SetSheetTableFilterCommand.id,r)}}s.FWorksheet.extend(m)});
+(function(t,a){typeof exports=="object"&&typeof module<"u"?a(require("@univerjs/sheets-table"),require("@univerjs/sheets/facade"),require("@univerjs/core"),require("@univerjs/sheets"),require("@univerjs/core/facade")):typeof define=="function"&&define.amd?define(["@univerjs/sheets-table","@univerjs/sheets/facade","@univerjs/core","@univerjs/sheets","@univerjs/core/facade"],a):(t=typeof globalThis<"u"?globalThis:t||self,a(t.UniverSheetsTable,t.UniverSheetsFacade,t.UniverCore,t.UniverSheets,t.UniverCoreFacade))})(this,function(t,a,m,h,u){"use strict";class T extends a.FWorkbook{getTableInfo(e){const n=this.getId();return this._injector.get(t.SheetTableService).getTableInfo(n,e)}getTableList(){const e=this.getId();return this._injector.get(t.SheetTableService).getTableList(e)}async addTable(e,n,i,r,d){var b;const s=this._injector.get(t.SheetTableService),o={unitId:this.getId(),name:n,subUnitId:e,range:i,options:d,id:r};if(await this._commandService.executeCommand(t.AddSheetTableCommand.id,o))return(b=s.getTableList(this.getId()).find(v=>v.name===n))==null?void 0:b.id}async removeTable(e){var r;const n=(r=this.getTableInfo(e))==null?void 0:r.subUnitId;if(!n)return!1;const i={unitId:this.getId(),subUnitId:n,tableId:e};return this._commandService.executeCommand(t.DeleteSheetTableCommand.id,i)}getTableInfoByName(e){return this.getTableList().find(i=>i.name===e)}setTableFilter(e,n,i){const r={unitId:this.getId(),tableId:e,column:n,tableFilter:i};return this._commandService.executeCommand(t.SetSheetTableFilterCommand.id,r)}}a.FWorkbook.extend(T);class S extends a.FWorksheet{addTable(e,n,i,r){const d=this.getSheetId(),o={unitId:this.getWorkbook().getUnitId(),subUnitId:d,name:e,range:n,id:i,options:r};return this._commandService.executeCommand(t.AddSheetTableCommand.id,o)}setTableFilter(e,n,i){const r={unitId:this.getWorkbook().getUnitId(),tableId:e,column:n,tableFilter:i};return this._commandService.executeCommand(t.SetSheetTableFilterCommand.id,r)}removeTable(e){const n={unitId:this._fWorkbook.getId(),subUnitId:this.getSheetId(),tableId:e};return this._commandService.executeCommand(t.DeleteSheetTableCommand.id,n)}setTableRange(e,n){const i={unitId:this.getWorkbook().getUnitId(),tableId:e,updateRange:{newRange:n}};return this._commandService.executeCommand(t.SetSheetTableCommand.id,i)}setTableName(e,n){const i={unitId:this.getWorkbook().getUnitId(),tableId:e,name:n};return this._commandService.executeCommand(t.SetSheetTableCommand.id,i)}getSubTableInfos(){const e=this._fWorkbook.getId();return this._injector.get(t.SheetTableService).getTableList(e).filter(i=>i.subUnitId===this.getSheetId())}resetFilter(e,n){const i={unitId:this._fWorkbook.getId(),tableId:e,column:n,tableFilter:void 0};return this._commandService.executeCommand(t.SetSheetTableFilterCommand.id,i)}getTableByCell(e,n){const i=this._fWorkbook.getId(),d=this._injector.get(t.SheetTableService).getTableList(i).filter(o=>o.subUnitId===this.getSheetId()),s=m.cellToRange(e,n);return d.find(o=>{const l=o.range;return m.Rectangle.intersects(l,s)})}addTableTheme(e,n){const i=new h.RangeThemeStyle("table-style");return i.fromJson(n),this._commandService.executeCommand(t.AddTableThemeCommand.id,{unitId:this._fWorkbook.getId(),tableId:e,themeStyle:i})}}a.FWorksheet.extend(S);class g extends u.FEnum{get TableColumnFilterTypeEnum(){return t.TableColumnFilterTypeEnum}get TableConditionTypeEnum(){return t.TableConditionTypeEnum}get TableNumberCompareTypeEnum(){return t.TableNumberCompareTypeEnum}get TableStringCompareTypeEnum(){return t.TableStringCompareTypeEnum}get TableDateCompareTypeEnum(){return t.TableDateCompareTypeEnum}}u.FEnum.extend(g)});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@univerjs/sheets-table",
-  "version": "0.7.0",
+  "version": "0.8.0-beta.0",
   "private": false,
   "description": "A library for connect and bind data from other sources to Univer Sheets",
   "author": "DreamNum <developer@univer.ai>",
@@ -60,15 +60,15 @@
     "rxjs": ">=7.0.0"
   },
   "dependencies": {
-    "@univerjs/sheets": "0.7.0",
-    "@univerjs/core": "0.7.0"
+    "@univerjs/sheets": "0.8.0-beta.0",
+    "@univerjs/core": "0.8.0-beta.0"
   },
   "devDependencies": {
     "rxjs": "^7.8.2",
     "typescript": "^5.8.3",
     "vite": "^6.3.5",
-    "vitest": "^3.1.3",
-    "@univerjs-infra/shared": "0.7.0"
+    "vitest": "^3.1.4",
+    "@univerjs-infra/shared": "0.8.0-beta.0"
   },
   "scripts": {
     "test": "vitest run",