index.md 5.67 KB
Newer Older
nikogu's avatar
nikogu committed
1
---
nikogu's avatar
nikogu committed
2 3
title: 
  en-US: Charts
nikogu's avatar
nikogu committed
4
  zh-CN: Charts
nikogu's avatar
nikogu committed
5
subtitle: 图表
nikogu's avatar
nikogu committed
6
order: 2
nikogu's avatar
nikogu committed
7
cols: 2
nikogu's avatar
nikogu committed
8 9 10 11
---

Ant Design Pro 提供的业务中常用的图表类型,都是基于 [G2](https://antv.alipay.com/g2/doc/index.html) 按照 Ant Design 图表规范封装,需要注意的是 Ant Design Pro 的图表组件以套件形式提供,可以任意组合实现复杂的业务需求。

afc163's avatar
afc163 committed
12
因为结合了 Ant Design 的标准设计,本着极简的设计思想以及开箱即用的理念,简化了大量 API 配置,所以如果需要灵活定制图表,可以参考 Ant Design Pro 图表实现,自行基于 [G2](https://antv.alipay.com/g2/doc/index.html) 封装图表组件使用。
nikogu's avatar
nikogu committed
13 14 15 16 17 18 19 20 21 22 23 24

## API

### ChartCard

| 参数      | 说明                                      | 类型         | 默认值 |
|----------|------------------------------------------|-------------|-------|
| title | 卡片标题 | ReactNode\|string | - |
| action | 卡片操作 | ReactNode | - |
| total | 数据总量 | ReactNode \| number | - |
| footer | 卡片底部 | ReactNode | - |
| contentHeight | 内容区域高度 | number | - |
25
| avatar | 右侧图标 | React.ReactNode | - |
nikogu's avatar
nikogu committed
26 27 28 29
### MiniBar

| 参数      | 说明                                      | 类型         | 默认值 |
|----------|------------------------------------------|-------------|-------|
afc163's avatar
afc163 committed
30
| color | 图表颜色 | string | `#1890FF` |
nikogu's avatar
nikogu committed
31 32 33 34 35 36 37
| height | 图表高度 | number | - |
| data | 数据 | array<{x, y}> | - |

### MiniArea

| 参数      | 说明                                      | 类型         | 默认值 |
|----------|------------------------------------------|-------------|-------|
nikogu's avatar
nikogu committed
38
| color | 图表颜色 | string | `rgba(24, 144, 255, 0.2)` |
afc163's avatar
afc163 committed
39
| borderColor | 图表边颜色 | string | `#1890FF` |
nikogu's avatar
nikogu committed
40 41 42
| height | 图表高度 | number | - |
| line | 是否显示描边 | boolean | false |
| animate | 是否显示动画 | boolean | true |
jim chen's avatar
jim chen committed
43 44
| xAxis | [x 轴配置](http://antvis.github.io/g2/doc/tutorial/start/axis.html) | object | - |
| yAxis | [y 轴配置](http://antvis.github.io/g2/doc/tutorial/start/axis.html) | object | - |
nikogu's avatar
nikogu committed
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
| data | 数据 | array<{x, y}> | - |

### MiniProgress

| 参数      | 说明                                      | 类型         | 默认值 |
|----------|------------------------------------------|-------------|-------|
| target | 目标比例 | number | - |
| color | 进度条颜色 | string | - |
| strokeWidth | 进度条高度 | number | - |
| percent | 进度比例 | number | - |

### Bar

| 参数      | 说明                                      | 类型         | 默认值 |
|----------|------------------------------------------|-------------|-------|
| title | 图表标题 | ReactNode\|string | - |
afc163's avatar
Fix pie  
afc163 committed
61
| color | 图表颜色 | string | `rgba(24, 144, 255, 0.85)` |
nikogu's avatar
nikogu committed
62 63 64
| margin | 图表内部间距 | array | \[32, 0, 32, 40\] |
| height | 图表高度 | number | - |
| data | 数据 | array<{x, y}> | - |
65
| autoLabel | 在宽度不足时,自动隐藏 x 轴的 label | boolean | `true` |
nikogu's avatar
nikogu committed
66 67 68 69 70 71

### Pie

| 参数      | 说明                                      | 类型         | 默认值 |
|----------|------------------------------------------|-------------|-------|
| animate | 是否显示动画 | boolean | true |
afc163's avatar
Fix pie  
afc163 committed
72
| color | 图表颜色 | string | `rgba(24, 144, 255, 0.85)` |
nikogu's avatar
nikogu committed
73 74
| height | 图表高度 | number | - |
| hasLegend | 是否显示 legend | boolean | `false` |
nikogu's avatar
nikogu committed
75
| margin | 图表内部间距 | array | \[24, 0, 24, 0\] |
nikogu's avatar
nikogu committed
76 77 78
| percent | 占比 | number | - |
| tooltip | 是否显示 tooltip | boolean | true |
| valueFormat | 显示值的格式化函数 | function | - |
jim's avatar
jim committed
79 80
| title | 图表标题 | ReactNode\|string | - |
| subTitle | 图表子标题 | ReactNode\|string | - |
81
| total | 图标中央的总数 | string | - |
nikogu's avatar
nikogu committed
82 83 84 85 86 87 88 89

### Radar

| 参数      | 说明                                      | 类型         | 默认值 |
|----------|------------------------------------------|-------------|-------|
| title | 图表标题 | ReactNode\|string | - |
| height | 图表高度 | number | - |
| hasLegend | 是否显示 legend | boolean | `false` |
nikogu's avatar
nikogu committed
90
| margin | 图表内部间距 | array | \[24, 30, 16, 30\] |
91
| data | 图标数据 | array<{name,label,value}> | - |
nikogu's avatar
nikogu committed
92 93 94 95 96 97 98

### Gauge

| 参数      | 说明                                      | 类型         | 默认值 |
|----------|------------------------------------------|-------------|-------|
| title | 图表标题 | ReactNode\|string | - |
| height | 图表高度 | number | - |
nikogu's avatar
nikogu committed
99
| color | 图表颜色 | string | `#2F9CFF` |
100
| bgColor | 图表背景颜色 | string | `#F0F2F5` |
nikogu's avatar
nikogu committed
101 102 103 104 105 106 107 108
| percent | 进度比例 | number | - |

### WaterWave

| 参数      | 说明                                      | 类型         | 默认值 |
|----------|------------------------------------------|-------------|-------|
| title | 图表标题 | ReactNode\|string | - |
| height | 图表高度 | number | - |
nikogu's avatar
nikogu committed
109
| color | 图表颜色 | string | `#1890FF` |
nikogu's avatar
nikogu committed
110 111
| percent | 进度比例 | number | - |

nikogu's avatar
nikogu committed
112 113 114 115
### TagCloud

| 参数      | 说明                                      | 类型         | 默认值 |
|----------|------------------------------------------|-------------|-------|
116
| data | 标题 | Array<name, value\> | - |
nikogu's avatar
nikogu committed
117 118 119 120 121 122 123 124 125 126
| height | 高度值 | number | - |

### TimelineChart

| 参数      | 说明                                      | 类型         | 默认值 |
|----------|------------------------------------------|-------------|-------|
| data | 标题 | Array<x, y1, y2\> | - |
| titleMap | 指标别名 | Object{y1: '客流量', y2: '支付笔数'} | - |
| height | 高度值 | number | 400 |

nikogu's avatar
nikogu committed
127 128 129 130 131 132
### Field

| 参数      | 说明                                      | 类型         | 默认值 |
|----------|------------------------------------------|-------------|-------|
| label | 标题 | ReactNode\|string | - |
| value | 值 | ReactNode\|string | - |