Skip to content

Commit 3f990c8

Browse files
authored
docs: 更新manual/plots英文文档 (#1942)
1 parent 8e4ae98 commit 3f990c8

File tree

5 files changed

+76
-38
lines changed

5 files changed

+76
-38
lines changed

docs/manual/plots/area.en.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -13,63 +13,63 @@ order: 1
1313

1414
<description>**required** _array object_</description>
1515

16-
设置图表数据源。数据源为对象集合,例如:`[{ time: '1991',value: 20 }, { time: '1992',value: 20 }]`
16+
Configure the data source. The data source is a collection of objects. For example:`[{ time: '1991',value: 20 }, { time: '1992',value: 20 }]`
1717

1818
`markdown:docs/common/xy-field.en.md`
1919

2020
#### seriesField
2121

2222
<description>**optional** _string_</description>
2323

24-
分组字段。
24+
Grouping field. For example, when we need to analyze the transaction volume trend of different provinces, the `province` field is the grouping field.
2525

2626
`markdown:docs/common/meta.en.md`
2727

28-
### Geometry Style
28+
### Graphic Style
2929

3030
#### smooth
3131

3232
<description>**optional** _boolean_ _default:_ `false`</description>
3333

34-
是否平滑。
34+
Whether the curve is smooth.
3535

3636
#### isStack
3737

3838
<description>**optional** _boolean_ _default:_ `true`</description>
3939

40-
是否堆积面积图。
40+
Whether the plot is Stacked Area.
4141

4242
#### isPercent
4343

4444
<description>**optional** _boolean_ _default:_ `true`</description>
4545

46-
是否百分比面积图,百分比时默认开启 isStack
46+
Whether the plot is Percent Area. When the plot is Percent Area, isStack is `true` by default.
4747

4848
#### areaStyle
4949

5050
<description>**optional** _StyleAttr | Function_</description>
5151

52-
面积图形样式。
52+
Area graphic style.
5353

5454
`markdown:docs/common/shape-style.en.md`
5555

5656
#### line
5757

5858
<description>**optional** _lineStyle_</description>
5959

60-
面积中折线的样式。
60+
Line graphic style in the Area.
6161

62-
| 细分配置项名称 | 类型 | 功能描述 |
62+
| Attr | Type | Description |
6363
| -------------- | ---------------------------------------- | -------- |
64-
| color | _string \| string[] \| Function_ | 颜色映射 |
65-
| style | _ShapeStyle \| Function_ | 样式映射 |
66-
| size | _number \| [number, number] \| Function_ | 折线宽度 |
64+
| color | _string \| string[] \| Function_ | Line color |
65+
| style | _ShapeStyle \| Function_ | Line graphic style |
66+
| size | _number \| [number, number] \| Function_ | Line width |
6767

6868
#### point
6969

7070
<description>**optional** _pointStyle_</description>
7171

72-
面积图数据点图形样式。
72+
Point graphic style in the Area.
7373

7474
`markdown:docs/common/point-style.en.md`
7575

docs/manual/plots/bar.en.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -13,67 +13,67 @@ order: 3
1313

1414
<description>**required** _array object_</description>
1515

16-
设置图表数据源。数据源为对象集合,例如:`[{ time: '1991',value: 20 }, { time: '1992',value: 20 }]`
16+
Configure the data source. The data source is a collection of objects. For example:`[{ time: '1991',value: 20 }, { time: '1992',value: 20 }]`
1717

1818
`markdown:docs/common/xy-field.en.md`
1919

2020
#### seriesField
2121

2222
<description>**optional** _string_</description>
2323

24-
拆分字段,在分组条形图下同 groupField、colorField,在堆积条形图下同 stackField、colorField
24+
Grouping field. It is the same meaning as groupField、colorField in Grouped Bar, and the same as stackField、colorField in Stacked Bar.
2525

2626
#### groupField
2727

2828
<description>**optional** _string_</description>
2929

30-
拆分字段,用于堆叠分组条形图,拆分优先级高于 seriesFieldisGroup: true 时会根据 groupField 进行分组。
30+
Grouping field for Stacked Bar and Grouped Bar. Its priority is higher than seriesField. When isGroup is `true`, the data will be grouped by `groupField`.
3131

3232
#### isGroup
3333

3434
<description>**optional** _boolean_</description>
3535

36-
是否分组柱形图。
36+
Whether the plot is Grouped Bar.
3737

3838
#### isStack
3939

4040
<description>**optional** _boolean_</description>
4141

42-
是否堆积条形图。
42+
Whether the plot is Stacked Bar.
4343

4444
#### isRange
4545

4646
<description>**optional** _boolean_</description>
4747

48-
是否区间条形图。
48+
Whether the plot is Range Bar.
4949

5050
#### isPercent
5151

5252
<description>**optional** _boolean_</description>
5353

54-
是否百分百条形图,isPercent true 时,isStack 也需要为 true
54+
Whether the plot is Percent Bar. When isPercent is `true`, isStack must be `true`.
5555

5656
`markdown:docs/common/meta.en.md`
5757

58-
### Geometry Style
58+
### Graphic Style
5959

6060
#### barWidthRatio
6161

6262
<description>**optional** _number_</description>
6363

64-
条形图宽度占比 [0-1]
64+
The ratio of bar width( Range:[0-1] ).
6565

6666
#### marginRatio
6767

6868
<description>**optional** _number_</description>
6969

70-
分组中柱子之间的间距 [0-1],仅对分组条形图适用。
70+
The ratio of spacing between columns in groups( Range:[0-1] ), only for Grouped Bar.
7171

7272
#### barStyle
7373

7474
<description>**optional** _StyleAttr | Function_</description>
7575

76-
柱子样式配置。
76+
Bar graphic Style.
7777

7878
`markdown:docs/common/shape-style.en.md`
7979

docs/manual/plots/box.en.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -13,39 +13,39 @@ order: 21
1313

1414
<description>**required** _array object_</description>
1515

16-
设置图表数据源。数据源为对象集合,例如:`[{ time: '1991',value: 20 }, { time: '1992',value: 20 }]`
16+
Configure the data source. The data source is a collection of objects. For example:`[{ time: '1991',value: 20 }, { time: '1992',value: 20 }]`
1717

1818
`markdown:docs/common/xy-field.en.md`
1919

2020
#### groupField
2121

2222
<description>**optional** _string_</description>
2323

24-
分组拆分字段,默认是分组情况,颜色作为视觉通道。
24+
Grouping field. It is used for grouping by default, and color is used as visual channel.
2525

2626
#### outliersField
2727

2828
<description>**optional** _string_</description>
2929

30-
异常值字段。
30+
Outlier field.
3131

3232
`markdown:docs/common/meta.en.md`
3333

34-
### Geometry Style
34+
### Graphic Style
3535

3636
#### boxStyle
3737

3838
<description>**optional** _StyleAttr | Function_</description>
3939

40-
柱子样式配置。
40+
Box graphic style.
4141

4242
`markdown:docs/common/shape-style.en.md`
4343

4444
#### outliersStyle
4545

4646
<description>**optional** _StyleAttr | Function_</description>
4747

48-
柱子样式配置,配置同 boxStyle
48+
Outliers graphic style, the same configuration as boxStyle.
4949

5050
`markdown:docs/common/color.en.md`
5151

docs/manual/plots/funnel.en.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -13,39 +13,39 @@ order: 9
1313

1414
<description>**required** _array object_</description>
1515

16-
设置图表数据源。数据源为对象集合,例如:`[{ time: '1991',value: 20 }, { time: '1992',value: 20 }]`
16+
Configure the data source. The data source is a collection of objects. For example:`[{ time: '1991',value: 20 }, { time: '1992',value: 20 }]`
1717

1818
`markdown:docs/common/xy-field.en.md`
1919

2020
#### compareField
2121

2222
<description>**optional** _string_</description>
2323

24-
对比字段。
24+
Field for comparing.
2525

2626
#### isTransposed
2727

2828
<description>**optional** _boolean_ _default:_ `false`</description>
2929

30-
是否转置。
30+
Whether the plot is transposed.
3131

3232
`markdown:docs/common/meta.en.md`
3333

34-
### Geometry Style
34+
### Graphic Style
3535

3636
#### dynamicHeight
3737

3838
<description>**optional** _boolean_ _default:_ `false`</description>
3939

40-
是否是动态高度。
40+
Whether the height is dynamic.
4141

4242
#### conversionTag
4343

4444
<description>**optional** _false | object_</description>
4545

46-
配置转化率组件。
46+
Configure the conversion rate component.
4747

48-
默认配置:`{offsetX: 10, offsetY: 0, formatter: (datum) => '转化率' + datum.$$percentage$$ * 100 + '%',}`
48+
Defalut: `{offsetX: 10, offsetY: 0, formatter: (datum) => '转化率' + datum.$$percentage$$ * 100 + '%',}`
4949

5050
`markdown:docs/common/color.en.md`
5151

docs/manual/plots/liquid.en.md

+39-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,42 @@ title: Liquid
33
order: 12
44
---
55

6-
`markdown:docs/manual/plots/liquid.zh.md`
6+
### Plot Container
7+
8+
`markdown:docs/common/chart-options.en.md`
9+
10+
### Data Mapping
11+
12+
#### percent
13+
14+
<description>**required** _number_</description>
15+
16+
Ratio data( Range:[0-1] ).
17+
18+
#### radius
19+
20+
<description>**optional** _number_ _default:_ `0.9`</description>
21+
22+
Radius of outer ring( Range:[0-1] ).
23+
24+
### Graphic Style
25+
26+
#### liquidStyle
27+
28+
<description>**optional** _StyleAttr | Function_</description>
29+
30+
Liguid graphic style.
31+
32+
`markdown:docs/common/shape-style.en.md`
33+
34+
`markdown:docs/common/color.en.md`
35+
36+
### Plot Components
37+
38+
#### statistic
39+
40+
<description>**optional** _object_</description>
41+
42+
Text component.
43+
44+
`markdown:docs/common/statistic.en.md`

0 commit comments

Comments
 (0)