|
| 1 | +# react-native-echarts |
| 2 | + |
| 3 | +在 react-native 项目中使用 echarts 展示图表 |
| 4 | + |
| 5 | +- IOS 效果图 |
| 6 | + |
| 7 | + |
| 8 | + |
| 9 | +- Android 效果图 |
| 10 | + |
| 11 | + |
| 12 | + |
| 13 | +## 特点 |
| 14 | + |
| 15 | +**基于最新的 echarts 版本** |
| 16 | + |
| 17 | +**支持开启 hermes** |
| 18 | + |
| 19 | +## 使用 |
| 20 | + |
| 21 | +```code |
| 22 | +yarn add react-native-webview @td-design/react-native-echarts |
| 23 | +``` |
| 24 | + |
| 25 | +## 示例 |
| 26 | + |
| 27 | +### 1. 获取数据后显示图表 |
| 28 | + |
| 29 | +```jsx |
| 30 | +import React, { FC, useEffect, useRef } from 'react'; |
| 31 | +import { View } from 'react-native'; |
| 32 | +import Echarts, { EchartsHandler } from '@td-design/react-native-echarts'; |
| 33 | + |
| 34 | +export default () => { |
| 35 | + const chart = useRef<EchartsHandler>(null); |
| 36 | + |
| 37 | + // setOption after data fetch |
| 38 | + useEffect(() => { |
| 39 | + fetch(xxx).then(data => { |
| 40 | + chart.current?.setOption({ |
| 41 | + tooltip: { |
| 42 | + trigger: 'axis', |
| 43 | + formatter: `function (params) { |
| 44 | + if (Array.isArray(params)) { |
| 45 | + return params[0].name; |
| 46 | + } |
| 47 | + return params.name; |
| 48 | + }`, |
| 49 | + }, |
| 50 | + xAxis: { |
| 51 | + type: 'category', |
| 52 | + // data: ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun'], |
| 53 | + data: data.xAxis, |
| 54 | + }, |
| 55 | + yAxis: { |
| 56 | + type: 'value', |
| 57 | + }, |
| 58 | + series: [ |
| 59 | + { |
| 60 | + // data: [150, 230, 224, 218, 135, 147, 260], |
| 61 | + data: data.seriesData, |
| 62 | + type: 'line', |
| 63 | + }, |
| 64 | + ], |
| 65 | + }); |
| 66 | + }) |
| 67 | + }, []); |
| 68 | + |
| 69 | + return ( |
| 70 | + <View style={{ flex: 1 }}> |
| 71 | + <Echarts ref={chart}> |
| 72 | + </View> |
| 73 | + ); |
| 74 | +} |
| 75 | +``` |
| 76 | +
|
| 77 | +### 2. 修改图表 |
| 78 | +
|
| 79 | +```jsx |
| 80 | +import React, { FC, useEffect, useRef } from 'react'; |
| 81 | +import { View, Button } from 'react-native'; |
| 82 | +import Echarts, { EchartsHandler } from '@td-design/react-native-echarts'; |
| 83 | + |
| 84 | +export default () => { |
| 85 | + const chart = useRef<EchartsHandler>(null); |
| 86 | + |
| 87 | + // setOption after data fetch |
| 88 | + useEffect(() => { |
| 89 | + fetch(xxx).then(data => { |
| 90 | + chart.current?.setOption({ |
| 91 | + tooltip: { |
| 92 | + trigger: 'axis', |
| 93 | + formatter: `function (params) { |
| 94 | + if (Array.isArray(params)) { |
| 95 | + return params[0].name; |
| 96 | + } |
| 97 | + return params.name; |
| 98 | + }`, |
| 99 | + }, |
| 100 | + xAxis: { |
| 101 | + type: 'category', |
| 102 | + // data: ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun'], |
| 103 | + data: data.xAxis, |
| 104 | + }, |
| 105 | + yAxis: { |
| 106 | + type: 'value', |
| 107 | + }, |
| 108 | + series: [ |
| 109 | + { |
| 110 | + // data: [150, 230, 224, 218, 135, 147, 260], |
| 111 | + data: data.seriesData, |
| 112 | + type: 'line', |
| 113 | + }, |
| 114 | + ], |
| 115 | + }); |
| 116 | + }) |
| 117 | + }, []); |
| 118 | + |
| 119 | + // modify chart option |
| 120 | + const modifyOptions = () => { |
| 121 | + chart.current?.setOption({ |
| 122 | + tooltip: { |
| 123 | + trigger: 'axis', |
| 124 | + formatter: `function (params) { |
| 125 | + if (Array.isArray(params)) { |
| 126 | + return params[0].name + ": " + params[0].data; |
| 127 | + } |
| 128 | + return params.name + ": " + params.data; |
| 129 | + }`, |
| 130 | + }, |
| 131 | + xAxis: { |
| 132 | + type: 'category', |
| 133 | + data: ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun'], |
| 134 | + }, |
| 135 | + yAxis: { |
| 136 | + type: 'value', |
| 137 | + }, |
| 138 | + series: [ |
| 139 | + { |
| 140 | + data: [82, 93, 90, 93, 129, 46, 66], |
| 141 | + type: 'line', |
| 142 | + }, |
| 143 | + ], |
| 144 | + }); |
| 145 | + }; |
| 146 | + |
| 147 | + return ( |
| 148 | + <View style={{ flex: 1 }}> |
| 149 | + <Echarts ref={chart}> |
| 150 | + <Button title="modify chart" onPress={modifyOptions} /> |
| 151 | + </View> |
| 152 | + ); |
| 153 | +} |
| 154 | +``` |
| 155 | +
|
| 156 | +### 3. 清除图表 |
| 157 | +
|
| 158 | +```jsx |
| 159 | +import React, { FC, useEffect, useRef } from 'react'; |
| 160 | +import { View, Button } from 'react-native'; |
| 161 | +import Echarts, { EchartsHandler } from '@td-design/react-native-echarts'; |
| 162 | + |
| 163 | +export default () => { |
| 164 | + const chart = useRef<EchartsHandler>(null); |
| 165 | + |
| 166 | + // setOption after data fetch |
| 167 | + useEffect(() => { |
| 168 | + fetch(xxx).then(data => { |
| 169 | + chart.current?.setOption({ |
| 170 | + tooltip: { |
| 171 | + trigger: 'axis', |
| 172 | + formatter: `function (params) { |
| 173 | + if (Array.isArray(params)) { |
| 174 | + return params[0].name; |
| 175 | + } |
| 176 | + return params.name; |
| 177 | + }`, |
| 178 | + }, |
| 179 | + xAxis: { |
| 180 | + type: 'category', |
| 181 | + // data: ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun'], |
| 182 | + data: data.xAxis, |
| 183 | + }, |
| 184 | + yAxis: { |
| 185 | + type: 'value', |
| 186 | + }, |
| 187 | + series: [ |
| 188 | + { |
| 189 | + // data: [150, 230, 224, 218, 135, 147, 260], |
| 190 | + data: data.seriesData, |
| 191 | + type: 'line', |
| 192 | + }, |
| 193 | + ], |
| 194 | + }); |
| 195 | + }) |
| 196 | + }, []); |
| 197 | + |
| 198 | + // clear chart |
| 199 | + const clearChart = () => { |
| 200 | + chart.current?.clear(); |
| 201 | + }; |
| 202 | + |
| 203 | + return ( |
| 204 | + <View style={{ flex: 1 }}> |
| 205 | + <Echarts ref={chart}> |
| 206 | + <Button title="clear chart" onPress={clearChart} /> |
| 207 | + </View> |
| 208 | + ); |
| 209 | +} |
| 210 | +``` |
| 211 | +
|
| 212 | +## 属性 |
| 213 | +
|
| 214 | +| 属性 | 必填 | 说明 | 类型 | 默认值 | |
| 215 | +| --------------- | ------- | -------------- | -------- | -------- | |
| 216 | +| width | `false` | 图表宽度 | `number` | 屏幕宽度 | |
| 217 | +| height | `false` | 图表高度 | `number` | `300` | |
| 218 | +| backgroundColor | `false` | 图表背景色 | `string` | `#fff` | |
| 219 | +| extraCode | `false` | 额外注入的代码 | `string` | `` | |
| 220 | +
|
| 221 | +## 方法 |
| 222 | +
|
| 223 | +| 方法 | 说明 | |
| 224 | +| -------------------- | -------------- | |
| 225 | +| `setBackgroundColor` | 修改背景色 | |
| 226 | +| `getOption` | 获取图表配置项 | |
| 227 | +| `setOption` | 修改图表配置项 | |
| 228 | +| `clear` | 清除图表 | |
| 229 | +
|
| 230 | +## Q&A |
| 231 | +
|
| 232 | +- Q: 安卓上无法显示图表 |
| 233 | +- A: 安卓上需要把`node_modules/@td-design/react-native-echarts/lib/commonjs/tmp/tpl.html` 文件复制到`android/app/src/main/assets/`目录下。 |
0 commit comments