Skip to content

Commit 534784a

Browse files
docs: modify date overview (#6716)
1 parent 1d79b49 commit 534784a

File tree

3 files changed

+238
-115
lines changed

3 files changed

+238
-115
lines changed

site/docs/manual/core/data/fetch.zh.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,12 @@ chart.options({
5252

5353
## 配置项
5454

55-
| 属性 | 描述 | 类型 | 默认值 |
56-
| --------- | ------------------------------------------------- | ----------------- | ------ |
57-
| value | fetch 请求的网络地址 | `string` | `[]` |
58-
| format | 远程文件的数据格式类型,决定用什么方式解析 | `'json' \| 'csv'` | `json` |
59-
| delimiter | 如果是 csv 文件,解析的时候分割符 | `string` | `,` |
60-
| autoType | 如果是 csv 文件,解析的时候是否自动判断列数据类型 | `boolean` | `true` |
61-
| transform | 对加载后的数据进行变换操作 | `DataTransform` | `[]` |
55+
| 属性 | 描述 | 类型 | 默认值 |
56+
| --------- | ------------------------------------------------- | --------------------------------------------------------- | ------------------------------ |
57+
| value | fetch 请求的网络地址 | string | [] |
58+
| format | 远程文件的数据格式类型,决定用什么方式解析 | `'json' \| 'csv'` | 默认取 value 末尾 `.` 后的后缀 |
59+
| delimiter | 如果是 csv 文件,解析的时候分割符 | string | `,` |
60+
| autoType | 如果是 csv 文件,解析的时候是否自动判断列数据类型 | boolean | true |
61+
| transform | 对加载后的数据进行变换操作 | [DataTransform](/manual/core/data/overview#datatransform) | [] |
6262

6363
`fetch` 实现上,如果 format 为 `json`,则使用 JavaScript 的 `fetch` API 然后将返回值转成 JSON Object;如果 format 为 `csv`,则调用 `d3-dsv` 去解析接口返回值。

site/docs/manual/core/data/inline.zh.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -65,25 +65,30 @@ chart.data([
6565

6666
## 配置项
6767

68-
| 属性 | 描述 | 类型 | 默认值 |
69-
| --------- | ---------------------------- | --------------- | ------ |
70-
| value | 具体的 object 数组数据 | `object[]` | `[]` |
71-
| transform | 针对数据 inline 数据进行变换 | `DataTransform` | `[]` |
68+
| 属性 | 描述 | 类型 | 默认值 |
69+
| --------- | ---------------------------- | --------------------------------------------------------- | ------ |
70+
| value | 具体的 object 数组数据 | object[] | [] |
71+
| transform | 针对数据 inline 数据进行变换 | [DataTransform](/manual/core/data/overview#datatransform) | [] |
7272

7373
这个数据源比较简单,相当于传入的数据,直接作为数据源进行 transform 处理加工,然后走渲染逻辑。
7474

7575
⚠️ G2 支持了一些关系图的数据结构,这些数据结构是一个 JavaScript 的 Object 类型,所以使用简写传入的时候,可能会导致 G2 识别出错,所以建议如果图表的数据是 Object 对象,使用完整的写法传入数据。
7676

7777
```js
7878
const graphData = {
79-
nodes: [/** */],
80-
edges: [/** */],
79+
nodes: [
80+
/** */
81+
],
82+
edges: [
83+
/** */
84+
],
8185
};
8286

83-
chart.data(graphData); // ❌ 不建议这么写,G2 在处理的时候可能识别出错
87+
chart.data(graphData); // ❌ 不建议这么写,G2 在处理的时候可能识别出错
8488

85-
chart.data({ // ✅ 建议完整写法,语义更明确,不会因为歧义带来识别错误
89+
chart.data({
90+
// ✅ 建议完整写法,语义更明确,不会因为歧义带来识别错误
8691
type: 'inline',
87-
value: graphData
88-
})
92+
value: graphData,
93+
});
8994
```

0 commit comments

Comments
 (0)