Gradio API
用户可以将 Graphic Walker 的 UI 渲染到 Gradio 应用程序上。
get_html_on_gradio
import gradio as gr
import pandas as pd
from pygwalker.api.gradio import PYGWALKER_ROUTE, get_html_on_gradio
with gr.Blocks() as demo:
df = pd.read_csv("data.csv")
pyg_html = get_html_on_gradio(df, spec="./gw_config.json", spec_io_mode="rw")
gr.HTML(pyg_html)
app = demo.launch(app_kwargs={
"routes": [PYGWALKER_ROUTE]
})
参数
| 参数 | 类型 | 默认值 | 描述 |
|---|---|---|---|
| dataset | Union[DataFrame, Connector] | - | 要使用的数据框或连接器。参考 Walker 的数据集。 |
| gid | Union[int, str] | None | Graphic Walker 容器 div 的 ID，格式为 'gwalker-{gid}'。如果 gid 为 None，则会自动生成。 |
| field_specs | Optional[Dict[str, FieldSpec]] | None | 字段规范。如果未指定，则将从dataset自动推断。 |
| theme_key | Literal['vega', 'g2'] | 'g2' | Graphic Walker 的主题类型。 |
| appearance | Literal['media', 'light', 'dark'] | 'media' | 主题设置。'media' 将自动检测 OS 主题。 |
| spec | str | "" | 图表配置数据。可以是配置 ID、JSON 或远程文件 URL。 |
| spec_io_mode | Literal["r", "rw"] | "r" | spec 输入输出模式，默认为 "r"，"r" 为只读，"rw" 为读写。 |
| kernel_computation | bool | None | 如果为 True，则使用内核计算数据，可以支持更大数据集的高性能。默认为 None，自动确定是否使用内核计算。 |
| kanaries_api_key | str | "" | kanaries API 密钥。 |
| default_tab | Literal["data", "vis"] | "vis" | 默认要显示的选项卡。默认为 "vis"。 |
| **kwargs | Any | - | 其他关键字参数。 |