pyecharts document - Web Integration

Before You Read

  1. This web integration requires pyecharts V0.3.0+.
  2. This article is principle-described instead of a tutorial.So you should learn a lot about the relevant web framework.

Now, it is more easy to integrate pyecharts with your web framework ,whatever you start a project or integrate a exist one.The integration will not break down origin features because of the flexibility and OOP in Python language.

pyecharts exposes the API of builtin jinja2 template engine.In theory, it is easy to integrate the web framework which use jinja2 template engine.

In different use case,different specific methods and procedures will be used. This arctile will use the common framework,Django and Flask to describe the procedures ,which other framework can be inspired from.


Custom Template Engine

pyecharts use jinja2 as its template engine.According to Flask document.It is easy to integrate pyechart and Flask.This is a example.

You can follow these steps to create custom template engine.

from flask import Flask, render_template
from flask.templating import Environment

from pyecharts import HeatMap
from pyecharts.engine import ECHAERTS_TEMPLATE_FUNCTIONS
from pyecharts.conf import PyEchartsConfig

class FlaskEchartsEnvironment(Environment):
    def __init__(self, *args, **kwargs):
        super(FlaskEchartsEnvironment, self).__init__(*args, **kwargs)
        self.pyecharts_config = PyEchartsConfig(jshost='')

class MyFlask(Flask):
    jinja_environment = FlaskEchartsEnvironment

app = MyFlask(__name__)

Template Function

You can use echarts_* template function in the template file.

<!DOCTYPE html>
<html lang="zh-CN">
    <meta charset="UTF-8">
    {{ echarts_js_dependencies(hm) }}
    <p>在 Flask 下使用 echarts_* 系列模板函数(Template Functions)渲染页面。</p>
    {{ echarts_container(hm) }}
    {{ echarts_js_content(hm) }}

In the demo, boo CDN js is used, so the output <script> will use external link to reference the js files.\

<script type="text/javascript" src=""></script>

Example Project

The github repositoriy Flask_demo is a more complete example, which use local echarts library javascript files.You can continue development based on this project.


Custom Template Engine

From v1.8, you can directly use jinja2 as template engine in Django.

In the integration,you should define a callable function which returns a jinja2.Environment object.This is a example following Django Document :

from import staticfiles_storage
from django.urls import reverse

from pyecharts.conf import PyEchartsConfig
from pyecharts.engine import BaseEnvironment

def environment(**options):
    env = BaseEnvironment(pyecharts_config=PyEchartsConfig(jshost='/static/'), **options)
    # Add template functions to the environment object
        'static': staticfiles_storage.url,
        'url': reverse,
    return env

See more detail at Django document.


You can has two way to create your own engine class.