图表 API
Base
类是所有图表的基类,包括组合图表,Base
类 API 如下
func pyecharts.Base.add_js_funcs
# 新增 js 代码,js 代码会被渲染进 HTML 中执行
def add_js_funcs(*fns):
func pyecharts.Base.add_js_events
# 新增 js 事件函数,js 代码会被渲染在 setOption 后执行
def add_js_events(*fns):
func pyecharts.Base.set_colors
# 设置全局 Label 颜色
def set_colors(colors: colors: Sequence[str])
func pyecharts.Base.get_options
# 获取全局 options
def get_options() -> dict:
func pyecharts.Base.dump_options
# 获取全局 options,JSON 格式(JsCode 生成的函数不带引号)
def dump_options() -> str:
# 获取全局 options,JSON 格式(JsCode 生成的函数带引号,在前后端分离传输数据时使用)
def dump_options_with_quotes() -> str:
func pyecharts.Base.render
# 渲染图表到 HTML 文件
def render(
# 生成图片路径
path: str = "render.html",
# 模板路径
template_name: str = "simple_chart.html",
# jinja2.Environment 类实例,可以配置各类环境参数
env: Optional[Environment] = None,
) -> str
func pyecharts.Base.render_embed
# 渲染图表到 HTML 字符串
def render_embed(
# 模板路径
template_name: str = "simple_chart.html",
# jinja2.Environment 类实例,可以配置各类环境参数
env: Optional[Environment] = None,
) -> str:
func pyecharts.Base.render_notebook
# 将图形渲染到 notebook
def render_notebook()
func pyecharts.Base.load_javascript
# 加载 js 资源,在 notebook 环境为 JupyterLab 时需要用到,仅在第一次渲染图前使用加载即可。
def load_javascript()
图表示例
运行示例
移步至 pyecharts-gallery 的仓库
$ git clone https://github.com/pyecharts/pyecharts-gallery.git
# 如果未安装 pyecharts 请执行该语句安装
# pip install pyecharts
# 文件夹中有各种图和组件的 example,有其相对应的代码和 html 文件;自行调试
全局变量
pyecharts 内置了多个全局变量,位于 pyecharts.globals 文件
# 渲染方式
RenderType = _RenderType()
# 允许的生成的文件类型
FileType = _FileType()
# Symbol 样式类型
SymbolType = _SymbolType()
# 图表类型
ChartType = _ChartType
# Tooltip 格式器类型
TooltipFormatterType = _ToolTipFormatterType()
# 主题类型
ThemeType = _ThemeType()
# Geo 图形类型
GeoType = _GeoType()
# BMap 图形全局参数
BMapType = _BMapType
# Notebook 环境类型
NotebookType = _NotebookType()
# 远程资源 Host
OnlineHostType = _OnlineHost()
# Warning 控制类 - 将在 1.9.0 版本发布后舍弃
WarningType = _WarningControl()
# 全局环境配置类
class _CurrentConfig:
# 全局网页标题
PAGE_TITLE = "Awesome-pyecharts"
# 全局 Host
ONLINE_HOST = OnlineHostType.DEFAULT_HOST
# 全局 Notebook 类型
NOTEBOOK_TYPE = NotebookType.JUPYTER_NOTEBOOK
# 全局 jinja2.Environment 实例
GLOBAL_ENV = Environment(
keep_trailing_newline=True,
trim_blocks=True,
lstrip_blocks=True,
loader=FileSystemLoader(
os.path.join(
os.path.abspath(os.path.dirname(__file__)), "render", "templates"
)
),
)
# 全局环境唯一实例
CurrentConfig = _CurrentConfig()