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

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/index.js

@@ -1530,8 +1530,8 @@ let W = class extends k {
               if (d) {
                 const c = d.getRange(), m = a - c.startColumn;
                 if (c.startRow === s) {
-                  const w = d.getColumnNameByIndex(m), f = { ...e, v: w };
-                  return r(f);
+                  const w = d.getColumnNameByIndex(m);
+                  return (!e || e === n.rawData) && (e = { ...n.rawData }), e.v = w, r(e);
                 }
               }
             }

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 {