https://github.com/ant-move/echarts-aliapp
echarts-Aliapp components
https://github.com/ant-move/echarts-aliapp
alipay-mini-program echarts miniprogram weixin
Last synced: about 1 year ago
JSON representation
echarts-Aliapp components
- Host: GitHub
- URL: https://github.com/ant-move/echarts-aliapp
- Owner: ant-move
- Created: 2019-09-12T03:22:14.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-09-12T03:54:23.000Z (almost 7 years ago)
- Last Synced: 2025-03-26T06:51:10.749Z (over 1 year ago)
- Topics: alipay-mini-program, echarts, miniprogram, weixin
- Language: JavaScript
- Size: 508 KB
- Stars: 34
- Watchers: 2
- Forks: 7
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 在支付宝小程序中使用 ECharts
本项目是 ECharts 的支付宝小程序版本，以及使用的示例。
开发者可以通过熟悉的 ECharts 配置方式，快速开发图表，满足各种可视化需求。
## 体验示例小程序
在支付宝中扫描下面的二维码即可体验 ECharts Demo：
## 下载
为了兼容小程序 Canvas，我们提供了一个小程序的组件，用这种方式可以方便地使用 ECharts。
首先，下载本项目。
其中，`ec-canvas` 是我们提供的组件，其他文件是如何使用该组件的示例。
`ec-canvas` 目录下有一个 `echarts.js`，默认我们会在每次 `echarts-Aliapp` 项目发版的时候替换成最新版的 ECharts。如有必要，可以自行从 ECharts 项目中下载[最新发布版](https://github.com/ecomfe/echarts/releases)，或者从[官网自定义构建](http://echarts.baidu.com/builder.html)以减小文件大小。
## 引入组件
在开始之前，你需要先阅读 [支付宝小程序自定义组件](https://docs.alipay.com/mini/framework/custom-component-overview) 的相关文档。
在创建项目之后，可以将下载的 [echarts-Aliapp](https://github.com/ant-move/echarts-Aliapp) 项目完全替换新建的项目，然后将修改代码；或者仅拷贝 `ec-canvas` 目录到新建的项目下，然后做相应的调整。
`pages` 目录下的每个文件夹是一个页面，可以根据情况删除不需要的页面，并且在 `app.json` 中删除对应页面。
如果仅拷贝 `ec-canvas` 目录，则可以参考 `pages/bar` 目录下的几个文件的写法。下面，我们具体地说明。
## 创建图表
首先，在 `pages/bar` 目录下新建以下几个文件：`index.js`、 `index.json`、 `index.axml`、 `index.acss`。并且在 `app.json` 的 `pages` 中增加 `'pages/bar/index'`。
`index.json` 配置如下：
```json
{
"usingComponents": {
"ec-canvas": "../../ec-canvas/ec-canvas"
}
}
```
这一配置的作用是，允许我们在 `pages/bar/index.axml` 中使用 `` 组件。注意路径的相对位置要写对，如果目录结构和本例相同，就应该像上面这样配置。
`index.axml` 中，我们创建了一个 `` 组件，内容如下：
```xml
```
> 注意此处的 `.container`，新建小程序项目后，其中 `app.acss` 中默认自动生成的此 class 与本 demo 中的可能不一致，导致图表不能正常显示，只显示空白。请注意参考 `app.acss` 修改样式，保证图表的初始化的时候是有宽度和高度的。
其中 `ec` 是一个我们在 `index.js` 中定义的对象，它使得图表能够在页面加载后被初始化并设置。`index.js` 的结构如下：
```js
function initChart(canvas, width, height) {
const chart = echarts.init(canvas, null, {
width: width,
height: height
});
canvas.setChart(chart);
var option = {
...
};
chart.setOption(option);
return chart;
}
Page({
data: {
ec: {
onInit: initChart
}
}
});
```
这对于所有 ECharts 图表都是通用的，用户只需要修改上面 `option` 的内容，即可改变图表。`option` 的使用方法参见 [ECharts 配置项文档](http://echarts.baidu.com/option.html)。对于不熟悉 ECharts 的用户，可以参见 [5 分钟上手 ECharts](http://echarts.baidu.com/tutorial.html#5%20%E5%88%86%E9%92%9F%E4%B8%8A%E6%89%8B%20ECharts) 教程。
完整的例子请参见 [echarts-Aliapp](https://github.com/ant-move/echarts-Aliapp) 项目。
## FAQ
### 如何获取图表实例？
`echarts.init` 返回的即为图表实例，可以参考 [pages/bar/index.js](/blob/master/pages/bar/index.js) 的写法。
### 如何延迟加载图表？
参见 `pages/lazyLoad` 的例子，可以在获取数据后再初始化数据。
### 如何在一个页面中加载多个图表？
参见 `pages/multiCharts` 的例子。
### 如何使用 Tooltip？
目前，本项目已支持 ECharts Tooltip，但是由于 ECharts 相关功能尚未发版，因此需要使用当前本项目中 `ec-canvas/echarts.js`，这个文件包含了可以在支付宝小程序中使用 Tooltip 的相关代码。目前在 ECharts 官网下载的 `echarts.js` 还不能直接替换使用，等 ECharts 正式发版后即可。
具体使用方法和 ECharts 相同，例子参见 `pages/line/index.js`。
### 文件太大怎么办？
本项目默认提供的 ECharts 文件是最新版本的包含所有组件文件，为了便于开发，提供的是未压缩的版本。远程调试或预览可以下载 [echarts.min.js](https://github.com/apache/incubator-echarts/blob/master/dist/echarts.min.js) 压缩版本。
发布时，如果对文件大小要求更高，可以在 [ECharts 在线定制](http://echarts.baidu.com/builder.html)网页下载仅包含必要组件的包，并且选择压缩。
下载的文件放在 `ec-canvas/echarts.js`，**注意一定需要重命名为 `echarts.js`**。
## 暂不支持的功能
ECharts 中的绝大部分功能都支持小程序版本，因此这里仅说明不支持的功能，以及存在的问题。
以下功能尚不支持，如果有相关需求请在 [issue](https://github.com/ant-move/echarts-Aliapp/issues) 中向我们反馈，对于反馈人数多的需求将优先支持：
- 图片
- 多个 zlevel 分层
此外，目前还有一些 bug 尚未修复，部分需要小程序团队配合上线支持，但不影响基本的使用。已知的 bug 包括：
- 安卓平台：transform 的问题（会影响关系图边两端的标记位置、旭日图文字位置等）
- iOS 平台：半透明略有变深的问题
- iOS 平台：渐变色出现在定义区域之外的地方
如有其它问题，也欢迎在 [issue](https://github.com/ant-move/echarts-Aliapp/issues) 中向我们反馈，谢谢！
## 参考链接
* [GitHub - ecomfe/echarts-for-weixin: ECharts 的微信小程序版本](https://github.com/ecomfe/echarts-for-weixin)