refactor: rowCells 重命名为 currentRow，避免与行头 rowCell 定义冲突 (#2032)

Co-authored-by: zishang <[email protected]>
antvis · Jan 6, 2023 · 179fa5c · 179fa5c · vercel · Jan 6, 2023
1 parent c073578
commit 179fa5c
Show file tree

Hide file tree

Showing 8 changed files with 29 additions and 29 deletions.
diff --git a/packages/s2-core/__tests__/unit/interaction/brush-selection/data-brush-selection-spec.ts b/packages/s2-core/__tests__/unit/interaction/brush-selection/data-brush-selection-spec.ts
@@ -98,8 +98,8 @@ describe('Interaction Data Cell Brush Selection Tests', () => {
     mockRootInteraction.getSelectedCellHighlight = () => ({
       rowHeader: false,
       colHeader: false,
-      rowCells: false,
-      colCells: false,
+      currentRow: false,
+      currentCol: false,
     });
     mockSpreadSheetInstance.interaction = mockRootInteraction;
     mockSpreadSheetInstance.render();
@@ -144,8 +144,8 @@ describe('Interaction Data Cell Brush Selection Tests', () => {
     mockRootInteraction.getSelectedCellHighlight = () => ({
       rowHeader: true,
       colHeader: true,
-      rowCells: false,
-      colCells: false,
+      currentRow: false,
+      currentCol: false,
     });
 
     brushSelectionInstance.getBrushRange = () => {

diff --git a/packages/s2-core/__tests__/unit/interaction/brush-selection/row-brush-selection-spec.ts b/packages/s2-core/__tests__/unit/interaction/brush-selection/row-brush-selection-spec.ts
@@ -227,7 +227,7 @@ describe('Interaction Row Cell Brush Selection Tests', () => {
         },
       },
     });
-    const rowCells = map(new Array(8), (a, i) => {
+    const currentRow = map(new Array(8), (a, i) => {
       const customY = 30 * i + 30;
 
       return {
@@ -244,7 +244,7 @@ describe('Interaction Row Cell Brush Selection Tests', () => {
       } as RowCell;
     });
 
-    mockRootInteraction.getAllRowHeaderCells = () => rowCells;
+    mockRootInteraction.getAllRowHeaderCells = () => currentRow;
     mockSpreadSheetInstance.interaction = mockRootInteraction;
     mockSpreadSheetInstance.facet.setScrollOffset({
       hRowScrollX: 100,
@@ -277,7 +277,7 @@ describe('Interaction Row Cell Brush Selection Tests', () => {
     );
     // get brush range selected cells
     expect(brushSelectionInstance.brushRangeCells).toHaveLength(
-      rowCells.length / 2,
+      currentRow.length / 2,
     );
   });
 });
diff --git a/packages/s2-core/__tests__/unit/utils/export/copy-spec.ts b/packages/s2-core/__tests__/unit/utils/export/copy-spec.ts
@@ -313,7 +313,7 @@ describe('List Table Core Data Process', () => {
     s2.setOptions({
       interaction: {
         selectedCellHighlight: {
-          rowCells: true,
+          currentRow: true,
         },
       },
     });

diff --git a/packages/s2-core/src/common/constant/interaction.ts b/packages/s2-core/src/common/constant/interaction.ts
@@ -116,6 +116,6 @@ export enum ScrollDirection {
 export interface InteractionCellSelectedHighlightType {
   rowHeader?: boolean; // 高亮行头
   colHeader?: boolean; // 高亮列头
-  rowCells?: boolean; // 高亮选中单元格所在行
-  colCells?: boolean; // 高亮选中单元格所在列
+  currentRow?: boolean; // 高亮选中单元格所在行
+  currentCol?: boolean; // 高亮选中单元格所在列
 }
diff --git a/packages/s2-core/src/interaction/root.ts b/packages/s2-core/src/interaction/root.ts
@@ -576,23 +576,23 @@ export class RootInteraction {
       return {
         rowHeader: selectedCellHighlight,
         colHeader: selectedCellHighlight,
-        rowCells: false,
-        colCells: false,
+        currentRow: false,
+        currentCol: false,
       };
     }
 
     const {
       rowHeader = false,
       colHeader = false,
-      rowCells = false,
-      colCells = false,
+      currentRow = false,
+      currentCol = false,
     } = selectedCellHighlight ?? {};
 
     return {
       rowHeader,
       colHeader,
-      rowCells,
-      colCells,
+      currentRow,
+      currentCol,
     };
   }
 }
diff --git a/packages/s2-core/src/utils/cell/data-cell.ts b/packages/s2-core/src/utils/cell/data-cell.ts
@@ -43,9 +43,9 @@ export const getDataCellId = (rowIndex: string, colIndex: string) => {
 };
 
 export const shouldUpdateBySelectedCellsHighlight = (s2: SpreadSheet) => {
-  const { rowCells, colCells, rowHeader, colHeader } =
+  const { currentRow, currentCol, rowHeader, colHeader } =
     s2.interaction.getSelectedCellHighlight();
-  return rowCells || colCells || rowHeader || colHeader;
+  return currentRow || currentCol || rowHeader || colHeader;
 };
 
 export const isDataCell = (cell: CellMeta) => {
@@ -109,18 +109,18 @@ export const updateBySelectedCellsHighlight = (
   dataCell: DataCell,
   s2: SpreadSheet,
 ) => {
-  const { rowHeader, colHeader, rowCells, colCells } =
+  const { rowHeader, colHeader, currentRow, currentCol } =
     s2.interaction.getSelectedCellHighlight();
 
   const isRowCell = dataCell.cellType === CellTypes.ROW_CELL;
   // 高亮序号
   const showSNWhenRowHeaderHighlight =
     s2.isTableMode() && s2.options.showSeriesNumber && rowHeader && isRowCell;
 
-  if (rowCells || showSNWhenRowHeaderHighlight) {
+  if (currentRow || showSNWhenRowHeaderHighlight) {
     updateCurrentRowCellState(cells, dataCell);
   }
-  if (colCells) {
+  if (currentCol) {
     updateCurrentColumnCellState(cells, dataCell);
   }
   if (rowHeader || colHeader) {

diff --git a/packages/s2-core/src/utils/export/copy.ts b/packages/s2-core/src/utils/export/copy.ts
@@ -735,9 +735,9 @@ function getDataCellCopyable(
     }
     // normal selected
     const selectedCellsMeta = getSelectedCellsMeta(cells);
-    const { rowCells } = spreadsheet.interaction.getSelectedCellHighlight();
+    const { currentRow } = spreadsheet.interaction.getSelectedCellHighlight();
 
-    if (rowCells) {
+    if (currentRow) {
       const rowData = orderBy(cells, 'rowIndex', 'asc').map((cell) =>
         spreadsheet.dataSet.getRowData(cell),
       );

diff --git a/packages/s2-react/playground/index.tsx b/packages/s2-react/playground/index.tsx
@@ -882,8 +882,8 @@ function MainLayout() {
                         selectedCellHighlight = {
                           rowHeader: false,
                           colHeader: false,
-                          rowCells: false,
-                          colCells: false,
+                          currentCol: false,
+                          currentRow: false,
                         };
                         type.forEach((i) => {
                           selectedCellHighlight[i] = true;
@@ -906,11 +906,11 @@ function MainLayout() {
                     <Select.Option value="colHeader">
                       colHeader: 高亮所在列头
                     </Select.Option>
-                    <Select.Option value="rowCells">
-                      rowCells: 高亮所在行
+                    <Select.Option value="currentRow">
+                      currentRow: 高亮所在行
                     </Select.Option>
-                    <Select.Option value="colCells">
-                      colCells: 高亮所在列
+                    <Select.Option value="currentCol">
+                      currentCol: 高亮所在列
                     </Select.Option>
                   </Select>
                 </Tooltip>