Skip to content

Commit

Permalink
fix(interaction): 修复隐藏列头配置更新时未覆盖上一次的配置 close #2495
Browse files Browse the repository at this point in the history
  • Loading branch information
@lijinke666
lijinke666 committed Jan 22, 2024
1 parent c772c2a commit 01be44b
Show file tree
Hide file tree
Showing 7 changed files with 76 additions and 8 deletions.
52 changes: 52 additions & 0 deletions packages/s2-core/__tests__/spreadsheet/hidden-columns-spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,58 @@ describe('SpreadSheet Hidden Columns Tests', () => {
expect(costDetail.hideColumnNodes).toHaveLength(1);
expect(costDetail.hideColumnNodes[0].field).toEqual('cost');
});

// https://github.com/antvis/S2/issues/2495
test('should overwrite latest hidden columns detail', () => {
const hiddenColumns = ['province', 'city'];
const sheet = new TableSheet(getContainer(), mockTableDataConfig, {
...s2Options,
interaction: {
hiddenColumnFields: hiddenColumns,
},
});
sheet.render();

sheet.setOptions({
interaction: {
hiddenColumnFields: ['city'],
},
});

sheet.render(false);

const hiddenColumnsDetail = sheet.store.get('hiddenColumnsDetail', []);
const [cityDetail] = hiddenColumnsDetail;

expect(sheet.options.interaction.hiddenColumnFields).toEqual(['city']);
expect(hiddenColumnsDetail).toHaveLength(1);
expect(cityDetail.hideColumnNodes).toHaveLength(1);
expect(cityDetail.hideColumnNodes[0].field).toEqual('city');
});

test('should clear hidden columns detail if hiddenColumnFields is empty', () => {
const hiddenColumns = ['province', 'city'];
const sheet = new TableSheet(getContainer(), mockTableDataConfig, {
...s2Options,
interaction: {
hiddenColumnFields: hiddenColumns,
},
});
sheet.render();

sheet.setOptions({
interaction: {
hiddenColumnFields: [],
},
});

sheet.render(false);

const hiddenColumnsDetail = sheet.store.get('hiddenColumnsDetail', []);

expect(sheet.options.interaction.hiddenColumnFields).toBeEmpty();
expect(hiddenColumnsDetail).toBeEmpty();
});
});

describe('PivotSheet', () => {
Expand Down
2 changes: 1 addition & 1 deletion packages/s2-core/__tests__/unit/sheet-type/pivot-sheet-spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -657,7 +657,7 @@ describe('PivotSheet Tests', () => {
test('should clear init column nodes', () => {
s2.store.set('initColumnLeafNodes', [null, null]);

s2.clearColumnLeafNodes();
s2.clearInitColumnLeafNodes();

expect(s2.store.get('initColumnLeafNodes')).toBeFalsy();
});
Expand Down
15 changes: 15 additions & 0 deletions packages/s2-core/src/sheet-type/spread-sheet.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -394,6 +394,14 @@ export abstract class SpreadSheet extends EE {
this.initTooltip();
}

/**
* 配置都是 merge 操作, 但是隐藏列配置比较特殊, 变更时, 应该是全量覆盖, 而不应该是合并
* https://github.com/antvis/S2/issues/2495
*/
if (!isEmpty(this.options.interaction?.hiddenColumnFields)) {
this.store.set('hiddenColumnsDetail', []);
}

this.registerIcons();
}

Expand Down Expand Up @@ -689,7 +697,14 @@ export abstract class SpreadSheet extends EE {
return this.store.get('initColumnLeafNodes', []);
}

/**
* @deprecated 已废弃, 请使用 clearInitColumnLeafNodes
*/
public clearColumnLeafNodes() {
this.clearInitColumnLeafNodes();
}

public clearInitColumnLeafNodes() {
this.store.set('initColumnLeafNodes', undefined);
}

Expand Down
4 changes: 2 additions & 2 deletions packages/s2-react/src/hooks/useSpreadSheet.ts
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { PivotSheet, SpreadSheet, TableSheet } from '@antv/s2';
import type { S2DataConfig, S2Options, ThemeCfg } from '@antv/s2';
import { useUpdate, useUpdateEffect } from 'ahooks';
import { identity } from 'lodash';
import { identity, isEmpty } from 'lodash';
import React from 'react';
import type {
SheetComponentOptions,
Expand Down Expand Up @@ -94,7 +94,7 @@ export function useSpreadSheet(props: SheetComponentsProps) {
prevDataCfg?.fields?.columns?.length !==
dataCfg?.fields?.columns?.length
) {
s2Ref.current?.clearColumnLeafNodes();
s2Ref.current?.clearInitColumnLeafNodes();
}

reloadData = true;
Expand Down
2 changes: 1 addition & 1 deletion packages/s2-vue/src/hooks/useSheetUpdate.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ export const useSheetUpdate = (
prevDataCfg?.fields?.columns?.length !==
dataCfg?.fields?.columns?.length
) {
s2Ref.value?.clearColumnLeafNodes();
s2Ref.value?.clearInitColumnLeafNodes();
}
updateFlag.rerender = true;
updateFlag.reloadData = true;
Expand Down
2 changes: 1 addition & 1 deletion s2-site/docs/api/basic-class/spreadsheet.en.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ s2.xx()
| getTotalsConfig | Get Total Subtotal Configuration | (dimension: string) => [Total](/docs/api/general/S2Options#totals) | |
| getInitColumnLeafNodes | Get the leaf node of the column header for the first rendering (for example: before hiding the column header) | () => [Node\[\]](/docs/api/basic-class/node/) | |
| getCanvasElement | Get the `<canvas/>` HTML element corresponding to the table | () => [HTMLCanvasElement](https://developer.mozilla.org/zh-CN/docs/Web/API/HTMLCanvasElement) | |
| clearColumnLeafNodes | Clear the initial leaf nodes stored in the store | () => void | |
| clearInitColumnLeafNodes | Clear the initial leaf nodes stored in the store | () => void | |
| updateSortMethodMap | Update the node sorting method map stored in the store, replace is whether to overwrite the last value | (nodeId: string, sortMethod: string, replace?: boolean) => void | |
| getMenuDefaultSelectedKeys | Get the key value of the menu item selected in the tooltip | `(nodeId: string) => string[]` | |
| measureText | Get the measurement information of the text in the canvas | (text: `string` , font: [TextTheme](/docs/api/general/S2Theme#texttheme) ) => [TextMetrics](https://developer.mozilla.org/zh-CN/docs/Web/API/TextMetrics) \| `null` | |
Expand Down
7 changes: 4 additions & 3 deletions s2-site/docs/api/basic-class/spreadsheet.zh.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ s2.isPivotMode()
| hideTooltip | 隐藏 tooltip | `() => void` | |
| destroyTooltip | 销毁 tooltip | `() => void` | |
| registerIcons | 注册 自定义 svg 图标 （根据 `options.customSVGIcons`) | `() => void` | |
| setDataCfg | 更新数据配置 | `<T extends boolean = false>(dataCfg: T extends true ?` [`S2DataConfig`](/docs/api/general/S2DataConfig) `: Partial<`[`S2DataConfig`](/docs/api/general/S2DataConfig)`>, reset?: T) => void` | `reset` 参数需在 `@antv/s2-v1.34.0`版本使用 |
| setOptions | 更新表格配置 | (options: [S2Options](/docs/api/general/S2Options), reset?: boolean) => void | `reset` 参数需在 `@antv/s2-v1.34.0`版本使用 |
| setDataCfg | 更新数据配置 | `<T extends boolean = false>(dataCfg: T extends true ?` [`S2DataConfig`](/docs/api/general/S2DataConfig) `: Partial<`[`S2DataConfig`](/docs/api/general/S2DataConfig)`>, reset?: T) => void` | `reset` 参数需在 `@antv/s2@^1.34.0`版本使用 |
| setOptions | 更新表格配置 | (options: [S2Options](/docs/api/general/S2Options), reset?: boolean) => void | `reset` 参数需在 `@antv/s2@^1.34.0`版本使用 |
| render | 重新渲染表格，如果 `reloadData` = true, 则会重新计算数据，`reBuildDataSet` = true, 重新构建数据集，`reBuildHiddenColumnsDetail` = true 重新构建隐藏列信息 | `(reloadData?: boolean, { reBuildDataSet?: boolean; reBuildHiddenColumnsDetail?: boolean }) => void` | |
| destroy | 销毁表格 | `() => void` | |
| setThemeCfg | 更新主题配置 （含主题 schema, 色板，主题名） | (themeCfg: [ThemeCfg](/docs/api/general/S2Theme/#themecfg)) => void | |
Expand All @@ -69,7 +69,8 @@ s2.isPivotMode()
| getTotalsConfig | 获取总计小计配置 | (dimension: string) => [Total](/docs/api/general/S2Options#totals) | |
| getInitColumnLeafNodes | 获取初次渲染的列头叶子节点 （比如：隐藏列头前） | () => [Node[]](/docs/api/basic-class/node/) | |
| getCanvasElement | 获取表格对应的 `<canvas/>` HTML 元素 | () => [HTMLCanvasElement](https://developer.mozilla.org/zh-CN/docs/Web/API/HTMLCanvasElement) | |
| clearColumnLeafNodes | 清空存储在 store 中的初始叶子节点 | () => void | |
| clearColumnLeafNodes | 清空存储在 store 中的初始叶子节点 （已废弃，请使用 `clearInitColumnLeafNodes` ) | () => void | |
| clearInitColumnLeafNodes | 清空存储在 store 中的初始叶子节点 | () => void | `@antv/s2@^1.54.3` |
| updateSortMethodMap | 更新存储在 store 中的节点排序方式 map, replace 为是否覆盖上一次的值 | (nodeId: string, sortMethod: string, replace?: boolean) => void | |
| getMenuDefaultSelectedKeys | 获取 tooltip 中选中的菜单项 key 值 | `(nodeId: string) => string[]` | |
| measureText | 获取文本在画布中的测量信息 | (text: `string`, font: [TextTheme](/docs/api/general/S2Theme#texttheme)) => [TextMetrics](https://developer.mozilla.org/zh-CN/docs/Web/API/TextMetrics) \| `null` | |
Expand Down

0 comments on commit 01be44b

Please sign in to comment.