@univerjs/core 0.1.0-beta.3 → 0.1.0-beta.5

package/lib/types/types/interfaces/i-worksheet-data.d.ts

@@ -14,27 +14,25 @@
  * limitations under the License.
  */
 import type { IObjectArrayPrimitiveType, IObjectMatrixPrimitiveType } from '../../shared/object-matrix';
-import type { IKeyValue } from '../../shared/types';
-import type { BooleanNumber, SheetTypes } from '../enum';
+import type { BooleanNumber } from '../enum';
 import type { ICellData } from './i-cell-data';
 import type { IColumnData } from './i-column-data';
 import type { IFreeze } from './i-freeze';
 import type { IRange, IRangeType } from './i-range';
 import type { IRowData } from './i-row-data';
 /**
- * Properties of a worksheet's configuration
- *
- * TODO: 考虑将非通用配置，抽离到插件
- *
- * 比如 showGridlines 是sheet特有的，而如果实现如普通表格，就不需要 showGridlines
+ * Snapshot of a worksheet.
  */
 export interface IWorksheetData {
-    type: SheetTypes;
+    /**
+     * Id of the worksheet. This should be unique and immutable across the lifecycle of the worksheet.
+     */
     id: string;
+    /** Name of the sheet. */
     name: string;
     tabColor: string;
     /**
-     * Determine whether the sheet is hidden
+     * Determine whether the sheet is hidden.
      *
      * @remarks
      * See {@link BooleanNumber| the BooleanNumber enum} for more details.
@@ -43,9 +41,6 @@ export interface IWorksheetData {
      */
     hidden: BooleanNumber;
     freeze: IFreeze;
-    /**
-     * row and column  count in worksheet, not like excel, it is unlimited
-     */
     rowCount: number;
     columnCount: number;
     zoomRatio: number;
@@ -53,18 +48,12 @@ export interface IWorksheetData {
     scrollLeft: number;
     defaultColumnWidth: number;
     defaultRowHeight: number;
+    /** All merged cells in this worksheet. */
     mergeData: IRange[];
-    hideRow: [];
-    hideColumn: [];
-    /**
-     * If the worksheet is the active one.
-     * @deprecated this should be removed
-     */
-    status: BooleanNumber;
+    /** A matrix storing cell contents by row and column index. */
     cellData: IObjectMatrixPrimitiveType<ICellData>;
     rowData: IObjectArrayPrimitiveType<Partial<IRowData>>;
     columnData: IObjectArrayPrimitiveType<Partial<IColumnData>>;
-    showGridlines: BooleanNumber;
     rowHeader: {
         width: number;
         hidden?: BooleanNumber;
@@ -73,7 +62,8 @@ export interface IWorksheetData {
         height: number;
         hidden?: BooleanNumber;
     };
+    showGridlines: BooleanNumber;
+    /** @deprecated */
     selections: IRangeType[];
     rightToLeft: BooleanNumber;
-    pluginMeta: IKeyValue;
 }