Skip to content

Commit 2fe08c6

Browse files
committed
docs: update changlog of rush
1 parent 57caa31 commit 2fe08c6

File tree

3 files changed

+45
-0
lines changed

3 files changed

+45
-0
lines changed
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"changes": [
3+
{
4+
"comment": "feat: add config `customFilter` to legend, support cutomized filter function, close #3492\n\n",
5+
"type": "none",
6+
"packageName": "@visactor/vchart"
7+
}
8+
],
9+
"packageName": "@visactor/vchart",
10+
"email": "[email protected]"
11+
}

docs/assets/option/en/component/legend-common/base-legend.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,23 @@ Whether to enable legend interaction, enabled by default.
3333

3434
Whether to perform data filtering, the default is true. When this property is turned off, the legend click event will not trigger data filtering.
3535

36+
#${prefix} customFilter(Function)
37+
38+
Supported since version `1.13.1`
39+
40+
Custom legend filter callback function, defined as follows:
41+
42+
```
43+
/**
44+
* Custom filter function
45+
* @param data Current data
46+
* @param selectedRange Selected data range
47+
* @param datumField Field corresponding to the filtered data
48+
* @returns The final displayed data
49+
*/
50+
(data: any, selectedRange: StringOrNumber[], datumField: string) => any;
51+
```
52+
3653
#${prefix} title(Object)
3754

3855
Legend title configuration, not displayed by default.

docs/assets/option/zh/component/legend-common/base-legend.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,23 @@
3333

3434
是否进行数据筛选,默认为 true。该属性关闭之后,图例的点击事件将不会触发数据筛选。
3535

36+
#${prefix} customFilter(Function)
37+
38+
`1.13.1`版本开始支持
39+
40+
自定义图例筛选的回调函数,类型定义如下:
41+
42+
```
43+
/**
44+
* 自定义筛选函数
45+
* @param data 当前数据
46+
* @param selectedRange 选中的数据范围
47+
* @param datumField 筛选数据对应的字段
48+
* @returns 最终展示的数据
49+
*/
50+
(data: any, selectedRange: StringOrNumber[], datumField: string) => any;
51+
```
52+
3653
#${prefix} title(Object)
3754

3855
图例标题配置,默认不显示。

0 commit comments

Comments
 (0)