Skip to content
PYGWALKER
API-Referenz
HTML-Exporte

PyGWalker HTML-Export-API

Verwenden Sie pygwalker.to_html(...), wenn Sie einen statischen HTML-String benötigen. Statische Exporte sind Browser-only: Sie unterstützen keine Live-Kernel- oder Cloud-Berechnung.

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

Grenze statischer HTML-Exporte

Statisches HTML hat keinen Live-Python-Kernel und keinen Cloud-Callback. PyGWalker lehnt Folgendes ab:

pyg.to_html(df, computation="kernel")
pyg.to_html(df, computation="cloud")
pyg.to_html(df, kernel_computation=True)
pyg.to_html(df, cloud_computation=True)
pyg.to_html(df, use_kernel_calc=True)

Verwenden Sie computation="browser" oder lassen Sie die Berechnungsoption weg. Verwenden Sie Notebook-APIs, Streamlit, Gradio oder den Webserver-Modus, wenn Sie Live-Kernel- oder Cloud-Berechnung benötigen.

pygwalker.to_html

to_html gibt einen einbettbaren iframe-HTML-String zurück.

import pathlib
import pygwalker as pyg
 
html = pyg.to_html(df, spec_path="./gw_config.json", computation="browser")
pathlib.Path("pygwalker.html").write_text(html, encoding="utf-8")

Signatur:

pyg.to_html(
    df,
    gid=None,
    *,
    spec="",
    spec_path=None,
    field_specs=None,
    theme_key="g2",
    appearance="media",
    default_tab="vis",
    computation=None,
    **kwargs,
) -> str

df kann ein pandas DataFrame, polars DataFrame, pyarrow Table oder wiederverwendbarer pygwalker.Walker sein.

Export aus einem wiederverwendbaren Walker

Erstellen Sie einen Walker, wenn derselbe Diagrammzustand auch in Notebooks oder Apps gerendert werden soll.

import pygwalker as pyg
 
walker = pyg.Walker(
    df,
    spec_path="./gw_config.json",
    computation="browser",
)
 
html = pyg.to_html(walker, width="100%", height="720px")

Wenn to_html einen Walker erhält, übergeben Sie Renderabmessungen als Keyword-Argumente width und height. Konstruktionsoptionen wie spec_path, field_specs, appearance und computation müssen auf dem ursprünglichen Walker gesetzt sein.

walker.to_html(iframe_width=None, iframe_height=None) und walker.to_html_without_iframe() bieten dasselbe statische Exportverhalten und lehnen Live-Kernel-/Cloud-Berechnung ebenfalls ab.

Tabellen- und Renderer-Helfer

Verwenden Sie diese Helfer, wenn Sie nicht den vollständigen Explorer benötigen.

from pygwalker.api.html import to_table_html, to_render_html
 
table_html = to_table_html(df, spec_path="./gw_config.json", computation="browser")
render_html = to_render_html(df, spec_path="./gw_config.json", computation="browser")

Signaturen:

to_table_html(
    df,
    *,
    spec_path=None,
    theme_key="g2",
    appearance="media",
    computation=None,
    **kwargs,
) -> str
 
to_render_html(
    df,
    spec="",
    *,
    spec_path=None,
    theme_key="g2",
    appearance="media",
    computation=None,
    **kwargs,
) -> str

Chart-Preview-Helfer

to_chart_html rendert ein einzelnes Diagramm aus einer Graphic-Walker- oder Vega-Spec.

from pygwalker.api.html import to_chart_html
 
chart_html = to_chart_html(
    df,
    spec=chart_spec,
    spec_type="graphic-walker",
)

Signatur:

to_chart_html(
    dataset,
    spec,
    *,
    spec_type="graphic-walker",
    theme_key="g2",
    appearance="media",
) -> str

dataset kann ein DataFrame, pyarrow Table, Datenbank-Connector oder connectorartiger String sein.

Häufige Stolperfallen

StolperfalleLösung
Große lokale Daten mit Kernel-Berechnung exportierenEin Live-Backend statt statischem HTML verwenden.
Einen Walker plus spec_path an to_html übergebenspec_path auf pyg.Walker(...) setzen.
Neue statische Beispiele mit kernel_computation=True beginnencomputation="browser" verwenden.
Erwarten, dass Benutzer in einem statischen Export Diagrammzustand bearbeiten und speichernEin Live-Notebook-/App-Backend mit spec_io_mode="rw" verwenden.

Verwandte Anleitungen