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。Dataset Of Walkerを参照してください。 |
gid | Union[int, str] | None | GraphicWalkerコンテナdivのID。形式は'gwalker-{gid}'。指定されない場合、自動生成されます。 |
field_specs | Optional[Dict[str, FieldSpec]] | None | フィールド仕様。指定しない場合は、dataset から自動的に推測されます。 |
theme_key | Literal['vega', 'g2'] | 'g2' | GraphicWalkerのテーマタイプ。 |
appearance | Literal['media', 'light', 'dark'] | 'media' | テーマ設定。'media'はOSのテーマを自動検出します。 |
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はShinyアプリケーションと統合することができます。詳細なガイドと例については、Shiny統合チュートリアルを参照してください。
ベストプラクティス
- パフォーマンスの考慮: HTML APIを使用する際には、データセットのサイズに注意してください。データはクライアントサイドで処理されます。
- カスタマイズ:
field_specs
パラメータを活用して、データの解釈と表示方法を微調整しましょう。 - テーマ設定: アプリケーションの外観に合わせて、
theme_key
やappearance
の設定を試してみてください。 - 統合: ShinyなどのWebフレームワークと統合する際には、HTML出力をアプリケーションの構造内で適切に扱うようにしてください。
詳細な使用方法や統合の例については、PyGWalkerのドキュメントを参照してください。