Echarts for Python

An unofficial Echarts options generator with Python.

• Free software: MIT license
• Documentation: http://echarts-python.readthedocs.io/en/stable/ (NOT Ready)
• Online demo: https://yufeiminds.github.io/echarts-python/ (NOT Ready)

This repo still on developing (ALPHA), DON’T USE IT IN PRODUCTION.

Installation

Installing echarts-python with pip

$ pip install echarts-python

Current version for Echarts 3.1.6

Basic Usage

from echarts import Echart, Legend, Bar, Axis

chart = Echart('GDP', 'This is a fake chart')
chart.use(Bar('China', [2, 3, 4, 5]))
chart.use(Legend(['GDP']))
chart.use(Axis('category', 'bottom', data=['Nov', 'Dec', 'Jan', 'Feb']))

The chart.json property will be

{
    "title": {
        "text": "GDP",
        "subtext": "This is a fake chart"
    },
    "series": [
        {
            "type": "bar",
            "data": [
                2,
                3,
                4,
                5
            ],
            "name": "China"
        }
    ],
    "legend": {
        "y": "top",
        "x": "center",
        "data": [
            "GDP"
        ],
        "orient": "horizontal"
    },
    "xAxis": [
        {
            "position": "bottom",
            "data": [
                "Nov",
                "Dec",
                "Jan",
                "Feb"
            ],
            "type": "category"
        }
    ],
    "yAxis": {}
}

on Mac OSX, you also can execute

chart.plot()

and invoke a browser to display the chart.

Contribution

This package authored by Hsiaoming Yang <me@lepture.com> in 2014.

If you have any question or want to improve this repository, welcome to create an issue or pull requests .

This repo is maintained by Yufei Li <yufeiminds@gmail.com> now, you can also send a email to me.

Indices and tables

• Index
• Module Index
• Search Page

API Guide

Here is the API reference for echarts-python .

echarts.option

Options for chart

class echarts.option.Axis(type, position, name='', data=None, **kwargs)

Axis data structure.

json

JSON format data.

class echarts.option.Legend(data, orient='horizontal', position=None, **kwargs)

Legend section for Echart.

json

JSON format data.

class echarts.option.Series(type, name=None, data=None, **kwargs)

Data series holding.

json

JSON format data.

class echarts.option.Toolbox(orient='horizontal', position=None, **kwargs)

A toolbox for visitor.

json

JSON format data.

class echarts.option.Tooltip(trigger='axis', **kwargs)

A tooltip when hovering.

json

JSON format data.

class echarts.option.VisualMap(type, min, max, **kwargs)

maps data to visual channels

json

JSON format data

echarts.datastructure

Datastructure for describing the chart types.

class echarts.datastructure.Bar(name=None, data=None, **kwargs)

Docs

class echarts.datastructure.Boxplot(name=None, data=None, **kwargs)

class echarts.datastructure.Candlestick(name=None, data=None, **kwargs)

class echarts.datastructure.Chord(name=None, data=None, **kwargs)

class echarts.datastructure.EffectScatter(name=None, data=None, **kwargs)

class echarts.datastructure.EventRiver(name=None, data=None, **kwargs)

class echarts.datastructure.Force(name=None, data=None, **kwargs)

class echarts.datastructure.Funnel(name=None, data=None, **kwargs)

class echarts.datastructure.Gauge(name=None, data=None, **kwargs)

class echarts.datastructure.Graph(name=None, data=None, **kwargs)

class echarts.datastructure.Heatmap(name=None, data=None, **kwargs)

class echarts.datastructure.K(name=None, data=None, **kwargs)

class echarts.datastructure.Line(name=None, data=None, **kwargs)

class echarts.datastructure.Lines(name=None, data=None, **kwargs)

class echarts.datastructure.Map(name=None, data=None, **kwargs)

class echarts.datastructure.Parallel(name=None, data=None, **kwargs)

class echarts.datastructure.Pie(name=None, data=None, **kwargs)

class echarts.datastructure.Radar(name=None, data=None, **kwargs)

class echarts.datastructure.Sankey(name=None, data=None, **kwargs)

class echarts.datastructure.Scatter(name=None, data=None, **kwargs)

class echarts.datastructure.Tree(name=None, data=None, **kwargs)

class echarts.datastructure.Treemap(name=None, data=None, **kwargs)

class echarts.datastructure.Venn(name=None, data=None, **kwargs)

class echarts.datastructure.WordCloud(name=None, data=None, **kwargs)