Skip to content
PYGWALKER
API リファレンス
Use in Jupyter

PyGWalker Jupyter APIガイド

このガイドでは、JupyterノートブックでPyGWalkerを使用する方法について、主な関数とそのパラメータを説明します。

主な関数

1. walk()

インタラクティブなGraphicWalkerインスタンスを作成します。

import pygwalker as pyg
 
walker = pyg.walk(dataset)

2. render()

特定のチャート設定をレンダリングします。

import pygwalker as pyg
 
walker = pyg.render(dataset, spec="./gw_config.json")

3. table()

データセットをインタラクティブなテーブルとして表示します。

import pygwalker as pyg
 
walker = pyg.table(dataset)

共通パラメータ

パラメータデフォルト説明
datasetUnion[DataFrame, Connector]-入力データ。詳細はDataset Of Walkerを参照してください。
gidUnion[int, str]NoneGraphicWalkerコンテナdiv ID。形式: 'gwalker-{gid}'。Noneの場合、オート生成されます。
field_specsOptional[Dict[str, FieldSpec]]Noneフィールド仕様。指定されていない場合は自動推論されます。
theme_keyLiteral['vega', 'g2']'g2'GraphicWalkerのテーマタイプ。
appearanceLiteral['media', 'light', 'dark']'media'テーマ設定。'media'はOSテーマを自動検出します。
specstr""チャート設定データ (ID, JSON, URL)。
kernel_computationboolNone大規模なデータセット用の高性能カーネル計算を有効にします。
kanaries_api_keystr""Kanaries APIキー。
default_tabLiteral["data", "vis"]"vis"初期タブ ( walk() のみ)。
cloud_computationboolFalseクラウド計算を有効にします (データをKanariesクラウドにアップロード)。

ベストプラクティスとヒント

  1. 大規模データセット: CSVファイルが1GBを超える場合、 kernel_computation=True を使用して高性能処理を有効にします。

  2. テーマ設定:

    • テーマは appearance='light'appearance='dark' で設定します。
    • PyGWalkerのテーマがJupyterと一致しない場合、appearanceを明示的に設定します。
  3. チャートの保存:

  4. パフォーマンス: 大規模データセットに対しては、 kernel_computation=True を使用して内部のDuckDBベースのエンジンを活用します。

  5. クラウド計算: cloud_computation=True を設定してKanariesクラウドを使用してデータを処理します(APIキーが必要です)。

より高度な使用例と統合例については、 PyGWalkerドキュメント (opens in a new tab) を参照してください。

関連Q&A

私のpygwalkerが1GB以上のCSVを処理できません。どうすれば良いですか?

PyGWalkerには、大規模なデータセットを高性能で処理するためのDuckDBベースの内部エンジンが搭載されています。 kernel_computation=True パラメータを有効にしてください。

pygwalkerのテーマ(ライトまたはダーク)を設定する方法は?

テーマは appearance パラメータで設定できます。利用可能な値は dark | light | media です。デフォルトは media で、システムテーマに自動的に切り替わります。

私のpygwalkerはダークですが、Jupyterはライトです。なぜですか?

pygwalkerはデフォルトでシステムテーマに従います。しかし、いくつかのJupyterはシステムテーマに従わないことがあります。 appearance='light' を設定してpygwalkerをライトテーマに変更できます。

pygwalkerのチャートをJupyterで保存する方法は?

pygwalkerのチャートと状態を保存する方法は2つあります。ファイルに保存するか、コードとしてエクスポートします。詳細はこちら (opens in a new tab)