Skip to content
PYGWALKER
API リファレンス
ノートブック API

PyGWalker ノートブック API

ノートブックでは、まず pygwalker.walk(df) を使うか、再利用可能な pygwalker.Walker を作成します。現在のデフォルト Jupyter レンダリング経路は anywidget なので、新しいコードでは env を省略するか env="JupyterAnywidget" を使ってください。

import pygwalker as pyg
 
walker = pyg.walk(df, spec_path="./gw_config.json", computation="kernel")

クイック判断表

やりたいこと使う API理由
DataFrame を一度だけ探索するpyg.walk(df)最小の notebook 呼び出しです。
同じ設定を再利用するpyg.Walker(df, ...).show()1 つのオブジェクトを notebook、Streamlit、webserver、HTML でレンダリングできます。
保存済みチャートだけをレンダリングするpyg.render(df, spec_path=...)explorer 全体ではなく renderer ビューを開きます。
テーブル / プロファイリングビューを表示するpyg.table(df)data / table モードで開始します。
チャート状態をローカルファイルに保存するspec_path="./gw_config.json"ローカルチャート状態専用の引数です。

pygwalker.walk

walk は Graphic Walker explorer 全体を開きます。

import pygwalker as pyg
 
walker = pyg.walk(
    df,
    spec_path="./gw_config.json",
    computation="browser",
)

Signature:

pyg.walk(
    dataset,
    gid=None,
    *,
    env="JupyterAnywidget",
    field_specs=None,
    theme_key="g2",
    appearance="media",
    spec="",
    spec_path=None,
    computation=None,
    use_kernel_calc=None,
    kernel_computation=None,
    cloud_computation=False,
    show_cloud_tool=True,
    kanaries_api_key="",
    default_tab="vis",
    **kwargs,
)

dataset には pandas DataFrame、polars DataFrame、pyarrow Table、データベース Connector、Connector 形式文字列、または再利用可能な pygwalker.Walker を渡せます。

Anywidget が notebook のデフォルト

新しい notebook コードでは anywidget 経路を使ってください。

pyg.walk(df)
pyg.walk(df, env="JupyterAnywidget")
pyg.Walker(df).show()
pyg.Walker(df).show(env="jupyter-anywidget")

レガシーな Jupyter transport alias は現在も anywidget に解決され、非推奨警告を出します。

レガシー値現在の挙動ステータス
env="Jupyter"JupyterAnywidget として扱われます非推奨。PyGWalker 0.7.0 で削除予定です。
env="JupyterWidget"JupyterAnywidget として扱われます非推奨。PyGWalker 0.7.0 で削除予定です。
Walker.show("jupyter-inline")jupyter-anywidget として扱われます非推奨。PyGWalker 0.7.0 で削除予定です。
Walker.show("jupyter-widget")jupyter-anywidget として扱われます非推奨。PyGWalker 0.7.0 で削除予定です。

Walker.show(env="auto") は現在の環境を検出します。ノートブックでは jupyter-anywidget に解決され、ノートブック外では webserver アダプターを起動します。

pygwalker.Walker を再利用する

チャート状態と計算モードを一度だけ定義したい場合は Walker を使います。

import pygwalker as pyg
 
walker = pyg.Walker(
    df,
    spec_path="./gw_config.json",
    spec_io_mode="rw",
    computation="kernel",
)
 
walker.show()

Constructor:

pyg.Walker(
    dataset,
    gid=None,
    *,
    field_specs=None,
    theme_key="g2",
    appearance="media",
    spec="",
    spec_path=None,
    spec_io_mode="rw",
    computation=None,
    use_kernel_calc=None,
    kernel_computation=None,
    cloud_computation=False,
    show_cloud_tool=True,
    kanaries_api_key="",
    default_tab="vis",
    **kwargs,
)

便利なメソッド:

メソッド戻り値用途
walker.corePygWalker古い API が使う互換オブジェクトへアクセスします。
walker.show(env="auto", ...)Walkernotebook または webserver モードで表示します。
walker.to_html()str静的 iframe HTML をエクスポートします。ブラウザー計算のみです。
walker.to_html_without_iframe()striframe wrapper なしで静的 HTML をエクスポートします。ブラウザー計算のみです。
walker.to_streamlit(**kwargs)StreamlitRendererStreamlit でコンストラクターオプションを再利用します。

Walker を別のアダプターに渡す場合、構築オプションをもう一度渡さないでください。これは拒否されます。

walker = pyg.Walker(df, spec_path="./gw_config.json", computation="browser")
 
# Raises ValueError: spec_path belongs on the original Walker.
pyg.walk(walker, spec_path="./other.json")

ノートブックでの計算

新しいコードでは computation を使います。

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

kernel_computation、cloud_computation、use_kernel_calc はレガシーフラグで、PyGWalker 0.7.0 で削除予定です。computation を "browser"、"kernel"、"cloud" に設定した場合、有効化されたレガシーフラグを同時に設定しないでください。

Notebook convert / 静的 HTML 出力はライブ kernel や cloud computation をサポートしません。出力を静的にする必要がある場合は computation="browser" を使うか、PyGWalker をライブバックエンドで実行します。

pygwalker.render

render は、ドラッグアンドドロップ explorer 全体ではなく保存済みチャートを表示します。

import pygwalker as pyg
 
pyg.render(df, spec_path="./gw_config.json", computation="browser")

Signature:

pyg.render(
    dataset,
    spec="",
    *,
    theme_key="g2",
    appearance="media",
    spec_path=None,
    computation=None,
    kernel_computation=None,
    kanaries_api_key="",
    **kwargs,
)

pygwalker.table

table は PyGWalker のデータテーブル / プロファイリングモードを開きます。

import pygwalker as pyg
 
pyg.table(df, spec_path="./gw_config.json")

Signature:

pyg.table(
    dataset,
    *,
    theme_key="g2",
    appearance="media",
    spec_path=None,
    computation=None,
    kernel_computation=None,
    kanaries_api_key="",
    **kwargs,
)

関連ガイド

データセット入力計算モード