pyecharts/docs/en-us/doc_api.md

pyecharts API

This document describes the public API for pyecharts library and it will be read by developers.

Charts Classes

Charts classes is the core component of this library.Each charts class represents the one kind of chart in Echarts .

This pictures the inherit tree for these charts classes.

Properties

This table list properties for these chart classes.

Properites/Charts	Base	Chart/FOO_CHART	Grid	Overlap	Timeline	Page
chart_id	✓	✓	✓	✓	✓
width	✓	✓	✓	✓	✓
heigth	✓	✓	✓	✓	✓
options	✓	✓	✓	✓	✓
js_dependencies	✓	✓	✓	✓	✓	✓

chart_id

Data type:str.The identifier string for a chart. E.g.'d2d9dcc4e28247518186c0882d356ba8' 。

width

Data type:number.The width(px) of div container for a chart.

height

Data type:number.The height(px) of div container for a chart.

options

Data type:dict.The config options for a chart。Each chart has its own format and value.Please see more detail at ECharts document。

js_dependencies

Data type:set.The js filename collections for a chart's dependencies.Every element do not contain the filename extension(.js).E.g {'echarts.min', 'fujian'} 。

Methods

add()

Add options and data to a chart.See the source code for more detail.

Chart Class	Function Sign
Base	add(**echarts_options)
Grid	add(grid_width=None, grid_height=None, grid_top=None, grid_bottom=None, grid_left=None, grid_right=None)
Overlap	add(chart, xaix_index=0, yaix_index=0, id_add_xaxis=False, is_add_yaxis=False)
Timeline	add(chart, time_point)
Page	add(achart_or_charts)

get_js_dependencies()

Gert the javascript dependencies of a chart.

render(path='render.html')

Render to a HTML page.

render_embed()

Render javascript code fragment including options.

show_config()

Print all options of charts

Data Hanlder Methods

These methods are tool methods for data handlers.

cast

pyecharts.base.Base.cast(seq)

Class method for formatting and converting data.It can convert your origin data to the corresponding data for pyecharts library.

Example:

o_data = [('A', '34'), ('B', '45'), ('C', '12')]
x, y = Base.cast(o_data)
print(x) # ['A', 'B', 'C']
print(y) # ['34', '45', '12']

json_dumps

pyecharts.base.json_dumps(data, indent=0)

Convert data to json string, and add encoding for some specified data type:

• Convert Datetime and Time objects to ISO8601 format string.
• Cast numpy arrays. See the document of astype and tolist .

Chart Rendering

JINJA2_ENV

pyecharts.templates.JINJA2_ENV

Data type jinja2.Environment。pyecharts provides a build-in environment object for rendering using Jinja2 engine。

• This environment use pyecharts/templates as its base directory to store HTML and javascript files.