ECharts API文档

1. 全局echarts对象

echarts.init(创建一个echarts实例,返回echartsInstance,不能在单个容器上初始化多个echarts实例);

echarts.connect(多个图表实例实现联动);

echarts.disconnect(解除图表实例的联动,如果只需要移出单个实例,可以将通过将该图表实例group设为空);

echarts.dispose(销毁实例,实例销毁后无法再被使用);

echarts.getInstanceByDom(获取dom容器上的实例);

echarts.registerMap(注册可用的地图,必须在包括geo组件或者map图表类型的时候才能使用);

echarts.getMap(获取已注册的地图,返回一个对象);

echarts.registerTheme(注册主题,用于初始化实例的时候指定);

echarts.graphic(图形相关帮助方法);

echarts.graphic.clipPointsByRect(输入一组点,和一个矩形,返回被矩形截取过的点);

echarts.graphic.clipRectByRect(输入两个矩形,返回第二个矩形截取第一个矩形的结果);

2. echartsInstance(通过echarts.init创建的实例)

echartsInstance(通过echarts.init创建的实例)

echartsInstance.group(图表的分组,用于联动);

echartsInstance.setOption(设置图表实例的配置项以及数据,万能接口,所有参数和数据的修改都可以通过setOption完成,ECharts会合并新的参数和数据,然后刷新图表。如果开启动画的话,ECharts找到两组数据之间的差异然后通过合适的动画去表现数据的变化);

echartsInstance.getWidth(获取ECharts实例容器的宽度 );

echartsInstance.getHeight(获取ECharts实例容器的高度);

echartsInstance.getDom(获取ECharts实例容器的dom节点);

echartsInstance.getOption(获取当前实例中维护的option对象,返回的option对象中包含了用户多次setOption合并得到的配置项和数据,也记录了用户交互的状态,例如图例的开关,数据区域的缩放选择的范围等等。所以从这份option可以恢复或者得到一个新的一模一样的实例);

echartsInstance.resize(改变图表的尺寸,在容器大小发生改变时需要手动调用);

echartsInstance.dispatchAction(触发图表行为,例如图表开关legendToggleSelect,数据区域缩放dataZoom,显示提示框showTip等等);

echartsInstance.on(绑定事件处理函数);

echartsInstance.off(解绑事件处理函数);

echartsInstance.convertToPixel(转换坐标系上的点到像素坐标值);

echartsInstance.convertFromPixel(转换像素坐标值到逻辑坐标系上的点,是convertToPixel的逆运算);

echartsInstance.showLoading(显示加载动画效果,可以在加载数据前手动调用改接口显示加载动画,在数据加载完成后调用hideLoading隐藏加载动画);

echartsInstance.hideLoading(隐藏动画加载效果);

echartsInstance.getDataURL(导出图表图片,返回一个base64的URL,可以设置为image的src);

echartsInstance.getConnectedDataURL(导出联动的图表图片,返回一个base64的URL,可以设置为image的src。导出图片中每个图表的相对位置跟容器的相对位置有关);

echartsInstance.clear(清空当前实例,会移除实例中所有的组件和图表。清空后调用getOption方法返回一个空对象{});

echartsInstance.isDisposed(当前实例是否已经被释放);

echartsInstance.dispose(销毁实例,销毁后实例无法再被使用);

3. action (ECharts中支持的图标行为,通过dispatchAction触发)

highlight(高亮指定的数据图形,通过seriesName或者seriesIndex指定系列,如果要再指定某个数据可以在指定dataIndex或者name);

downplay(取消高亮指定的数据图形,通过seriesName或者seriesIndex指定系列,如果要再指定某个数据可以在指定dataIndex或者name);

legend(图例组件相关的行为,必须引入图例组件后才能使用);

legendSelect(选中图例);

legendUnSelect(取消选中图例);

legendToggleSelect(切换图例的选中状态);

tooltip(提示框组件相关的行为,必须引入提示框组件后才能使用);

showTip(显示提示框);

hideTip(隐藏提示框);

dataZoom(数据区域缩放组件相关的行为,必须引入数据区域缩放组件后才能使用);

selectDataRange(选取映射的数据范围);

timeline(时间轴组件相关的行为,必须引入时间轴组件后才能使用);

timelineChange(设置当前的时间点);

timelinePlayChange(切换时间轴的播放状态);

toolbox(工具栏组件相关的行为,必须引入工具栏组件后才能使用);

restore(重置option);

pie(饼图相关的行为,必须引入饼图后才能使用);

pieSelect(选中指定的饼图扇形);

pieUnSelect(取消选中指定的饼图扇形);

pieToggleSelect(切换指定的饼图扇形选中状态);

geo(地图组件相关的行为,必须引入地图组件后才能使用);

geoSelect(选中指定的地图区域);

geoUnSelect(取消选中指定的地图区域);

geoToggleSelect(切换指定的地图区域选中状态);

map(地图图表相关的行为,必须引入地图图表后才能使用);

mapSelect(选中指定的地图区域);

mapUnSelect(取消选中指定的地图区域);

mapToggleSelect(切换指定的地图区域选中状态);

graph(关系图相关的行为,必须引入关系图后才能使用);

focusNodeAdjacency(将指定的节点以及其所有邻接节点高亮);

unfocusNodeAdjacency(将指定的节点以及其所有邻接节点高亮);

brush(触发此action可向echarts中添加一个或多个选框);

4. events(在ECharts中主要通过on方法添加事件处理函数);

鼠标事件(鼠标事件的事件参数是事件对象的数据的各个属性);

click(点击事件);

mousedown(鼠标按下);

mouseup(鼠标放下);

mouseover(鼠标悬停);

mouseout(鼠标移出);

legendselectchanged(切换图例选中状态后的事件);

legendselected(图例选中后的事件);

legendunselected(图例取消选中后的事件);

datazoom(数据区域缩放后的事件);

datarangeselected(视觉映射组件中,range值改变后触发的事件);

timelinechanged(时间轴中的时间点改变后的事件);

timelineplaychanged(时间轴中播放状态的切换事件);

restore(重置option事件);

dataviewchanged(工具栏中数据视图的修改事件);

magictypechanged(工具栏中动态类型切换的切换事件);

geoselectchanged(geo中地图区域切换选中状态的事件);

geoselected(geo中地图区域选中后的事件);

geounselected(geo中地图区域取消选中后的事件);

pieselectchanged(serie-pie饼图扇形切换选中状态的事件);

pieselected(series-pie饼图扇形选中后的事件);

pieunselected(series-pie饼图扇形取消选中后的事件);

mapselectchanged(series-map地图中区域切换选中状态的事件);

mapselected(series-map中地图区域选中后的事件);

mapunselected(series-map中地图区域取消选中后的事件);

axisareaselected(平行坐标轴范围选取事件);

focusNodeAdjacency(graph的邻接节点高亮事件);

unfocusNodeAdjacency(graph的邻接节点取消高亮事件);

brush(选框添加事件。即发出brush action得到的事件);

brushselected(对外通知当前选中了什么);

 

posted @ 2018-11-22 16:41  格鲁特baby  阅读(888)  评论(0编辑  收藏  举报