Skip to content

Commit f5c94f1

Browse files
tangying1027xuying.xu
andauthored
chore: 调整example内容至md文档 (#2069)
Co-authored-by: xuying.xu <xuying.xu@alibaba-inc.com>
1 parent 025b41d commit f5c94f1

File tree

30 files changed

+1228
-56
lines changed

30 files changed

+1228
-56
lines changed

site/examples/area/area/index.zh.md

Lines changed: 49 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,52 @@ title: 基础面积图
33
order: 0
44
---
55

6-
- [基础面积图](./demo/area.jsx)
7-
- [带负值面积图](./demo/with-negative.jsx)
8-
- [带负值面积图(x 基线不为 0)](./demo/with-negative-not-start-on-zero.jsx)
9-
- [渐变填充面积图](./demo/gradient.jsx)
6+
面积图是一种统计图表,通过填充线条与坐标轴之间的区域来表示数据的数量。它结合了折线图和柱状图的特点,既能展示数据的变化趋势,又能强调数据的累积量和总体规模。
7+
8+
## 代码演示
9+
10+
### 基础示例
11+
12+
- [基础面积图](./demo/area.jsx):展示简单的面积图,通过填充区域表示数据量。
13+
14+
```jsx
15+
import { jsx, Canvas, Chart, Area, Line, Axis, Tooltip } from '@antv/f2';
16+
17+
const { props } = (
18+
<Canvas context={context}>
19+
<Chart
20+
data={data}
21+
scale={{
22+
tem: {
23+
min: 0,
24+
tickCount: 5,
25+
},
26+
time: {
27+
range: [0, 1],
28+
},
29+
}}
30+
>
31+
<Axis field="time" />
32+
<Axis field="tem" />
33+
<Area x="time" y="tem" />
34+
<Line x="time" y="tem" />
35+
<Tooltip />
36+
</Chart>
37+
</Canvas>
38+
);
39+
```
40+
41+
### 进阶用法
42+
43+
- [带负值面积图](./demo/with-negative.jsx):处理包含负值数据的面积图。
44+
- [带负值面积图(x 基线不为 0)](./demo/with-negative-not-start-on-zero.jsx):自定义基线位置的负值面积图。
45+
- [渐变填充面积图](./demo/gradient.jsx):使用渐变色填充的面积图效果。
46+
47+
## 使用场景
48+
49+
面积图适用于以下场景:
50+
51+
1. 展示数据随时间的变化趋势和累积量
52+
2. 强调数据的总体规模和量级
53+
3. 对比不同时期的数据差异
54+
4. 展示连续数据的分布情况

site/examples/area/stacked/index.zh.md

Lines changed: 80 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,83 @@ title: 层叠面积图
33
order: 1
44
---
55

6-
- [百分比分组柱图](./demo/percent.jsx)
7-
- [区域图(存在空值)](./demo/area-none.jsx)
8-
- [层叠面积图](./demo/stacked.jsx)
6+
层叠面积图是一种特殊的面积图,它可以展示多个数据系列随时间或其他连续变量变化的累积效果。通过堆叠的方式,可以直观地表现出各个类别的数据在整体中的占比及其变化趋势。
7+
8+
## 代码演示
9+
10+
### 基础示例
11+
12+
- [层叠面积图](./demo/stacked.jsx):展示多个数据系列的累积变化趋势。
13+
14+
```jsx
15+
import { jsx, Canvas, Chart, Area, Line, Axis, Legend } from '@antv/f2';
16+
17+
const { props } = (
18+
<Canvas context={context}>
19+
<Chart
20+
data={data}
21+
scale={{
22+
date: {
23+
range: [0, 1],
24+
},
25+
value: {
26+
min: 0,
27+
nice: true,
28+
},
29+
}}
30+
>
31+
<Axis field="date" />
32+
<Axis field="value" />
33+
<Area x="date" y="value" color="city" adjust="stack" />
34+
<Line x="date" y="value" color="city" adjust="stack" />
35+
<Legend style={{ justifyContent: 'space-around' }} />
36+
</Chart>
37+
</Canvas>
38+
);
39+
```
40+
41+
### 进阶用法
42+
43+
- [百分比层叠面积图](./demo/percent.jsx):以百分比的形式展示各个类别在总体中的占比变化。
44+
45+
```jsx
46+
import { jsx, Canvas, Chart, Area, Line, Axis, Legend } from '@antv/f2';
47+
48+
function formatterPercent(value) {
49+
value = value || 0;
50+
return parseInt(value * 100) + '%';
51+
}
52+
53+
const { props } = (
54+
<Canvas context={context}>
55+
<Chart
56+
data={data}
57+
scale={{
58+
year: {
59+
range: [0, 1],
60+
},
61+
percent: {
62+
formatter: formatterPercent,
63+
alias: 'percent(%)',
64+
},
65+
}}
66+
>
67+
<Axis field="percent" />
68+
<Axis field="year" />
69+
<Area x="year" y="percent" color="country" adjust="stack" />
70+
<Line x="year" y="percent" color="country" adjust="stack" />
71+
<Legend style={{ justifyContent: 'space-around' }} />
72+
</Chart>
73+
</Canvas>
74+
);
75+
```
76+
77+
- [区域图(存在空值)](./demo/area-none.jsx):演示如何处理数据中存在空值的情况。
78+
79+
## 使用场景
80+
81+
层叠面积图适用于以下场景:
82+
83+
1. 展示多个相关数据系列随时间的变化趋势
84+
2. 分析各个类别对总体的贡献度
85+
3. 比较不同类别数据的占比变化

site/examples/bar/bar/index.zh.md

Lines changed: 45 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,49 @@
11
---
2-
title: 基础条状图
2+
title: 基础柱状图
33
order: 0
44
---
55

6-
- [基础条状图](./demo/bar.jsx)
7-
- [区间条状图](./demo/range.jsx)
6+
柱状图是一种常用的统计图表,通过水平或垂直的柱子长度来表示数据的大小。它可以直观地展示分类数据之间的比较关系,适合展示不同类别之间的数值比较。
7+
8+
## 代码演示
9+
10+
### 基础示例
11+
12+
- [基础柱状图](./demo/bar.jsx):展示简单的柱状图,通过垂直柱子展示数据大小。
13+
14+
```jsx
15+
import { jsx, Canvas, Chart, Interval, Axis } from '@antv/f2';
16+
17+
const { props } = (
18+
<Canvas context={context}>
19+
<Chart
20+
data={data}
21+
coord={{
22+
transposed: true,
23+
}}
24+
scale={{
25+
sales: {
26+
tickCount: 5,
27+
},
28+
}}
29+
>
30+
<Axis field="year" />
31+
<Axis field="sales" />
32+
<Interval x="year" y="sales" />
33+
</Chart>
34+
</Canvas>
35+
);
36+
```
37+
38+
### 进阶用法
39+
40+
- [区间柱状图](./demo/range.jsx):展示具有上下区间范围的数据。
41+
42+
## 使用场景
43+
44+
柱状图适用于以下场景:
45+
46+
1. 展示分类数据之间的数值比较
47+
2. 显示时间序列数据的变化趋势
48+
3. 对比不同类别的数据大小
49+
4. 展示数据的排名和分布
Lines changed: 48 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,52 @@
11
---
2-
title: 分组条状图
2+
title: 分组柱状图
33
order: 1
44
---
55

6-
- [分组柱状图](./demo/dodge.jsx)
7-
- [带负值](./demo/negetive.jsx)
6+
分组柱状图是柱状图的一种变形,用于展示多个数据系列在不同类别下的对比关系。通过将相关的柱子分组排列,可以直观地比较同一类别下不同数据系列的数值差异。
7+
8+
## 代码演示
9+
10+
### 基础示例
11+
12+
- [分组柱状图](./demo/dodge.jsx):展示多个数据系列的分组对比。
13+
14+
```jsx
15+
import { jsx, Canvas, Chart, Interval, Axis } from '@antv/f2';
16+
17+
const { props } = (
18+
<Canvas context={context}>
19+
<Chart
20+
data={data}
21+
coord={{
22+
transposed: true,
23+
}}
24+
>
25+
<Axis field="月份" />
26+
<Axis field="月均降雨量" />
27+
<Interval
28+
x="月份"
29+
y="月均降雨量"
30+
color="name"
31+
adjust={{
32+
type: 'dodge',
33+
marginRatio: 0.05,
34+
}}
35+
/>
36+
</Chart>
37+
</Canvas>
38+
);
39+
```
40+
41+
### 进阶用法
42+
43+
- [带负值分组柱状图](./demo/negetive.jsx):处理包含负值数据的分组柱状图。
44+
45+
## 使用场景
46+
47+
分组柱状图适用于以下场景:
48+
49+
1. 对比多个数据系列在不同类别下的表现
50+
2. 展示同一维度下不同组别的数据差异
51+
3. 分析多个变量之间的关系
52+
4. 时间序列数据的多维度对比
Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,39 @@
11
---
2-
title: 层叠柱状图
2+
title: 堆叠柱状图
33
order: 2
44
---
55

6-
- [层叠条状图](./demo/stack.jsx)
7-
- [百分比层叠柱状图](./demo/percent.jsx)
6+
堆叠柱状图是柱状图的一种变形,通过将多个数据系列堆叠在一起形成单个柱子,可以展示各个部分对整体的贡献以及整体的总量。这种图表特别适合展示构成关系和累积效果。
7+
8+
## 代码演示
9+
10+
### 基础示例
11+
12+
- [堆叠柱状图](./demo/stack.jsx):展示多个数据系列的堆叠累积效果。
13+
14+
```jsx
15+
import { jsx, Canvas, Chart, Interval, Axis } from '@antv/f2';
16+
17+
const { props } = (
18+
<Canvas context={context}>
19+
<Chart data={data}>
20+
<Axis field="State" />
21+
<Axis field="人口数量" />
22+
<Interval x="State" y="人口数量" color="年龄段" adjust="stack" />
23+
</Chart>
24+
</Canvas>
25+
);
26+
```
27+
28+
### 进阶用法
29+
30+
- [百分比堆叠柱状图](./demo/percent.jsx):以百分比形式展示各部分在整体中的占比。
31+
32+
## 使用场景
33+
34+
堆叠柱状图适用于以下场景:
35+
36+
1. 展示各个部分对整体的贡献度
37+
2. 分析数据的构成关系
38+
3. 比较不同类别的总量和构成
39+
4. 展示累积效果和变化趋势

site/examples/basic/index.zh.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,33 @@ icon: column
55
redirect_from:
66
- /zh/examples
77
---
8+
9+
基础演示展示了如何使用 F2 创建一个简单的图表。通过这个示例,您可以了解 F2 的基本用法和组件结构。
10+
11+
## 代码演示
12+
13+
### 基础示例
14+
15+
- [基础演示](./demo/base.jsx):展示如何创建一个基本的图表。
16+
17+
```jsx
18+
import { jsx, Canvas, Chart, Interval, Axis } from '@antv/f2';
19+
20+
const { props } = (
21+
<Canvas context={context}>
22+
<Chart data={data}>
23+
<Axis field="genre" />
24+
<Axis field="sold" />
25+
<Interval x="genre" y="sold" />
26+
</Chart>
27+
</Canvas>
28+
);
29+
```
30+
31+
## 使用场景
32+
33+
基础演示适用于以下场景:
34+
35+
1. 快速上手 F2 图表库
36+
2. 了解 F2 的基本组件和配置
37+
3. 作为开发更复杂图表的起点
Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,36 @@
11
---
2-
title: K 线图
2+
title: 蜡烛图
33
order: 0
4-
icon: candlestick
54
---
5+
6+
蜡烛图(K 线图)是一种专门用于展示金融数据的图表类型,通过蜡烛形状的图形来同时显示开盘价、收盘价、最高价和最低价四个关键数据。它广泛应用于股票、期货等金融数据的技术分析。
7+
8+
## 代码演示
9+
10+
### 基础示例
11+
12+
- [基础蜡烛图](./demo/base.jsx):展示标准的蜡烛图,包含开盘、收盘、最高、最低价格信息。
13+
14+
```jsx
15+
import { jsx, Axis, Candlestick, Canvas, Chart, Tooltip } from '@antv/f2';
16+
17+
const { props } = (
18+
<Canvas context={context}>
19+
<Chart data={data}>
20+
<Axis field="time" type="timeCat" />
21+
<Axis field="value" formatter={(v) => Number(v).toFixed(0)} />
22+
<Candlestick x="time" y="value" />
23+
<Tooltip showCrosshairs={true} yPositionType="coord" crosshairsType="xy" showXTip showYTip />
24+
</Chart>
25+
</Canvas>
26+
);
27+
```
28+
29+
## 使用场景
30+
31+
蜡烛图适用于以下场景:
32+
33+
1. 股票价格走势分析
34+
2. 期货和外汇市场数据展示
35+
3. 金融技术分析和趋势预测
36+
4. 任何需要同时展示四个相关数值的场景

0 commit comments

Comments
 (0)