Watch 1 Star 0 Fork 1

flownclouds / echarts-for-reactMIT

forked from 小为 / echarts-for-react 
Join us
Explore and code with more than 2 million developers,Free private repositories !:)
Sign up
:chart_with_upwards_trend: baidu Echarts(v3.0) components for React wrapper. spread retract

http://git.hust.cc/echarts-for-react/

Clone or download
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README.md

echarts-for-react

A very simple echarts(v3.0) wrapper for react.

Build Status npm npm npm

install

npm install echarts-for-react

How to run the demo:

git clone git@github.com:hustcc/echarts-for-react.git

npm install

npm start

then open http://127.0.0.1:8080/ in your browser. or see http://git.hust.cc/echarts-for-react/

usage

Simple demo code. for more example can see: http://git.hust.cc/echarts-for-react/

import React from 'react';
import ReactEcharts from 'echarts-for-react';

<ReactEcharts
    option={this.getOtion()} 
    height={300} 
	theme={"theme_name"}
	onChartReady={this.onChartReadyCallback}
    onEvents={EventsDict} />

component props

  • option (required, object)

the echarts option config, can see http://echarts.baidu.com/option.html#title.

  • height (required, number)

the height of echarts. number, with px as it's unit.

  • theme (optional, string)

the theme of echarts. string, should registerTheme before use it (theme object format: https://github.com/ecomfe/echarts/blob/master/theme/dark.js). e.g.

// import echarts
import echarts from 'echarts'; 
...
// register theme object
echarts.registerTheme('my_theme', {
  backgroundColor: '#f4cccc'
});
...
// render the echarts use option `theme`
<ReactEcharts 
    option={this.getOtion()} 
    height={300} 
    theme='my_theme' /> 
  • onChartReady (optional, function)

when the chart is ready, will callback the function with the echarts object as it's paramter.

  • showLoading (optional, bool, default: false)

bool, when the chart is rendering, show the loading mask.

  • onEvents (optional, array(string=>function) )

binding the echarts event, will callback with the echarts event object, and the echart object as it's paramters. e.g:

let onEvents = {
    'click': this.onChartClick,
    'legendselectchanged': this.onChartLegendselectchanged
}
...
<ReactEcharts
    option={this.getOtion()} 
    height={300} 
    onEvents={onEvents} />

for more event key name, see: http://echarts.baidu.com/api.html#events

Component API & Echarts API

the Component only has one API named getEchartsInstance.

  • getEchartsInstance() : get the echarts instance object, then you can use any API of echarts.

for example:

// render the echarts component below with rel
<ReactEcharts ref='echarts_react'
    option={this.getOtion()} 
    height={300}  />

// then get the `ReactEcharts` use this.refs.echarts_react

let echarts_instance = this.refs.echarts_react.getEchartsInstance();
// then you can use any API of echarts.
let base64 = echarts_instance.getDataURL();

About API of echarts, can see http://echarts.baidu.com/api.html#echartsInstance.

you can use the API to do:

  1. binding / unbinding event.
  2. dynamic charts with dynamic data.
  3. get the echarts dom / dataURL / base64, save the chart to png.
  4. release the charts.

LICENSE

MIT

Comments ( 0 )

Sign in for post a comment

1
https://gitee.com/flownclouds/echarts-for-react.git
git@gitee.com:flownclouds/echarts-for-react.git
flownclouds
echarts-for-react
echarts-for-react
master

Help Search