Skip to content

Build your own AI office with Univer Office SDK. Bring editing, calculation, collaboration, and file processing into your product for people and AI agents. Built on an extensible open-source core.

chore: add table facade (#5215)

ybzky65f8bf37adcc
diff --git a/packages/sheets-table-ui/src/views/components/SheetTableThemePanel.tsx b/packages/sheets-table-ui/src/views/components/SheetTableThemePanel.tsx
index 6841b0dff8..7aa68f6c8f 100644
--- a/packages/sheets-table-ui/src/views/components/SheetTableThemePanel.tsx
+++ b/packages/sheets-table-ui/src/views/components/SheetTableThemePanel.tsx
@@ -23,7 +23,7 @@ import { RangeThemeStyle, SetRangeThemeMutation, SheetRangeThemeModel } from '@u
import { AddTableThemeCommand, customEmptyThemeWithBorderStyle, processStyleWithBorderStyle, RemoveTableThemeCommand, SetSheetTableCommand, TableManager } from '@univerjs/sheets-table';
import { useDependency, useObservable } from '@univerjs/ui';
import { useEffect, useState } from 'react';
-import { TABLE_BORDER_DEFAULT, TABLE_BORDER_NONE, TABLE_BORDER_SELECTED, TABLE_CUSTOM_NAME_PREFIX, TABLE_DEFAULT_BG_COLOR, TABLE_DEFAULT_NAME_PREFIX } from '../../const';
+import { TABLE_BORDER_DEFAULT, TABLE_BORDER_NONE, TABLE_CUSTOM_NAME_PREFIX, TABLE_DEFAULT_BG_COLOR, TABLE_DEFAULT_NAME_PREFIX } from '../../const';
import { SheetTableThemeUIController } from '../../controllers/sheet-table-theme-ui.controller';
export interface ISheetTableThemePanelProps {
@@ -140,11 +140,13 @@ export const SheetTableThemePanel = (props: ISheetTableThemePanelProps) => {
return (
<div
key={item}
- className="univer-h-10 univer-w-8 univer-cursor-pointer univer-p-px"
+ className={clsx(`
+ univer-h-10 univer-w-8 univer-cursor-pointer univer-p-px univer-border univer-border-solid
+ univer-border-gray-200
+ `, {
+ 'univer-border-blue-500': item === themeConfig.theme,
+ })}
onClick={() => handleThemeChange(item)}
- style={{
- border: item === themeConfig.theme ? TABLE_BORDER_SELECTED : TABLE_BORDER_DEFAULT,
- }}
>
<div className="univer-box-border univer-h-2.5" style={{ background: headerRowBg, border: `${headerRowBg ? TABLE_BORDER_NONE : TABLE_BORDER_DEFAULT}` }} />
<div className="univer-box-border univer-h-2.5" style={{ background: firstRowBg, border: `${firstRowBg ? TABLE_BORDER_NONE : TABLE_BORDER_DEFAULT}` }} />
@@ -176,11 +178,13 @@ export const SheetTableThemePanel = (props: ISheetTableThemePanelProps) => {
return (
<div
key={item}
- className="univer-relative univer-h-10 univer-w-8 univer-cursor-pointer univer-p-px"
+ className={clsx(`
+ univer-relative univer-h-10 univer-w-8 univer-cursor-pointer univer-p-px univer-border
+ univer-border-solid univer-border-gray-200
+ `, {
+ 'univer-border-blue-500': item === themeConfig.theme,
+ })}
onClick={() => handleThemeChange(item)}
- style={{
- border: item === themeConfig.theme ? TABLE_BORDER_SELECTED : TABLE_BORDER_DEFAULT,
- }}
onMouseEnter={() => setHoverCustomId(item)}
onMouseLeave={() => setHoverCustomId(null)}
>
@@ -346,7 +350,7 @@ export const SheetTableThemePanel = (props: ISheetTableThemePanelProps) => {
className={clsx(`
univer-flex univer-cursor-pointer univer-items-center univer-gap-2
univer-rounded-sm univer-bg-white univer-p-1
- `)}
+ `, borderClassName)}
>
<div
className={clsx('univer-h-4 univer-w-4 univer-rounded-lg univer-bg-gray-400', borderClassName)}
diff --git a/packages/sheets-table/src/facade/f-enum.ts b/packages/sheets-table/src/facade/f-enum.ts
new file mode 100644
index 0000000000..22a25e0a5a
--- /dev/null
+++ b/packages/sheets-table/src/facade/f-enum.ts
@@ -0,0 +1,57 @@
+/**
+ * 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 { 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 class TableEnum extends FEnum implements ITableEnumMixin {
+ override get TableColumnFilterTypeEnum(): typeof TableColumnFilterTypeEnum {
+ return TableColumnFilterTypeEnum;
+ };
+
+ override get TableConditionTypeEnum(): typeof TableConditionTypeEnum {
+ return TableConditionTypeEnum;
+ };
+
+ override get TableNumberCompareTypeEnum(): typeof TableNumberCompareTypeEnum {
+ return TableNumberCompareTypeEnum;
+ }
+
+ override get TableStringCompareTypeEnum(): typeof TableStringCompareTypeEnum {
+ return TableStringCompareTypeEnum;
+ }
+
+ override get TableDateCompareTypeEnum(): typeof TableDateCompareTypeEnum {
+ return TableDateCompareTypeEnum;
+ }
+}
+
+FEnum.extend(TableEnum);
+declare module '@univerjs/core/facade' {
+ // eslint-disable-next-line ts/naming-convention
+ interface FEnum extends ITableEnumMixin { }
+}
diff --git a/packages/sheets-table/src/facade/f-workbook.ts b/packages/sheets-table/src/facade/f-workbook.ts
index 9a838a9b9e..5511cfd64c 100644
--- a/packages/sheets-table/src/facade/f-workbook.ts
+++ b/packages/sheets-table/src/facade/f-workbook.ts
@@ -14,7 +14,7 @@
* limitations under the License.
*/
-import type { IAddSheetTableParams, IDeleteSheetTableParams, ISetSheetTableParams, ITableFilterItem, ITableInfo, ITableInfoWithUnitId, ITableOptions, ITableRange } from '@univerjs/sheets-table';
+import type { IAddSheetTableCommandParams, IDeleteSheetTableParams, ISetSheetTableParams, ITableFilterItem, ITableInfo, ITableInfoWithUnitId, ITableOptions, ITableRange } from '@univerjs/sheets-table';
import { AddSheetTableCommand, DeleteSheetTableCommand, SetSheetTableFilterCommand, SheetTableService } from '@univerjs/sheets-table';
import { FWorkbook } from '@univerjs/sheets/facade';
@@ -30,22 +30,44 @@ export interface IFWorkbookSheetsTableMixin {
* ```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 subUnitId = fSheet.getSheetId();
+ * const id = await fWorkbook.addTable(subUnitId, 'name-1', {
+ * startRow: 1,
+ * startColumn: 1,
+ * endRow: 10,
+ * endColumn: 5,
+ * }, 'id-1', {
+ * showHeader: true
+ * })
+ * const tableInfo = fWorkbook.getTableInfo(id);
+ * console.log('debugger tableInfo',tableInfo);
* ```
*/
getTableInfo(tableId: string): ITableInfoWithUnitId | undefined;
+ /**
+ * Get table information by name
+ * @param tableName The table name
+ * @returns {ITableInfo} The table information
+ * @example
+ * ```typescript
+ * const fWorkbook = univerAPI.getActiveWorkbook();
+ * const fSheet = fWorkbook.getActiveSheet();
+ * const subUnitId = fSheet.getSheetId();
+ * const id = await fWorkbook.addTable(subUnitId, 'name-1', {
+ * startRow: 1,
+ * startColumn: 1,
+ * endRow: 10,
+ * endColumn: 5,
+ * }, 'id-1', {
+ * showHeader: true
+ * })
+ * const tableInfo = fWorkbook.getTableInfoByName('name-1');
+ * console.log('debugger tableInfo',tableInfo);
+ * ```
+ */
getTableInfoByName(tableName: string): ITableInfoWithUnitId | undefined;
+
/**
* Get table list
* @returns {ITableInfo[]} The table list
@@ -53,44 +75,102 @@ export interface IFWorkbookSheetsTableMixin {
* ```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 subUnitId = fSheet.getSheetId();
+ * const id = await fWorkbook.addTable(subUnitId, 'name-1',{
+ * startRow: 1,
+ * startColumn: 1,
+ * endRow: 10,
+ * endColumn: 5,
+ * }, 'id-1',{
+ * showHeader: true
+ * })
* const tableList = fWorkbook.getTableList(fWorkbook.getId());
+ * console.log('debugger tableList', tableList);
* ```
*/
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 {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 subUnitId = fSheet.getSheetId();
+ * const unitId = fWorkbook.getId();
+ * const id = await fWorkbook.addTable(subUnitId, 'name-1',{
+ * startRow: 1,
+ * startColumn: 1,
+ * endRow: 10,
+ * endColumn: 5,
+ * }, 'id-1',{
+ * showHeader: true
+ * })
+ * console.log('tableId:', id)
* ```
*/
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
+ * @param {ITableFilterItem} filter The filter item
+ * @returns {Promise<boolean>} The result of set table filter
+ * @example
+ * ```typescript
+ * const fWorkbook = univerAPI.getActiveWorkbook();
+ * const fSheet = fWorkbook.getActiveSheet();
+ * const subUnitId = fSheet.getSheetId();
+ * const id = await fWorkbook.addTable(subUnitId, 'name-1',{
+ * startRow: 1,
+ * startColumn: 1,
+ * endRow: 10,
+ * endColumn: 5,
+ * }, 'id-1',{
+ * showHeader: true
+ * })
+ * const tableInfo = fWorkbook.getTableInfo(id);
+ * console.log('debugger tableInfo',tableInfo);
+ * const result = await fWorkbook.setTableFilter(id, 1, {
+ * filterType: univerAPI.Enum.TableColumnFilterTypeEnum.condition,
+ * filterInfo: {
+ * conditionType: univerAPI.Enum.TableConditionTypeEnum.Number,
+ * compareType: univerAPI.Enum.TableNumberCompareTypeEnum.GreaterThan,
+ * expectedValue: 10,
+ * }
+ * })
+ */
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 fSheet = fWorkbook.getActiveSheet();
+ * const subUnitId = fSheet.getSheetId();
+ * const id = await fWorkbook.addTable(subUnitId, 'name-1', {
+ * startRow: 1,
+ * startColumn: 1,
+ * endRow: 10,
+ * endColumn: 5,
+ * }, 'id-1', {
+ * showHeader: true
+ * })
+ * const removedSuccess = await fWorkbook.removeTable(id);
+ * const tableInfo = fWorkbook.getTableInfo('id-1')
+ * console.log('debugger tableInfo is undefined', tableInfo)
+ * ```
+ */
removeTable(tableId: string): Promise<boolean>;
}
@@ -110,13 +190,13 @@ export class FWorkbookSheetsTableMixin extends FWorkbook implements IFWorkbookSh
override async addTable(subUnitId: string, tableName: string, rangeInfo: ITableRange, tableId?: string, options?: ITableOptions): Promise<string | undefined> {
const sheetTableService = this._injector.get(SheetTableService);
- const addTableParams: IAddSheetTableParams = {
+ const addTableParams: IAddSheetTableCommandParams = {
unitId: this.getId(),
name: tableName,
subUnitId,
range: rangeInfo,
options,
- tableId,
+ id: tableId,
};
const rs = await this._commandService.executeCommand(AddSheetTableCommand.id, addTableParams);
if (rs) {
diff --git a/packages/sheets-table/src/facade/f-worksheet.ts b/packages/sheets-table/src/facade/f-worksheet.ts
index 3eaa957b19..8a52f42324 100644
--- a/packages/sheets-table/src/facade/f-worksheet.ts
+++ b/packages/sheets-table/src/facade/f-worksheet.ts
@@ -14,31 +14,308 @@
* limitations under the License.
*/
-import type { ISetSheetTableParams, ITableFilterItem, ITableOptions, ITableRange } from '@univerjs/sheets-table';
-import { LocaleService } from '@univerjs/core';
-import { SetSheetTableFilterCommand, SheetTableService, TableManager } from '@univerjs/sheets-table';
+import type { IRangeThemeStyleJSON } from '@univerjs/sheets';
+import type { IAddSheetTableCommandParams, IDeleteSheetTableParams, ISetSheetTableCommandParams, ISetSheetTableParams, ITableFilterItem, ITableInfoWithUnitId, ITableOptions, ITableRange } from '@univerjs/sheets-table';
+import { cellToRange, Rectangle } from '@univerjs/core';
+import { RangeThemeStyle } from '@univerjs/sheets';
+import { AddSheetTableCommand, AddTableThemeCommand, DeleteSheetTableCommand, SetSheetTableCommand, SetSheetTableFilterCommand, SheetTableService } 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 tableName The table name
+ * @param rangeInfo The table range information
+ * @param tableId The table id
+ * @param options The table options
+ * @returns {Promise<boolean>} Whether the table was added successfully
+ * @example
+ * ```typescript
+ * const fWorkbook = univerAPI.getActiveWorkbook();
+ * const fSheet = fWorkbook.getActiveSheet();
+ * const subUnitId = fSheet.getSheetId();
+ * const res = await fSheet.addTable('name-1', {
+ * startRow: 1,
+ * startColumn: 1,
+ * endRow: 10,
+ * endColumn: 5,
+ * }, 'id-1', {
+ * showHeader: true
+ * })
+ * const tableInfo = fWorkbook.getTableInfo('id-1');
+ * console.log('debugger tableInfo', tableInfo);
+ * ```
+ */
+ addTable(tableName: string, rangeInfo: ITableRange, tableId?: string, options?: ITableOptions): Promise<boolean>;
+
+ /**
+ *
+ * @param tableId The table id
+ * @param column The column index
+ * @param filter The filter item
+ * @returns {Promise<boolean>} Whether the table filter was set successfully
+ * @example
+ * ```typescript
+ * const fWorkbook = univerAPI.getActiveWorkbook();
+ * const fSheet = fWorkbook.getActiveSheet();
+ * const subUnitId = fSheet.getSheetId();
+ * const res = await fSheet.addTable('name-1', {
+ * startRow: 1,
+ * startColumn: 1,
+ * endRow: 10,
+ * endColumn: 5,
+ * }, 'id-1', {
+ * showHeader: true
+ * })
+ * const tableInfo = fWorkbook.getTableInfo('id-1');
+ * console.log('debugger tableInfo',tableInfo);
+ * const result = await fSheet.setTableFilter('id-1', 1, {
+ * filterType: univerAPI.Enum.TableColumnFilterTypeEnum.condition,
+ * filterInfo: {
+ * conditionType: univerAPI.Enum.TableConditionTypeEnum.Number,
+ * compareType: univerAPI.Enum.TableNumberCompareTypeEnum.GreaterThan,
+ * expectedValue: 10,
+ * }
+ * });
+ * console.log('debugger result',result);
+ */
+ setTableFilter(tableId: string, column: number, filter: ITableFilterItem): Promise<boolean>;
+
+ /**
+ * Remove a table from the worksheet
+ * @param tableId The table id
+ * @returns {Promise<boolean>} Whether the table was removed successfully
+ * @example
+ * ```typescript
+ * const fWorkbook = univerAPI.getActiveWorkbook();
+ * const fSheet = fWorkbook.getActiveSheet();
+ * const subUnitId = fSheet.getSheetId();
+ * const res = await fSheet.addTable('name-1', {
+ * startRow: 1,
+ * startColumn: 1,
+ * endRow: 10,
+ * endColumn: 5,
+ * }, 'id-1', {
+ * showHeader: true
+ * })
+ * const tableInfo = fWorkbook.getTableInfo('id-1');
+ * console.log('debugger tableInfo', tableInfo);
+ * const result = await fSheet.removeTable('id-1');
+ * console.log('debugger result', result);
+ */
+ removeTable(tableId: string): Promise<boolean>;
+
+ /**
+ * Set the range of a table
+ * @param tableId The table id
+ * @param rangeInfo The new range information
+ * @returns {Promise<boolean>} Whether the table range was set successfully
+ * @example
+ * ```typescript
+ * const fWorkbook = univerAPI.getActiveWorkbook();
+ * const fSheet = fWorkbook.getActiveSheet();
+ * const subUnitId = fSheet.getSheetId();
+ * const res = await fSheet.addTable('name-1', {
+ * startRow: 1,
+ * startColumn: 1,
+ * endRow: 10,
+ * endColumn: 5,
+ * }, 'id-1', {
+ * showHeader: true
+ * })
+ * const tableInfo = fWorkbook.getTableInfo('id-1');
+ * console.log('debugger tableInfo', tableInfo);
+ * const result = await fSheet.setTableRange('id-1', {
+ * startRow: 1,
+ * startColumn: 1,
+ * endRow: 20,
+ * endColumn: 5,
+ * })
+ * console.log('debugger result', result);
+ * const tableInfo2 = fWorkbook.getTableInfo('id-1');
+ * console.log('debugger tableInfo2', tableInfo2);
+ * ```
+ */
+ setTableRange(tableId: string, rangeInfo: ITableRange): Promise<boolean>;
+
+ /**
+ * Set the name of a table
+ * @param tableId The table id
+ * @param tableName The new table name
+ * @returns {Promise<boolean>} Whether the table name was set successfully
+ * @example
+ * ```typescript
+ * const fWorkbook = univerAPI.getActiveWorkbook();
+ * const fSheet = fWorkbook.getActiveSheet();
+ * const subUnitId = fSheet.getSheetId();
+ * const res = await fSheet.addTable('name-1', {
+ * startRow: 1,
+ * startColumn: 1,
+ * endRow: 10,
+ * endColumn: 5,
+ * }, 'id-1', {
+ * showHeader: true
+ * })
+ * const result = await fSheet.setTableName('id-1', 'new-name');
+ * console.log('debugger result',result);
+ * ```
+ */
+ 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 fSheet = fWorkbook.getActiveSheet();
+ * const subUnitId = fSheet.getSheetId();
+ * const res = await fSheet.addTable('name-1', {
+ * startRow: 1,
+ * startColumn: 1,
+ * endRow: 10,
+ * endColumn: 5,
+ * }, 'id-1', {
+ * showHeader: true
+ * })
+ * const tableList = fSheet.getSubTableInfos();
+ * console.log('debugger tableList',tableList);
+ * ```
+ */
+ getSubTableInfos(): ITableInfoWithUnitId[];
+
+ /**
+ * Reset the column filter of a table
+ * @param tableId The table id
+ * @param column The column index
+ * @returns {Promise<boolean>} Whether the table filter was reset successfully
+ * @example
+ * ```typescript
+ * const fWorkbook = univerAPI.getActiveWorkbook();
+ * const fSheet = fWorkbook.getActiveSheet();
+ * const subUnitId = fSheet.getSheetId();
+ * const res = await fSheet.addTable('name-1', {
+ * startRow: 1,
+ * startColumn: 1,
+ * endRow: 10,
+ * endColumn: 5,
+ * }, 'id-1', {
+ * showHeader: true
+ * })
+ * const tableInfo = fWorkbook.getTableInfo('id-1');
+ * console.log('debugger tableInfo',tableInfo);
+ * const result = await fSheet.setTableFilter('id-1', 1, {
+ * filterType: univerAPI.Enum.TableColumnFilterTypeEnum.condition,
+ * filterInfo: {
+ * conditionType: univerAPI.Enum.TableConditionTypeEnum.Number,
+ * compareType: univerAPI.Enum.TableNumberCompareTypeEnum.GreaterThan,
+ * expectedValue: 10,
+ * }
+ * })
+ * console.log('debugger result',result);
+ * const result2 = await fSheet.resetFilter('id-1', 1);
+ * console.log('debugger result2',result2);
+ * const tableInfo2 = fWorkbook.getTableInfo('id-1');
+ * console.log('debugger tableInfo2',tableInfo2);
+ * ```
+ */
+ resetFilter(tableId: string, column: number): Promise<boolean>;
+
+ /**
+ * Get the table information by cell position
+ * @param row The row index
+ * @param column The column index
+ * @returns {ITableInfoWithUnitId | undefined} The table information or undefined if not found
+ * @example
+ * ```typescript
+ * const fWorkbook = univerAPI.getActiveWorkbook();
+ * const fSheet = fWorkbook.getActiveSheet();
+ * const subUnitId = fSheet.getSheetId();
+ * const res = await fSheet.addTable('name-1', {
+ * startRow: 1,
+ * startColumn: 1,
+ * endRow: 10,
+ * endColumn: 5,
+ * }, 'id-1', {
+ * showHeader: true
+ * })
+ * const tableInfo = fWorkbook.getTableInfo('id-1');
+ * console.log('debugger tableInfo',tableInfo);
+ * const tableInfo2 = fSheet.getTableByCell(1, 1);
+ * console.log('debugger tableInfo2',tableInfo2);
+ * ```
+ */
+ getTableByCell(row: number, column: number): ITableInfoWithUnitId | undefined;
+
+ /**
+ * Add a theme to the table
+ * @param tableId The table id
+ * @param themeStyleJSON The theme style JSON
+ * @returns {Promise<boolean>} Whether the theme was added successfully
+ * @example
+ * ```typescript
+ * const fWorkbook = univerAPI.getActiveWorkbook();
+ * const fSheet = fWorkbook.getActiveSheet();
+ * const subUnitId = fSheet.getSheetId();
+ * const res = await fSheet.addTable('name-1', {
+ * startRow: 1,
+ * startColumn: 1,
+ * endRow: 10,
+ * endColumn: 5,
+ * }, 'id-1', {
+ * showHeader: true
+ * })
+ * const tableInfo = fWorkbook.getTableInfo('id-1');
+ * console.log('debugger tableInfo', tableInfo);
+ * const result = await fSheet.addTableTheme('id-1', {
+ * name: "table-custom-1",
+ * headerRowStyle: {
+ * bd: {
+ * t: {
+ * s: 1,
+ * cl: {
+ * rgb: "rgb(95 101 116)"
+ * }
+ * }
+ * },
+ * bg: {
+ * rgb: 'rgb(255,123,65)'
+ * }
+ * },
+ * lastRowStyle: {
+ * bd: {
+ * b: {
+ * s: 1,
+ * cl: {
+ * rgb: "rgb(95 101 116)"
+ * }
+ * }
+ * }
+ * },
+ * });
+ */
+ addTableTheme(tableId: string, themeStyleJSON: IRangeThemeStyleJSON): Promise<boolean>;
}
export class FWorkSheetTableMixin extends FWorksheet implements IFWorkSheetTableMixin {
- override addTable(tableName: string, rangeInfo: ITableRange, tableId?: string, options?: ITableOptions): string {
- const sheetTableService = this._injector.get(SheetTableService);
+ override addTable(tableName: string, rangeInfo: ITableRange, tableId?: string, options?: ITableOptions): Promise<boolean> {
const subUnitId = this.getSheetId();
const unitId = this.getWorkbook().getUnitId();
- const tableManager = this._injector.get(TableManager);
- const localeService = this._injector.get(LocaleService);
- const header = tableManager.getColumnHeader(unitId, subUnitId, rangeInfo, localeService.t('sheets-table.columnPrefix'));
- return sheetTableService.addTable(unitId, subUnitId, tableName, rangeInfo, header, tableId, options);
+ const addTableParams: IAddSheetTableCommandParams = {
+ unitId,
+ subUnitId,
+ name: tableName,
+ range: rangeInfo,
+ id: tableId,
+ options,
+ };
+ return this._commandService.executeCommand(AddSheetTableCommand.id, addTableParams);
}
- override addTableFilter(tableId: string, column: number, filter: ITableFilterItem): Promise<boolean> {
+ override setTableFilter(tableId: string, column: number, filter: ITableFilterItem): Promise<boolean> {
const setTableFilterParams: ISetSheetTableParams = {
unitId: this.getWorkbook().getUnitId(),
tableId,
@@ -47,6 +324,72 @@ export class FWorkSheetTableMixin extends FWorksheet implements IFWorkSheetTable
};
return this._commandService.executeCommand(SetSheetTableFilterCommand.id, setTableFilterParams);
}
+
+ override removeTable(tableId: string): Promise<boolean> {
+ const removedTableParams: IDeleteSheetTableParams = {
+ unitId: this._fWorkbook.getId(),
+ subUnitId: this.getSheetId(),
+ tableId,
+ };
+ return this._commandService.executeCommand(DeleteSheetTableCommand.id, removedTableParams);
+ }
+
+ override setTableRange(tableId: string, rangeInfo: ITableRange): Promise<boolean> {
+ const tableSetConfig: ISetSheetTableCommandParams = {
+ unitId: this.getWorkbook().getUnitId(),
+ tableId,
+ updateRange: {
+ newRange: rangeInfo,
+ },
+ };
+ return this._commandService.executeCommand(SetSheetTableCommand.id, tableSetConfig);
+ }
+
+ override setTableName(tableId: string, tableName: string): Promise<boolean> {
+ const tableSetConfig: ISetSheetTableCommandParams = {
+ unitId: this.getWorkbook().getUnitId(),
+ tableId,
+ name: tableName,
+ };
+ return this._commandService.executeCommand(SetSheetTableCommand.id, tableSetConfig);
+ }
+
+ override getSubTableInfos(): ITableInfoWithUnitId[] {
+ const unitId = this._fWorkbook.getId();
+ const sheetTableService = this._injector.get(SheetTableService);
+ return sheetTableService.getTableList(unitId).filter((table) => table.subUnitId === this.getSheetId());
+ }
+
+ override resetFilter(tableId: string, column: number): Promise<boolean> {
+ const setTableFilterParams: ISetSheetTableParams = {
+ unitId: this._fWorkbook.getId(),
+ tableId,
+ column,
+ tableFilter: undefined,
+ };
+ return this._commandService.executeCommand(SetSheetTableFilterCommand.id, setTableFilterParams);
+ }
+
+ override getTableByCell(row: number, column: number): ITableInfoWithUnitId | undefined {
+ const unitId = this._fWorkbook.getId();
+ const sheetTableService = this._injector.get(SheetTableService);
+ const allSubTableInfos = sheetTableService.getTableList(unitId).filter((table) => table.subUnitId === this.getSheetId());
+ const cellRange = cellToRange(row, column);
+ return allSubTableInfos.find((table) => {
+ const tableRange = table.range;
+ return Rectangle.intersects(tableRange, cellRange);
+ });
+ }
+
+ override addTableTheme(tableId: string, themeStyleJSON: IRangeThemeStyleJSON): Promise<boolean> {
+ const themeStyle = new RangeThemeStyle('table-style');
+ themeStyle.fromJson(themeStyleJSON);
+ return this._commandService.executeCommand(AddTableThemeCommand.id, {
+ unitId: this._fWorkbook.getId(),
+ tableId,
+ themeStyle,
+ });
+ }
}
FWorksheet.extend(FWorkSheetTableMixin);
diff --git a/packages/sheets-table/src/facade/index.ts b/packages/sheets-table/src/facade/index.ts
index 0fedfc331e..4c5f42716e 100644
--- a/packages/sheets-table/src/facade/index.ts
+++ b/packages/sheets-table/src/facade/index.ts
@@ -16,6 +16,7 @@
import './f-workbook';
import './f-worksheet';
+import './f-enum';
export type * from './f-workbook';
export type * from './f-worksheet';