Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: meta 支持配置数值和正则, 便于批量配置 close #2647 #2799

Merged
merged 5 commits into from
Jul 5, 2024
Merged

feat: meta 支持配置数值和正则, 便于批量配置 close #2647 #2799

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d218ac6
feat: meta 支持配置数值和正则, 便于批量配置 close #2647
lijinke666 Jul 1, 2024
f5ba650
chore: 还原配置
lijinke666 Jul 1, 2024
29d1224
Merge branch 'next' into feat-2647
lijinke666 Jul 1, 2024
ac457a3
chore: 还原
lijinke666 Jul 1, 2024
0515a0a
Merge branch 'feat-2647' of github.com:antvis/S2 into feat-2647
lijinke666 Jul 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions packages/s2-core/__tests__/unit/data-set/pivot-data-set-spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -464,8 +464,18 @@ describe('Pivot Dataset Test', () => {
name: '成本',
description: '成本描述',
},
{
field: ['test-a', 'test-b'],
name: 'test',
},
{
field: /c+$/,
name: 'test-regexp',
},
],
fields: {
rows: ['test-a', 'test-b'],
columns: ['test-c'],
values: ['price', 'cost'],
valueInCols: false,
},
Expand All @@ -484,6 +494,9 @@ describe('Pivot Dataset Test', () => {
expect(dataSet.getFieldName('price')).toStrictEqual('价格');
expect(dataSet.getFieldName('cost')).toStrictEqual('成本');
expect(dataSet.getFieldName('')).toEqual('');
expect(dataSet.getFieldName('test-a')).toStrictEqual('test');
expect(dataSet.getFieldName('test-b')).toStrictEqual('test');
expect(dataSet.getFieldName('test-c')).toStrictEqual('test-regexp');
// 找不到名字返回字段本身
expect(dataSet.getFieldName('not-found-field')).toEqual(
'not-found-field',
Expand Down Expand Up @@ -594,6 +607,7 @@ describe('Pivot Dataset Test', () => {
expect(newData.fields.columns).toEqual(['type', 'sub_type']);
expect(newData.fields.values).toEqual(['number']);
});

test('should index of the cols of EXTRA_FIELD is 0 when customValueOrder is 0 and valueInCols is true', () => {
const mockDataCfg: S2DataConfig = assembleDataCfg(dataCfg, {
fields: {
Expand All @@ -607,6 +621,7 @@ describe('Pivot Dataset Test', () => {
expect(newData.fields.columns).toEqual([EXTRA_FIELD, 'type', 'sub_type']);
expect(newData.fields.values).toEqual(['number']);
});

test('should customValueOrder is too big, order feature does not work', () => {
const mockDataCfg: S2DataConfig = assembleDataCfg(dataCfg, {
fields: {
Expand All @@ -620,6 +635,7 @@ describe('Pivot Dataset Test', () => {
expect(newData.fields.columns).toEqual(['type', 'sub_type', EXTRA_FIELD]);
expect(newData.fields.values).toEqual(['number']);
});

test('should customValueOrder is not number, order feature does not work', () => {
const mockDataCfg: S2DataConfig = assembleDataCfg(dataCfg, {
fields: {
Expand Down
9 changes: 7 additions & 2 deletions packages/s2-core/src/common/interface/basic.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,13 @@ export enum CellClipBox {

export interface Meta {
/**
* 字段 id
* 字段名
* @example
1. 'city'
2. ['city', 'type']
3. /^city/
*/
field?: string;
field?: string | string[] | RegExp;

/**
* 字段名称
Expand All @@ -89,6 +93,7 @@ export interface Meta {
* 格式化
* 数值字段：一般用于格式化数字单位
* 文本字段：一般用于做字段枚举值的别名
* @see https://s2.antv.antgroup.com/manual/basic/formatter
*/
formatter?: Formatter;
}
Expand Down
9 changes: 9 additions & 0 deletions packages/s2-core/src/common/interface/s2DataConfig.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,22 +112,31 @@ export interface CustomTreeNode {
export interface S2DataConfig {
/**
* 原始明细数据
* @see https://assets.antv.antgroup.com/s2/basic.json
*/
data: RawData[];

/**
* 维度字段
*/
fields: Fields;

/**
* 字段元数据
* @see https://s2.antv.antgroup.com/manual/basic/formatter
*/
meta?: Meta[];

/**
* 排序配置
* @see https://s2.antv.antgroup.com/manual/basic/sort/basic
*/
sortParams?: SortParams;

/**
* 筛选配置
* @see https://s2.antv.antgroup.com/api/general/s2-data-config#filterparam
* @example https://s2.antv.antgroup.com/examples/case/data-preview/#index
*/
filterParams?: FilterParam[];
[key: string]: unknown;
Expand Down
13 changes: 12 additions & 1 deletion packages/s2-core/src/data-set/base-data-set.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import {
find,
get,
identity,
isArray,
isEmpty,
isNil,
isString,
Expand Down Expand Up @@ -105,7 +106,17 @@ export abstract class BaseDataSet {
(field: CustomHeaderField, meta?: Meta[]): Meta | undefined => {
const realField = this.getField(field);

return find(this.meta || meta, { field: realField });
return find(this.meta || meta, ({ field: currentField }) => {
if (currentField instanceof RegExp) {
return currentField.test(realField);
}

if (isArray(currentField)) {
return currentField.includes(realField);
}

return currentField === realField;
});
},
);

Expand Down
8 changes: 4 additions & 4 deletions s2-site/docs/api/general/S2DataConfig.zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,16 @@ const s2DataConfig = {
功能描述：表格数据源

```ts
type RawData = Record<string, DataItem>;
type DataItem = SimpleData | MultiData;
type RawData = Record<string, DataItem>
type DataItem = SimpleData | MultiData
```

#### SimpleData

功能描述：基础数据类型

```ts
type SimpleData = string | number;
type SimpleData = string | number
```

```ts
Expand Down Expand Up @@ -112,7 +112,7 @@ const data = [

| 参数 | 说明 | 类型 | 默认值 | 必选 |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------- | ------ | ---- |
| field | 字段 id | `string` | | |
| field | 字段 id （即 [Fields](#fields) 中配置的字段） | `string \| string[] \| RegExp` | | |
| name | 字段名称 | `string` | | |
| description | 字段描述，会显示在行头、列头、单元格对应的 tooltip 中 | `string` | | |
| formatter | 格式化 <br/> 单元格、行头和列头支持格式化，角头不支持格式化。只有单元格存在第二个参数。 <br/>数值字段：一般用于格式化数字单位<br/>文本字段：一般用于做字段枚举值的别名<br/> 第二个参数在以下情况会传入：data cell 格式化，复制/导出，tooltip 展示（**且仅在选择多个单元格时，data 类型为数组**） | `(value: unknown, data?: Data \| Data[], meta?: Node \| ViewMeta) => string` | | |
Expand Down
25 changes: 24 additions & 1 deletion s2-site/docs/manual/basic/formatter.zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,30 @@ tag: New
},
},
]
};
}
```

## 批量设置

如果多个字段格式化一致，可以配置为数组以便于批量设置，或使用正则匹配。

```ts
const s2DataConfig = {
meta: [
{
field: ['province', 'city'],
formatter: (value, record, meta) => {
return `${value}-test`
},
},
{
field: /type/,
formatter: (value, record, meta) => {
return `${value}-test`
},
}
]
}
```

## 复制导出时保留格式化信息
Expand Down
7 changes: 5 additions & 2 deletions s2-site/examples/basic/pivot/demo/grid.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ fetch(
const s2DataConfig = {
...dataCfg,
meta: [
// 支持批量设置或正则匹配
// field: ['province', 'city'],
// field: /type/,
{
field: 'province',
name: '省份',
Expand Down Expand Up @@ -49,8 +52,8 @@ fetch(
// seriesNumber: {
// enable: true,
// 自定义序号列文本, 默认 "序号"
// text: '自定义序号标题',
//},
// text: '自定义序号标题',
// },
frozen: {
// 默认冻结行头, 行头和数值区域都会展示滚动条
// rowHeader: false,
Expand Down
Loading