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.

fix(table): fix sheets-table facade api (#5812)

wpxp123456a11d207423f3
diff --git a/packages/sheets-table-ui/src/locale/ca-ES.ts b/packages/sheets-table-ui/src/locale/ca-ES.ts
index 64e424bbf7..c1e8758d66 100644
--- a/packages/sheets-table-ui/src/locale/ca-ES.ts
+++ b/packages/sheets-table-ui/src/locale/ca-ES.ts
@@ -130,6 +130,15 @@ const locale: typeof enUS = {
m12: 'Desembre',
},
},
+ filter: {
+ 'by-values': 'Per valors',
+ 'by-conditions': 'Per condicions',
+ 'clear-filter': 'Neteja el filtre',
+ cancel: 'Cancel·la',
+ confirm: 'Confirma',
+ 'search-placeholder': 'Utilitza espai per separar paraules clau',
+ 'select-all': 'Selecciona-ho tot',
+ },
},
};
diff --git a/packages/sheets-table-ui/src/locale/en-US.ts b/packages/sheets-table-ui/src/locale/en-US.ts
index 608859ab5f..8b33366b5c 100644
--- a/packages/sheets-table-ui/src/locale/en-US.ts
+++ b/packages/sheets-table-ui/src/locale/en-US.ts
@@ -128,6 +128,15 @@ const locale = {
m12: 'December',
},
},
+ filter: {
+ 'by-values': 'By Values',
+ 'by-conditions': 'By Conditions',
+ 'clear-filter': 'Clear Filter',
+ cancel: 'Cancel',
+ confirm: 'Confirm',
+ 'search-placeholder': 'Use space to separate keywords',
+ 'select-all': 'Select All',
+ },
},
};
diff --git a/packages/sheets-table-ui/src/locale/es-ES.ts b/packages/sheets-table-ui/src/locale/es-ES.ts
index f157e20720..da62fb0785 100644
--- a/packages/sheets-table-ui/src/locale/es-ES.ts
+++ b/packages/sheets-table-ui/src/locale/es-ES.ts
@@ -130,6 +130,15 @@ const locale: typeof enUS = {
m12: 'Diciembre',
},
},
+ filter: {
+ 'by-values': 'Por valores',
+ 'by-conditions': 'Por condiciones',
+ 'clear-filter': 'Borrar filtro',
+ cancel: 'Cancelar',
+ confirm: 'Confirmar',
+ 'search-placeholder': 'Usa espacio para separar palabras clave',
+ 'select-all': 'Seleccionar todo',
+ },
},
};
diff --git a/packages/sheets-table-ui/src/locale/fa-IR.ts b/packages/sheets-table-ui/src/locale/fa-IR.ts
index 6cc03cd4c3..d92fdcca98 100644
--- a/packages/sheets-table-ui/src/locale/fa-IR.ts
+++ b/packages/sheets-table-ui/src/locale/fa-IR.ts
@@ -132,6 +132,15 @@ const locale: typeof enUS = {
m12: 'دسامبر',
},
},
+ filter: {
+ 'by-values': 'بر اساس مقادیر',
+ 'by-conditions': 'بر اساس شرایط',
+ 'clear-filter': 'پاک کردن فیلتر',
+ cancel: 'انصراف',
+ confirm: 'تایید',
+ 'search-placeholder': 'برای جداسازی کلیدواژه‌ها از فاصله استفاده کنید',
+ 'select-all': 'انتخاب همه',
+ },
},
};
diff --git a/packages/sheets-table-ui/src/locale/fr-FR.ts b/packages/sheets-table-ui/src/locale/fr-FR.ts
index 56154c5da4..f574d79bbb 100644
--- a/packages/sheets-table-ui/src/locale/fr-FR.ts
+++ b/packages/sheets-table-ui/src/locale/fr-FR.ts
@@ -131,6 +131,15 @@ const locale: typeof enUS = {
m12: 'Décembre',
},
},
+ filter: {
+ 'by-values': 'Par valeurs',
+ 'by-conditions': 'Par conditions',
+ 'clear-filter': 'Effacer le filtre',
+ cancel: 'Annuler',
+ confirm: 'Confirmer',
+ 'search-placeholder': 'Utilisez un espace pour séparer les mots-clés',
+ 'select-all': 'Tout sélectionner',
+ },
},
};
diff --git a/packages/sheets-table-ui/src/locale/ko-KR.ts b/packages/sheets-table-ui/src/locale/ko-KR.ts
index bd16ad0f8c..4644401fac 100644
--- a/packages/sheets-table-ui/src/locale/ko-KR.ts
+++ b/packages/sheets-table-ui/src/locale/ko-KR.ts
@@ -130,6 +130,15 @@ const locale: typeof enUS = {
m12: '12월',
},
},
+ filter: {
+ 'by-values': '값으로 필터',
+ 'by-conditions': '조건으로 필터',
+ 'clear-filter': '필터 지우기',
+ cancel: '취소',
+ confirm: '확인',
+ 'search-placeholder': '검색어는 공백으로 구분',
+ 'select-all': '전체 선택',
+ },
},
};
diff --git a/packages/sheets-table-ui/src/locale/ru-RU.ts b/packages/sheets-table-ui/src/locale/ru-RU.ts
index 43fac5a98b..ab4ccc6baf 100644
--- a/packages/sheets-table-ui/src/locale/ru-RU.ts
+++ b/packages/sheets-table-ui/src/locale/ru-RU.ts
@@ -132,6 +132,15 @@ const locale: typeof enUS = {
m12: 'Декабрь',
},
},
+ filter: {
+ 'by-values': 'По значениям',
+ 'by-conditions': 'По условиям',
+ 'clear-filter': 'Очистить фильтр',
+ cancel: 'Отмена',
+ confirm: 'Подтвердить',
+ 'search-placeholder': 'Используйте пробел для разделения ключевых слов',
+ 'select-all': 'Выбрать все',
+ },
},
};
diff --git a/packages/sheets-table-ui/src/locale/vi-VN.ts b/packages/sheets-table-ui/src/locale/vi-VN.ts
index 4ea4f52ecd..d514962bea 100644
--- a/packages/sheets-table-ui/src/locale/vi-VN.ts
+++ b/packages/sheets-table-ui/src/locale/vi-VN.ts
@@ -132,6 +132,15 @@ const locale: typeof enUS = {
m12: 'Tháng 12',
},
},
+ filter: {
+ 'by-values': 'Theo giá trị',
+ 'by-conditions': 'Theo điều kiện',
+ 'clear-filter': 'Xóa lọc',
+ cancel: 'Hủy bỏ',
+ confirm: 'Xác nhận',
+ 'search-placeholder': 'Sử dụng khoảng trắng để tách các từ khóa',
+ 'select-all': 'Chọn tất cả',
+ },
},
};
diff --git a/packages/sheets-table-ui/src/locale/zh-CN.ts b/packages/sheets-table-ui/src/locale/zh-CN.ts
index 514d7325c8..b0876f3ab4 100644
--- a/packages/sheets-table-ui/src/locale/zh-CN.ts
+++ b/packages/sheets-table-ui/src/locale/zh-CN.ts
@@ -133,7 +133,15 @@ const locale: typeof enUS = {
m12: '十二月',
},
},
-
+ filter: {
+ 'by-values': '按值',
+ 'by-conditions': '按条件',
+ 'clear-filter': '清除筛选',
+ cancel: '取消',
+ confirm: '确认',
+ 'search-placeholder': '使用空格分隔关键字',
+ 'select-all': '全选',
+ },
},
};
diff --git a/packages/sheets-table-ui/src/locale/zh-TW.ts b/packages/sheets-table-ui/src/locale/zh-TW.ts
index 9a9125b4a1..a94d1234b8 100644
--- a/packages/sheets-table-ui/src/locale/zh-TW.ts
+++ b/packages/sheets-table-ui/src/locale/zh-TW.ts
@@ -132,6 +132,15 @@ const locale: typeof enUS = {
m12: '十二月',
},
},
+ filter: {
+ 'by-values': '按值',
+ 'by-conditions': '按條件',
+ 'clear-filter': '清除篩選',
+ cancel: '取消',
+ confirm: '確認',
+ 'search-placeholder': '使用空格分隔關鍵字',
+ 'select-all': '全選',
+ },
},
};
diff --git a/packages/sheets-table-ui/src/views/components/SheetTableFilterPanel.tsx b/packages/sheets-table-ui/src/views/components/SheetTableFilterPanel.tsx
index 69c290ea2e..2f58fd20ec 100644
--- a/packages/sheets-table-ui/src/views/components/SheetTableFilterPanel.tsx
+++ b/packages/sheets-table-ui/src/views/components/SheetTableFilterPanel.tsx
@@ -209,11 +209,11 @@ export function SheetTableFilterPanel() {
disabled={tableFilter === undefined}
onClick={onClearFilter}
>
- {localeService.t('sheets-filter.panel.clear-filter')}
+ {localeService.t('sheets-table.filter.clear-filter')}
</Button>
<div>
- <Button className="univer-mr-2" onClick={onCancel}>{localeService.t('sheets-filter.panel.cancel')}</Button>
- <Button variant="primary" onClick={onApply}>{localeService.t('sheets-filter.panel.confirm')}</Button>
+ <Button className="univer-mr-2" onClick={onCancel}>{localeService.t('sheets-table.filter.cancel')}</Button>
+ <Button variant="primary" onClick={onApply}>{localeService.t('sheets-table.filter.confirm')}</Button>
</div>
</div>
</div>
@@ -223,7 +223,7 @@ export function SheetTableFilterPanel() {
function useFilterByOptions(localeService: LocaleService) {
const locale = localeService.getCurrentLocale();
return useMemo(() => [
- { label: localeService.t('sheets-filter.panel.by-values'), value: FilterByEnum.Items },
- { label: localeService.t('sheets-filter.panel.by-conditions'), value: FilterByEnum.Condition },
+ { label: localeService.t('sheets-table.filter.by-values'), value: FilterByEnum.Items },
+ { label: localeService.t('sheets-table.filter.by-conditions'), value: FilterByEnum.Condition },
], [locale, localeService]);
}
diff --git a/packages/sheets-table-ui/src/views/components/SheetTableItemsFilterPanel.tsx b/packages/sheets-table-ui/src/views/components/SheetTableItemsFilterPanel.tsx
index 98a7009389..e4f5adbb95 100644
--- a/packages/sheets-table-ui/src/views/components/SheetTableItemsFilterPanel.tsx
+++ b/packages/sheets-table-ui/src/views/components/SheetTableItemsFilterPanel.tsx
@@ -117,7 +117,7 @@ export function SheetTableItemsFilterPanel(props: ISheetTableItemsFilterPanelPro
return (
<div className="univer-flex univer-h-full univer-flex-col">
- <Input autoFocus value={searchText} placeholder={localeService.t('sheets-filter.panel.search-placeholder')} onChange={onSearchValueChange} />
+ <Input autoFocus value={searchText} placeholder={localeService.t('sheets-table.filter.search-placeholder')} onChange={onSearchValueChange} />
<div
className={clsx(`
univer-mt-2 univer-box-border univer-flex univer-h-[180px] univer-max-h-[180px] univer-flex-grow
@@ -136,7 +136,7 @@ export function SheetTableItemsFilterPanel(props: ISheetTableItemsFilterPanelPro
onChange={onCheckAllToggled}
>
<div className="univer-flex univer-h-5 univer-flex-1 univer-items-center univer-text-sm">
- <span className="univer-inline-block univer-truncate">{`${localeService.t('sheets-filter.panel.select-all')}`}</span>
+ <span className="univer-inline-block univer-truncate">{`${localeService.t('sheets-table.filter.select-all')}`}</span>
<span className="univer-ml univer-text-gray-400">{`(${checkedCount}/${searchText ? displayItems.length : allItemsCount})`}</span>
</div>
</Checkbox>
diff --git a/packages/sheets-table/src/controllers/config.schema.ts b/packages/sheets-table/src/controllers/config.schema.ts
index ffcbe2fa06..fe10e4448d 100644
--- a/packages/sheets-table/src/controllers/config.schema.ts
+++ b/packages/sheets-table/src/controllers/config.schema.ts
@@ -24,7 +24,7 @@ export interface ITableDefaultThemeStyle {
export const tableDefaultBorderStyle = {
s: BorderStyleTypes.THIN,
cl: {
- rgb: 'rgb(95 101 116)',
+ rgb: 'rgb(95, 101, 116)',
},
};
diff --git a/packages/sheets-table/src/controllers/sheet-table-theme.controller.ts b/packages/sheets-table/src/controllers/sheet-table-theme.controller.ts
index c2ccfd7149..ebf297b270 100644
--- a/packages/sheets-table/src/controllers/sheet-table-theme.controller.ts
+++ b/packages/sheets-table/src/controllers/sheet-table-theme.controller.ts
@@ -42,11 +42,12 @@ export class SheetsTableThemeController extends Disposable {
registerTableChangeEvent() {
this.disposeWithMe(
this._tableManager.tableAdd$.subscribe((event) => {
- const { range, tableId, unitId, subUnitId } = event;
+ const { range, tableId, unitId, subUnitId, tableStyleId } = event;
const table = this._tableManager.getTable(unitId, tableId)!;
- const tableStyleId = this._allThemes[this._defaultThemeIndex].name;
- table.setTableStyleId(tableStyleId);
- this._sheetRangeThemeService.registerRangeThemeStyle(tableStyleId, {
+ // If the tableStyleId is not set or is empty string, use the default theme
+ const _tableStyleId = tableStyleId || this._allThemes[this._defaultThemeIndex].name;
+ table.setTableStyleId(_tableStyleId);
+ this._sheetRangeThemeService.registerRangeThemeStyle(_tableStyleId, {
unitId,
subUnitId,
range: { ...range },
diff --git a/packages/sheets-table/src/facade/f-workbook.ts b/packages/sheets-table/src/facade/f-workbook.ts
index c8f8b6578c..4e2bdbdf5c 100644
--- a/packages/sheets-table/src/facade/f-workbook.ts
+++ b/packages/sheets-table/src/facade/f-workbook.ts
@@ -40,7 +40,7 @@ export interface IFWorkbookSheetsTableMixin {
* fRange.getRange(),
* 'id-1',
* {
- * showHeader: true,
+ * tableStyleId: 'table-default-4',
* }
* );
*
@@ -68,7 +68,7 @@ export interface IFWorkbookSheetsTableMixin {
* fRange.getRange(),
* 'id-1',
* {
- * showHeader: true,
+ * tableStyleId: 'table-default-4',
* }
* );
*
@@ -113,7 +113,7 @@ export interface IFWorkbookSheetsTableMixin {
* fRange.getRange(),
* 'id-1',
* {
- * showHeader: true,
+ * tableStyleId: 'table-default-4',
* }
* );
*
@@ -143,7 +143,7 @@ export interface IFWorkbookSheetsTableMixin {
* fRange.getRange(),
* 'id-1',
* {
- * showHeader: true,
+ * tableStyleId: 'table-default-4',
* }
* );
*
diff --git a/packages/sheets-table/src/facade/f-worksheet.ts b/packages/sheets-table/src/facade/f-worksheet.ts
index 7c05819a2c..6f7db2b8bc 100644
--- a/packages/sheets-table/src/facade/f-worksheet.ts
+++ b/packages/sheets-table/src/facade/f-worksheet.ts
@@ -60,7 +60,20 @@ export interface IFWorkSheetTableMixin {
* fRange.getRange(),
* 'id-1',
* {
- * showHeader: true,
+ * tableStyleId: 'table-default-4',
+ * columns: [
+ * { id: 'col-1', displayName: 'Column 1' }
+ * ],
+ * filters: [
+ * {
+ * filterType: univerAPI.Enum.TableColumnFilterTypeEnum.condition,
+ * filterInfo: {
+ * conditionType: univerAPI.Enum.TableConditionTypeEnum.Number,
+ * compareType: univerAPI.Enum.TableNumberCompareTypeEnum.GreaterThan,
+ * expectedValue: 2,
+ * }
+ * }
+ * ]
* }
* );
*
@@ -90,7 +103,7 @@ export interface IFWorkSheetTableMixin {
* fRange.getRange(),
* 'id-1',
* {
- * showHeader: true,
+ * tableStyleId: 'table-default-4',
* }
* );
*
@@ -148,7 +161,7 @@ export interface IFWorkSheetTableMixin {
* fRange.getRange(),
* 'id-1',
* {
- * showHeader: true,
+ * tableStyleId: 'table-default-4',
* }
* );
*
@@ -183,7 +196,7 @@ export interface IFWorkSheetTableMixin {
* fRange.getRange(),
* 'id-1',
* {
- * showHeader: true,
+ * tableStyleId: 'table-default-4',
* }
* );
*
@@ -230,7 +243,7 @@ export interface IFWorkSheetTableMixin {
* fRange.getRange(),
* 'id-1',
* {
- * showHeader: true,
+ * tableStyleId: 'table-default-4',
* }
* );
*
@@ -279,7 +292,7 @@ export interface IFWorkSheetTableMixin {
* fRange.getRange(),
* 'id-1',
* {
- * showHeader: true,
+ * tableStyleId: 'table-default-4',
* }
* );
* console.log('debugger tableInfo2', fWorksheet.getTableByCell(row, column));
@@ -304,7 +317,7 @@ export interface IFWorkSheetTableMixin {
* fRange.getRange(),
* 'id-1',
* {
- * showHeader: true,
+ * tableStyleId: 'table-default-4',
* }
* );
*
diff --git a/packages/sheets-table/src/model/table-manager.ts b/packages/sheets-table/src/model/table-manager.ts
index 9407855e35..5efd2e9e63 100644
--- a/packages/sheets-table/src/model/table-manager.ts
+++ b/packages/sheets-table/src/model/table-manager.ts
@@ -98,6 +98,7 @@ export class TableManager extends Disposable {
range,
tableName: name,
tableId: id,
+ tableStyleId: options?.tableStyleId,
});
return id;
diff --git a/packages/sheets-table/src/model/table.ts b/packages/sheets-table/src/model/table.ts
index 269ce0d6b6..e45322d080 100644
--- a/packages/sheets-table/src/model/table.ts
+++ b/packages/sheets-table/src/model/table.ts
@@ -51,25 +51,27 @@ export class Table {
// Summarization is not supported yet. Footer is not displayed yet.
this._showFooter = false;
// init table columns
- if (options.columns) {
- options.columns.forEach((column) => {
- const id = column.id || generateRandomId();
- const tableColumn = new TableColumn(id, column.displayName);
- tableColumn.fromJSON(column);
- this._columns.set(id, tableColumn);
- this._columnOrder.push(id);
- });
- } else {
- const range = this.getRange();
- const startColumn = range.startColumn;
- const endColumn = range.endColumn;
- for (let i = startColumn; i <= endColumn; i++) {
- const id = generateRandomId();
-
- const column = new TableColumn(id, header[i - startColumn]);
- this._columns.set(id, column);
- this._columnOrder.push(id);
+ const range = this.getRange();
+ const startColumn = range.startColumn;
+ const endColumn = range.endColumn;
+
+ for (let i = startColumn; i <= endColumn; i++) {
+ const index = i - startColumn;
+
+ let id;
+ let columnName;
+
+ if (options.columns?.[index]) {
+ id = options.columns[index].id;
+ columnName = options.columns[index].displayName;
+ } else {
+ id = generateRandomId();
+ columnName = header[i - startColumn];
}
+
+ const column = new TableColumn(id, columnName);
+ this._columns.set(id, column);
+ this._columnOrder.push(id);
}
// this._tableFilters = new TableFilters();
@@ -269,8 +271,8 @@ export class Table {
this._range = json.range;
this.tableMeta = json.meta;
this._tableStyleId = json.options.tableStyleId || '';
- this._showHeader = json.options.showHeader || true;
- this._showFooter = json.options.showFooter || true;
+ this._showHeader = json.options.showHeader ?? true;
+ this._showFooter = json.options.showFooter ?? true;
const columns = json.columns;
columns.forEach((column) => {
const tableColumn = new TableColumn(column.id, column.displayName);
diff --git a/packages/sheets-table/src/types/type.ts b/packages/sheets-table/src/types/type.ts
index 944e926528..8d1ec946ed 100644
--- a/packages/sheets-table/src/types/type.ts
+++ b/packages/sheets-table/src/types/type.ts
@@ -25,11 +25,33 @@ export interface ITableRange {
}
export interface ITableOptions {
+ /**
+ * Whether to show the header row.
+ * @todo not support yet
+ */
showHeader?: boolean;
+ /**
+ * Whether to show the footer row.
+ * @todo not support yet
+ */
showFooter?: boolean;
+ /**
+ * The table style id. If the property is empty, the default style will be used.
+ * @default: table-default-0 ~ table-default-5
+ */
tableStyleId?: string;
+ /**
+ * The total number of rows in the table.
+ * @todo not support yet
+ */
hasTotalRow?: boolean;
+ /**
+ * The columns of the table. If not provided, default columns will be generated based on the range.
+ */
columns?: ITableColumnJson[];
+ /**
+ * The column filters of the table.
+ */
filters?: ITableFilterItem[];
}
@@ -90,6 +112,7 @@ export interface ITableAddedEvent {
tableId: string;
tableName: string;
range: ITableRange;
+ tableStyleId?: string;
}
export interface ITableRangeUpdate {