Skip to content
PYGWALKER
API リファレンス
Gradio

PyGWalker Gradio API

Gradio アプリ用の PyGWalker iframe HTML を生成するには get_html_on_gradio を使います。PyGWalker の通信ルートを利用できるように、アプリ起動時に PYGWALKER_ROUTE をマウントします。

import gradio as gr
import pandas as pd
from pygwalker.api.gradio import PYGWALKER_ROUTE, get_html_on_gradio
 
df = pd.read_csv("data.csv")
 
with gr.Blocks() as demo:
    pyg_html = get_html_on_gradio(
        df,
        spec_path="./gw_config.json",
        spec_io_mode="rw",
        computation="kernel",
    )
    gr.HTML(pyg_html)
 
demo.launch(app_kwargs={"routes": [PYGWALKER_ROUTE]})

get_html_on_gradio

Signature:

get_html_on_gradio(
    dataset,
    gid=None,
    *,
    field_specs=None,
    theme_key="g2",
    appearance="media",
    spec="",
    spec_path=None,
    spec_io_mode="r",
    computation=None,
    kernel_computation=None,
    kanaries_api_key="",
    default_tab="vis",
    **kwargs,
) -> str

dataset には pandas DataFrame、polars DataFrame、pyarrow Table、またはデータベース Connector を渡せます。

主要オプション

オプションデフォルトメモ
spec_pathNoneローカルチャート状態ファイル。ローカルファイルにはこれを推奨します。
spec_io_mode"r"Gradio UI がチャート編集を保存する必要がある場合は "rw" を使います。
computationNone明示的に選ぶには "browser"、"kernel"、"cloud" を使います。
kernel_computationNoneレガシー互換フラグです。computation を優先してください。PyGWalker 0.7.0 で削除予定です。
default_tab"vis"explorer の初期タブです。

計算に関するメモ

Gradio はライブアプリとして動くため、kernel と cloud computation をサポートします。

get_html_on_gradio(df, computation="browser")
get_html_on_gradio(df, computation="kernel")
get_html_on_gradio(df, computation="cloud", kanaries_api_key="...")

非 auto の computation 値と有効化されたレガシー計算フラグを混在させないでください。これらのオプションが競合すると PyGWalker は ValueError を送出します。

よくある落とし穴

落とし穴修正方法
iframe はレンダリングされるが操作が失敗するapp_kwargs={"routes": [PYGWALKER_ROUTE]} で起動します。
ローカルチャート編集が保存されないspec_path と spec_io_mode="rw" を使います。
新しいコードで kernel_computation=True を使うcomputation="kernel" を使います。
Gradio アプリではなく静的 HTML エクスポートが必要HTML エクスポート を computation="browser" で使います。

関連ガイド

StreamlitHTML エクスポート