PyGWalker HTML API 指南

PyGWalker 允许你在任何支持 HTML 渲染的应用中展示 Graphic Walker 的 UI。本指南将解释如何有效地使用 HTML API。

重要提示

当前的 HTML API 仅设计用于前端计算。由于性能限制，它可能不适用于大型数据集。

使用 `to_html()`

to_html() 函数是从你的 DataFrame 生成 HTML 输出的主要方法。

基本用法

import pygwalker as pyg
import pandas as pd
 
df = pd.read_csv('data.csv')
html_str = pyg.to_html(df)

函数参数

参数	类型	默认值	描述
dataset	DataFrame	-	输入的 DataFrame。详情见Walker 数据集。
gid	Union[int, str]	None	GraphicWalker 容器 div 的 ID。格式：'gwalker-{gid}'。如果为 None，则自动生成。
field_specs	Optional[Dict[str, FieldSpec]]	None	字段规范。如果未指定，将自动从 `dataset` 中推断。
theme_key	Literal['vega', 'g2']	'g2'	GraphicWalker 的主题类型。
appearance	Literal['media', 'light', 'dark']	'media'	主题设置。'media' 会自动检测操作系统的主题。
spec	str	""	图表配置数据。可以是配置 ID、JSON 或远程文件 URL。
default_tab	Literal["data", "vis"]	"vis"	UI 加载时默认显示的选项卡。
**kwargs	Any	-	其他关键字参数。

示例

导出到 HTML 文件

你可以将生成的 HTML 保存到文件中，以供日后使用或共享：

import pandas as pd
import pygwalker as pyg
 
df = pd.read_csv('data.csv')
 
with open("pygwalker_demo.html", "w", encoding="utf-8") as f:
    f.write(pyg.to_html(df))

在 Shiny 中使用 PyGWalker

PyGWalker 可以集成到 Shiny 应用中。有关详细指南和示例，请参考我们的 Shiny 集成教程。

最佳实践

性能考虑: 在使用 HTML API 时要注意数据集的大小，因为它是在客户端处理数据。
自定义: 利用 field_specs 参数微调数据的解释和显示方式。
主题: 尝试不同的 theme_key 和 appearance 设置以匹配你应用的外观和感觉。
集成: 当与像 Shiny 这样的 Web 框架集成时，确保在应用结构中适当地处理 HTML 输出。

有关更高级的用法和集成示例，请参考 PyGWalker 文档。

在 Shiny 上

Shiny 示例

Gradio Component appearance